java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.qconnect.model.QConnectRequest
    - - software.amazon.awssdk.services.qconnect.model.CreateAiGuardrailRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateAiGuardrailRequest.Builder,CreateAiGuardrailRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateAiGuardrailRequest
extends QConnectRequest
implements ToCopyableBuilder<CreateAiGuardrailRequest.Builder,CreateAiGuardrailRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateAiGuardrailRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`assistantId()`	The identifier of the Amazon Q in Connect assistant.
`String`	`blockedInputMessaging()`	The message to return when the AI Guardrail blocks a prompt.
`String`	`blockedOutputsMessaging()`	The message to return when the AI Guardrail blocks a model response.
`static CreateAiGuardrailRequest.Builder`	`builder()`
`String`	`clientToken()`	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`AIGuardrailContentPolicyConfig`	`contentPolicyConfig()`	The content filter policies to configure for the AI Guardrail.
`AIGuardrailContextualGroundingPolicyConfig`	`contextualGroundingPolicyConfig()`	The contextual grounding policy configuration used to create an AI Guardrail.
`String`	`description()`	A description of the AI Guardrail.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`String`	`name()`	The name of the AI Guardrail.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`AIGuardrailSensitiveInformationPolicyConfig`	`sensitiveInformationPolicyConfig()`	The sensitive information policy to configure for the AI Guardrail.
`static Class<? extends CreateAiGuardrailRequest.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()`	The tags used to organize, track, or control access for this resource.
`CreateAiGuardrailRequest.Builder`	`toBuilder()`
`AIGuardrailTopicPolicyConfig`	`topicPolicyConfig()`	The topic policies to configure for the AI Guardrail.
`String`	`toString()`	Returns a string representation of this object.
`VisibilityStatus`	`visibilityStatus()`	The visibility status of the AI Guardrail.
`String`	`visibilityStatusAsString()`	The visibility status of the AI Guardrail.
`AIGuardrailWordPolicyConfig`	`wordPolicyConfig()`	The word policy you configure for the AI Guardrail.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - assistantId
```
public final String assistantId()
```
    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
    
    Returns:
    
    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
  - blockedInputMessaging
```
public final String blockedInputMessaging()
```
    The message to return when the AI Guardrail blocks a prompt.
    
    Returns:
    
    The message to return when the AI Guardrail blocks a prompt.
  - blockedOutputsMessaging
```
public final String blockedOutputsMessaging()
```
    The message to return when the AI Guardrail blocks a model response.
    
    Returns:
    
    The message to return when the AI Guardrail blocks a model response.
  - clientToken
```
public final String clientToken()
```
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
    
    Returns:
    
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
  - contentPolicyConfig
```
public final AIGuardrailContentPolicyConfig contentPolicyConfig()
```
    The content filter policies to configure for the AI Guardrail.
    
    Returns:
    
    The content filter policies to configure for the AI Guardrail.
  - contextualGroundingPolicyConfig
```
public final AIGuardrailContextualGroundingPolicyConfig contextualGroundingPolicyConfig()
```
    The contextual grounding policy configuration used to create an AI Guardrail.
    
    Returns:
    
    The contextual grounding policy configuration used to create an AI Guardrail.
  - description
```
public final String description()
```
    A description of the AI Guardrail.
    
    Returns:
    
    A description of the AI Guardrail.
  - name
```
public final String name()
```
    The name of the AI Guardrail.
    
    Returns:
    
    The name of the AI Guardrail.
  - sensitiveInformationPolicyConfig
```
public final AIGuardrailSensitiveInformationPolicyConfig sensitiveInformationPolicyConfig()
```
    The sensitive information policy to configure for the AI Guardrail.
    
    Returns:
    
    The sensitive information policy to configure for the AI Guardrail.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final Map<String,String> tags()
```
    The tags used to organize, track, or control access for this resource.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    The tags used to organize, track, or control access for this resource.
  - topicPolicyConfig
```
public final AIGuardrailTopicPolicyConfig topicPolicyConfig()
```
    The topic policies to configure for the AI Guardrail.
    
    Returns:
    
    The topic policies to configure for the AI Guardrail.
  - visibilityStatus
```
public final VisibilityStatus visibilityStatus()
```
    The visibility status of the AI Guardrail.
    
    If the service returns an enum value that is not available in the current SDK version, visibilityStatus will return VisibilityStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from visibilityStatusAsString().
    
    Returns:
    
    The visibility status of the AI Guardrail.
    
    See Also:
    
    VisibilityStatus
  - visibilityStatusAsString
```
public final String visibilityStatusAsString()
```
    The visibility status of the AI Guardrail.
    
    If the service returns an enum value that is not available in the current SDK version, visibilityStatus will return VisibilityStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from visibilityStatusAsString().
    
    Returns:
    
    The visibility status of the AI Guardrail.
    
    See Also:
    
    VisibilityStatus
  - wordPolicyConfig
```
public final AIGuardrailWordPolicyConfig wordPolicyConfig()
```
    The word policy you configure for the AI Guardrail.
    
    Returns:
    
    The word policy you configure for the AI Guardrail.
  - toBuilder
```
public CreateAiGuardrailRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateAiGuardrailRequest.Builder,CreateAiGuardrailRequest>
    
    Specified by:
    
    toBuilder in class QConnectRequest
  - builder
```
public static CreateAiGuardrailRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateAiGuardrailRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class CreateAiGuardrailRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

assistantId

blockedInputMessaging

blockedOutputsMessaging

clientToken

contentPolicyConfig

contextualGroundingPolicyConfig

description

name

sensitiveInformationPolicyConfig

hasTags

tags

topicPolicyConfig

visibilityStatus

visibilityStatusAsString

wordPolicyConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField