java.lang.Object
- software.amazon.awssdk.services.qconnect.model.AIGuardrailData

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<AIGuardrailData.Builder,AIGuardrailData>

@Generated("software.amazon.awssdk:codegen")
public final class AIGuardrailData
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AIGuardrailData.Builder,AIGuardrailData>

The data for the AI Guardrail

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AIGuardrailData.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`aiGuardrailArn()`	The Amazon Resource Name (ARN) of the AI Guardrail.
`String`	`aiGuardrailId()`	The identifier of the Amazon Q in Connect AI Guardrail.
`String`	`assistantArn()`	The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
`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 AIGuardrailData.Builder`	`builder()`
`AIGuardrailContentPolicyConfig`	`contentPolicyConfig()`	Contains details about how to handle harmful content.
`AIGuardrailContextualGroundingPolicyConfig`	`contextualGroundingPolicyConfig()`	The policy configuration details for the AI Guardrail's contextual grounding policy.
`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.
`Instant`	`modifiedTime()`	The time the AI Guardrail was last modified.
`String`	`name()`	The name of the AI Guardrail.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`AIGuardrailSensitiveInformationPolicyConfig`	`sensitiveInformationPolicyConfig()`	Contains details about PII entities and regular expressions to configure for the AI Guardrail.
`static Class<? extends AIGuardrailData.Builder>`	`serializableBuilderClass()`
`Status`	`status()`	The status of the AI Guardrail.
`String`	`statusAsString()`	The status of the AI Guardrail.
`Map<String,String>`	`tags()`	The tags used to organize, track, or control access for this resource.
`AIGuardrailData.Builder`	`toBuilder()`
`AIGuardrailTopicPolicyConfig`	`topicPolicyConfig()`	Contains details about topics that the AI Guardrail should identify and deny.
`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()`	Contains details about the word policy to configured for the AI Guardrail.

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
  - aiGuardrailArn
```
public final String aiGuardrailArn()
```
    The Amazon Resource Name (ARN) of the AI Guardrail.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the AI Guardrail.
  - aiGuardrailId
```
public final String aiGuardrailId()
```
    The identifier of the Amazon Q in Connect AI Guardrail.
    
    Returns:
    
    The identifier of the Amazon Q in Connect AI Guardrail.
  - assistantArn
```
public final String assistantArn()
```
    The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
  - 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.
  - contentPolicyConfig
```
public final AIGuardrailContentPolicyConfig contentPolicyConfig()
```
    Contains details about how to handle harmful content.
    
    Returns:
    
    Contains details about how to handle harmful content.
  - contextualGroundingPolicyConfig
```
public final AIGuardrailContextualGroundingPolicyConfig contextualGroundingPolicyConfig()
```
    The policy configuration details for the AI Guardrail's contextual grounding policy.
    
    Returns:
    
    The policy configuration details for the AI Guardrail's contextual grounding policy.
  - description
```
public final String description()
```
    A description of the AI Guardrail.
    
    Returns:
    
    A description of the AI Guardrail.
  - modifiedTime
```
public final Instant modifiedTime()
```
    The time the AI Guardrail was last modified.
    
    Returns:
    
    The time the AI Guardrail was last modified.
  - name
```
public final String name()
```
    The name of the AI Guardrail.
    
    Returns:
    
    The name of the AI Guardrail.
  - sensitiveInformationPolicyConfig
```
public final AIGuardrailSensitiveInformationPolicyConfig sensitiveInformationPolicyConfig()
```
    Contains details about PII entities and regular expressions to configure for the AI Guardrail.
    
    Returns:
    
    Contains details about PII entities and regular expressions to configure for the AI Guardrail.
  - status
```
public final Status status()
```
    The status of the AI Guardrail.
    
    If the service returns an enum value that is not available in the current SDK version, status will return Status.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the AI Guardrail.
    
    See Also:
    
    Status
  - statusAsString
```
public final String statusAsString()
```
    The status of the AI Guardrail.
    
    If the service returns an enum value that is not available in the current SDK version, status will return Status.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the AI Guardrail.
    
    See Also:
    
    Status
  - 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()
```
    Contains details about topics that the AI Guardrail should identify and deny.
    
    Returns:
    
    Contains details about topics that the AI Guardrail should identify and deny.
  - 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()
```
    Contains details about the word policy to configured for the AI Guardrail.
    
    Returns:
    
    Contains details about the word policy to configured for the AI Guardrail.
  - toBuilder
```
public AIGuardrailData.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AIGuardrailData.Builder,AIGuardrailData>
  - builder
```
public static AIGuardrailData.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AIGuardrailData.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - 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 AIGuardrailData

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

aiGuardrailArn

aiGuardrailId

assistantArn

assistantId

blockedInputMessaging

blockedOutputsMessaging

contentPolicyConfig

contextualGroundingPolicyConfig

description

modifiedTime

name

sensitiveInformationPolicyConfig

status

statusAsString

hasTags

tags

topicPolicyConfig

visibilityStatus

visibilityStatusAsString

wordPolicyConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField