Interface CreateAiGuardrailRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateAiGuardrailRequest.Builder,CreateAiGuardrailRequest>, QConnectRequest.Builder, SdkBuilder<CreateAiGuardrailRequest.Builder,CreateAiGuardrailRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateAiGuardrailRequest

@Mutable
@NotThreadSafe
public static interface CreateAiGuardrailRequest.Builder
extends QConnectRequest.Builder, SdkPojo, CopyableBuilder<CreateAiGuardrailRequest.Builder,CreateAiGuardrailRequest>

Method Summary

Modifier and Type	Method	Description
CreateAiGuardrailRequest.Builder	assistantId(String assistantId)	The identifier of the Amazon Q in Connect assistant.
CreateAiGuardrailRequest.Builder	blockedInputMessaging(String blockedInputMessaging)	The message to return when the AI Guardrail blocks a prompt.
CreateAiGuardrailRequest.Builder	blockedOutputsMessaging(String blockedOutputsMessaging)	The message to return when the AI Guardrail blocks a model response.
CreateAiGuardrailRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
default CreateAiGuardrailRequest.Builder	contentPolicyConfig(Consumer<AIGuardrailContentPolicyConfig.Builder> contentPolicyConfig)	The content filter policies to configure for the AI Guardrail.
CreateAiGuardrailRequest.Builder	contentPolicyConfig(AIGuardrailContentPolicyConfig contentPolicyConfig)	The content filter policies to configure for the AI Guardrail.
default CreateAiGuardrailRequest.Builder	contextualGroundingPolicyConfig(Consumer<AIGuardrailContextualGroundingPolicyConfig.Builder> contextualGroundingPolicyConfig)	The contextual grounding policy configuration used to create an AI Guardrail.
CreateAiGuardrailRequest.Builder	contextualGroundingPolicyConfig(AIGuardrailContextualGroundingPolicyConfig contextualGroundingPolicyConfig)	The contextual grounding policy configuration used to create an AI Guardrail.
CreateAiGuardrailRequest.Builder	description(String description)	A description of the AI Guardrail.
CreateAiGuardrailRequest.Builder	name(String name)	The name of the AI Guardrail.
CreateAiGuardrailRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateAiGuardrailRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateAiGuardrailRequest.Builder	sensitiveInformationPolicyConfig(Consumer<AIGuardrailSensitiveInformationPolicyConfig.Builder> sensitiveInformationPolicyConfig)	The sensitive information policy to configure for the AI Guardrail.
CreateAiGuardrailRequest.Builder	sensitiveInformationPolicyConfig(AIGuardrailSensitiveInformationPolicyConfig sensitiveInformationPolicyConfig)	The sensitive information policy to configure for the AI Guardrail.
CreateAiGuardrailRequest.Builder	tags(Map<String,String> tags)	The tags used to organize, track, or control access for this resource.
default CreateAiGuardrailRequest.Builder	topicPolicyConfig(Consumer<AIGuardrailTopicPolicyConfig.Builder> topicPolicyConfig)	The topic policies to configure for the AI Guardrail.
CreateAiGuardrailRequest.Builder	topicPolicyConfig(AIGuardrailTopicPolicyConfig topicPolicyConfig)	The topic policies to configure for the AI Guardrail.
CreateAiGuardrailRequest.Builder	visibilityStatus(String visibilityStatus)	The visibility status of the AI Guardrail.
CreateAiGuardrailRequest.Builder	visibilityStatus(VisibilityStatus visibilityStatus)	The visibility status of the AI Guardrail.
default CreateAiGuardrailRequest.Builder	wordPolicyConfig(Consumer<AIGuardrailWordPolicyConfig.Builder> wordPolicyConfig)	The word policy you configure for the AI Guardrail.
CreateAiGuardrailRequest.Builder	wordPolicyConfig(AIGuardrailWordPolicyConfig wordPolicyConfig)	The word policy you configure for the AI Guardrail.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.qconnect.model.QConnectRequest.Builder

build

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

clientToken

