Package software.amazon.awssdk.services.qconnect.model

Class UpdateAiGuardrailRequest

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.UpdateAiGuardrailRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateAiGuardrailRequest.Builder,UpdateAiGuardrailRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateAiGuardrailRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	aiGuardrailId()	The identifier of the Amazon Q in Connect AI Guardrail.
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 UpdateAiGuardrailRequest.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()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
AIGuardrailSensitiveInformationPolicyConfig	sensitiveInformationPolicyConfig()	The sensitive information policy to configure for the AI Guardrail.
static Class<? extends UpdateAiGuardrailRequest.Builder>	serializableBuilderClass()
UpdateAiGuardrailRequest.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 Amazon Q in Connect AI Guardrail.
String	visibilityStatusAsString()	The visibility status of the Amazon Q in Connect 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

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.

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.

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.

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 Amazon Q in Connect 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 Amazon Q in Connect AI Guardrail.

See Also:

VisibilityStatus

visibilityStatusAsString

public final String visibilityStatusAsString()

The visibility status of the Amazon Q in Connect 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 Amazon Q in Connect 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 UpdateAiGuardrailRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateAiGuardrailRequest.Builder,UpdateAiGuardrailRequest>

Specified by:

toBuilder in class QConnectRequest

builder

public static UpdateAiGuardrailRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateAiGuardrailRequest.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