CreateAiGuardrailRequest.Builder clientToken(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..

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

assistantId

CreateAiGuardrailRequest.Builder assistantId(String assistantId)

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Parameters:

assistantId - The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

Returns a reference to this object so that method calls can be chained together.

name

CreateAiGuardrailRequest.Builder name(String name)

The name of the AI Guardrail.

Parameters:

name - The name of the AI Guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

blockedInputMessaging

CreateAiGuardrailRequest.Builder blockedInputMessaging(String blockedInputMessaging)

The message to return when the AI Guardrail blocks a prompt.

Parameters:

blockedInputMessaging - The message to return when the AI Guardrail blocks a prompt.

Returns:

Returns a reference to this object so that method calls can be chained together.

blockedOutputsMessaging

CreateAiGuardrailRequest.Builder blockedOutputsMessaging(String blockedOutputsMessaging)

The message to return when the AI Guardrail blocks a model response.

Parameters:

blockedOutputsMessaging - The message to return when the AI Guardrail blocks a model response.

Returns:

Returns a reference to this object so that method calls can be chained together.

visibilityStatus

CreateAiGuardrailRequest.Builder visibilityStatus(String visibilityStatus)

The visibility status of the AI Guardrail.

Parameters:

visibilityStatus - The visibility status of the AI Guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• VisibilityStatus
• VisibilityStatus

visibilityStatus

CreateAiGuardrailRequest.Builder visibilityStatus(VisibilityStatus visibilityStatus)

The visibility status of the AI Guardrail.

Parameters:

visibilityStatus - The visibility status of the AI Guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• VisibilityStatus
• VisibilityStatus

description

CreateAiGuardrailRequest.Builder description(String description)

A description of the AI Guardrail.

Parameters:

description - A description of the AI Guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

topicPolicyConfig

CreateAiGuardrailRequest.Builder topicPolicyConfig(AIGuardrailTopicPolicyConfig topicPolicyConfig)

The topic policies to configure for the AI Guardrail.

Parameters:

topicPolicyConfig - The topic policies to configure for the AI Guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

topicPolicyConfig

default CreateAiGuardrailRequest.Builder topicPolicyConfig(Consumer<AIGuardrailTopicPolicyConfig.Builder> topicPolicyConfig)

The topic policies to configure for the AI Guardrail.

This is a convenience method that creates an instance of the AIGuardrailTopicPolicyConfig.Builder avoiding the need to create one manually via AIGuardrailTopicPolicyConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to topicPolicyConfig(AIGuardrailTopicPolicyConfig).

Parameters:

topicPolicyConfig - a consumer that will call methods on AIGuardrailTopicPolicyConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• topicPolicyConfig(AIGuardrailTopicPolicyConfig)

contentPolicyConfig

CreateAiGuardrailRequest.Builder contentPolicyConfig(AIGuardrailContentPolicyConfig contentPolicyConfig)

The content filter policies to configure for the AI Guardrail.

Parameters:

contentPolicyConfig - The content filter policies to configure for the AI Guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

contentPolicyConfig

default CreateAiGuardrailRequest.Builder contentPolicyConfig(Consumer<AIGuardrailContentPolicyConfig.Builder> contentPolicyConfig)

The content filter policies to configure for the AI Guardrail.

This is a convenience method that creates an instance of the AIGuardrailContentPolicyConfig.Builder avoiding the need to create one manually via AIGuardrailContentPolicyConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to contentPolicyConfig(AIGuardrailContentPolicyConfig).

Parameters:

contentPolicyConfig - a consumer that will call methods on AIGuardrailContentPolicyConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• contentPolicyConfig(AIGuardrailContentPolicyConfig)

wordPolicyConfig

CreateAiGuardrailRequest.Builder wordPolicyConfig(AIGuardrailWordPolicyConfig wordPolicyConfig)

The word policy you configure for the AI Guardrail.

Parameters:

wordPolicyConfig - The word policy you configure for the AI Guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

wordPolicyConfig

default CreateAiGuardrailRequest.Builder wordPolicyConfig(Consumer<AIGuardrailWordPolicyConfig.Builder> wordPolicyConfig)

The word policy you configure for the AI Guardrail.

This is a convenience method that creates an instance of the AIGuardrailWordPolicyConfig.Builder avoiding the need to create one manually via AIGuardrailWordPolicyConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to wordPolicyConfig(AIGuardrailWordPolicyConfig).

Parameters:

wordPolicyConfig - a consumer that will call methods on AIGuardrailWordPolicyConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• wordPolicyConfig(AIGuardrailWordPolicyConfig)

sensitiveInformationPolicyConfig

CreateAiGuardrailRequest.Builder sensitiveInformationPolicyConfig(AIGuardrailSensitiveInformationPolicyConfig sensitiveInformationPolicyConfig)

The sensitive information policy to configure for the AI Guardrail.

Parameters:

sensitiveInformationPolicyConfig - The sensitive information policy to configure for the AI Guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

sensitiveInformationPolicyConfig

default CreateAiGuardrailRequest.Builder sensitiveInformationPolicyConfig(Consumer<AIGuardrailSensitiveInformationPolicyConfig.Builder> sensitiveInformationPolicyConfig)

The sensitive information policy to configure for the AI Guardrail.

This is a convenience method that creates an instance of the AIGuardrailSensitiveInformationPolicyConfig.Builder avoiding the need to create one manually via AIGuardrailSensitiveInformationPolicyConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sensitiveInformationPolicyConfig(AIGuardrailSensitiveInformationPolicyConfig).

Parameters:

sensitiveInformationPolicyConfig - a consumer that will call methods on AIGuardrailSensitiveInformationPolicyConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• sensitiveInformationPolicyConfig(AIGuardrailSensitiveInformationPolicyConfig)

contextualGroundingPolicyConfig

CreateAiGuardrailRequest.Builder contextualGroundingPolicyConfig(AIGuardrailContextualGroundingPolicyConfig contextualGroundingPolicyConfig)

The contextual grounding policy configuration used to create an AI Guardrail.

Parameters:

contextualGroundingPolicyConfig - The contextual grounding policy configuration used to create an AI Guardrail.

Returns:

Returns a reference to this object so that method calls can be chained together.

contextualGroundingPolicyConfig

default CreateAiGuardrailRequest.Builder contextualGroundingPolicyConfig(Consumer<AIGuardrailContextualGroundingPolicyConfig.Builder> contextualGroundingPolicyConfig)

The contextual grounding policy configuration used to create an AI Guardrail.

This is a convenience method that creates an instance of the AIGuardrailContextualGroundingPolicyConfig.Builder avoiding the need to create one manually via AIGuardrailContextualGroundingPolicyConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to contextualGroundingPolicyConfig(AIGuardrailContextualGroundingPolicyConfig).

Parameters:

contextualGroundingPolicyConfig - a consumer that will call methods on AIGuardrailContextualGroundingPolicyConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• contextualGroundingPolicyConfig(AIGuardrailContextualGroundingPolicyConfig)

tags

CreateAiGuardrailRequest.Builder tags(Map<String,String> tags)

The tags used to organize, track, or control access for this resource.

Parameters:

tags - The tags used to organize, track, or control access for this resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateAiGuardrailRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateAiGuardrailRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.