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

Interface AIGuardrailData.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AIGuardrailData.Builder,AIGuardrailData>, SdkBuilder<AIGuardrailData.Builder,AIGuardrailData>, SdkPojo

Enclosing class:

AIGuardrailData

public static interface AIGuardrailData.Builder
extends SdkPojo, CopyableBuilder<AIGuardrailData.Builder,AIGuardrailData>

Method Summary

Modifier and Type	Method	Description
AIGuardrailData.Builder	aiGuardrailArn(String aiGuardrailArn)	The Amazon Resource Name (ARN) of the AI Guardrail.
AIGuardrailData.Builder	aiGuardrailId(String aiGuardrailId)	The identifier of the Amazon Q in Connect AI Guardrail.
AIGuardrailData.Builder	assistantArn(String assistantArn)	The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
AIGuardrailData.Builder	assistantId(String assistantId)	The identifier of the Amazon Q in Connect assistant.
AIGuardrailData.Builder	blockedInputMessaging(String blockedInputMessaging)	The message to return when the AI Guardrail blocks a prompt.
AIGuardrailData.Builder	blockedOutputsMessaging(String blockedOutputsMessaging)	The message to return when the AI Guardrail blocks a model response.
default AIGuardrailData.Builder	contentPolicyConfig(Consumer<AIGuardrailContentPolicyConfig.Builder> contentPolicyConfig)	Contains details about how to handle harmful content.
AIGuardrailData.Builder	contentPolicyConfig(AIGuardrailContentPolicyConfig contentPolicyConfig)	Contains details about how to handle harmful content.
default AIGuardrailData.Builder	contextualGroundingPolicyConfig(Consumer<AIGuardrailContextualGroundingPolicyConfig.Builder> contextualGroundingPolicyConfig)	The policy configuration details for the AI Guardrail's contextual grounding policy.
AIGuardrailData.Builder	contextualGroundingPolicyConfig(AIGuardrailContextualGroundingPolicyConfig contextualGroundingPolicyConfig)	The policy configuration details for the AI Guardrail's contextual grounding policy.
AIGuardrailData.Builder	description(String description)	A description of the AI Guardrail.
AIGuardrailData.Builder	modifiedTime(Instant modifiedTime)	The time the AI Guardrail was last modified.
AIGuardrailData.Builder	name(String name)	The name of the AI Guardrail.
default AIGuardrailData.Builder	sensitiveInformationPolicyConfig(Consumer<AIGuardrailSensitiveInformationPolicyConfig.Builder> sensitiveInformationPolicyConfig)	Contains details about PII entities and regular expressions to configure for the AI Guardrail.
AIGuardrailData.Builder	sensitiveInformationPolicyConfig(AIGuardrailSensitiveInformationPolicyConfig sensitiveInformationPolicyConfig)	Contains details about PII entities and regular expressions to configure for the AI Guardrail.
AIGuardrailData.Builder	status(String status)	The status of the AI Guardrail.
AIGuardrailData.Builder	status(Status status)	The status of the AI Guardrail.
AIGuardrailData.Builder	tags(Map<String,String> tags)	The tags used to organize, track, or control access for this resource.
default AIGuardrailData.Builder	topicPolicyConfig(Consumer<AIGuardrailTopicPolicyConfig.Builder> topicPolicyConfig)	Contains details about topics that the AI Guardrail should identify and deny.
AIGuardrailData.Builder	topicPolicyConfig(AIGuardrailTopicPolicyConfig topicPolicyConfig)	Contains details about topics that the AI Guardrail should identify and deny.
AIGuardrailData.Builder	visibilityStatus(String visibilityStatus)	The visibility status of the AI Guardrail.
AIGuardrailData.Builder	visibilityStatus(VisibilityStatus visibilityStatus)	The visibility status of the AI Guardrail.
default AIGuardrailData.Builder	wordPolicyConfig(Consumer<AIGuardrailWordPolicyConfig.Builder> wordPolicyConfig)	Contains details about the word policy to configured for the AI Guardrail.
AIGuardrailData.Builder	wordPolicyConfig(AIGuardrailWordPolicyConfig wordPolicyConfig)	Contains details about the word policy to configured for the AI Guardrail.

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

copy

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 Detail

aiGuardrailArn

AIGuardrailData.Builder aiGuardrailArn(String aiGuardrailArn)

The Amazon Resource Name (ARN) of the AI Guardrail.

Parameters:

aiGuardrailArn - The Amazon Resource Name (ARN) of the AI Guardrail.

Returns:

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

aiGuardrailId

AIGuardrailData.Builder aiGuardrailId(String aiGuardrailId)

The identifier of the Amazon Q in Connect AI Guardrail.

Parameters:

aiGuardrailId - The identifier of the Amazon Q in Connect AI Guardrail.

Returns:

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

assistantArn

AIGuardrailData.Builder assistantArn(String assistantArn)

The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

Parameters:

assistantArn - The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

Returns:

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

assistantId

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

blockedInputMessaging

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

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

contentPolicyConfig

AIGuardrailData.Builder contentPolicyConfig(AIGuardrailContentPolicyConfig contentPolicyConfig)

Contains details about how to handle harmful content.

Parameters:

contentPolicyConfig - Contains details about how to handle harmful content.

Returns:

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

contentPolicyConfig

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

Contains details about how to handle harmful content.

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)

contextualGroundingPolicyConfig

AIGuardrailData.Builder contextualGroundingPolicyConfig(AIGuardrailContextualGroundingPolicyConfig contextualGroundingPolicyConfig)

The policy configuration details for the AI Guardrail's contextual grounding policy.

Parameters:

contextualGroundingPolicyConfig - The policy configuration details for the AI Guardrail's contextual grounding policy.

Returns:

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

contextualGroundingPolicyConfig

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

The policy configuration details for the AI Guardrail's contextual grounding policy.

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)

description

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

modifiedTime

AIGuardrailData.Builder modifiedTime(Instant modifiedTime)

The time the AI Guardrail was last modified.

Parameters:

modifiedTime - The time the AI Guardrail was last modified.

Returns:

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

name

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

sensitiveInformationPolicyConfig

AIGuardrailData.Builder sensitiveInformationPolicyConfig(AIGuardrailSensitiveInformationPolicyConfig sensitiveInformationPolicyConfig)

Contains details about PII entities and regular expressions to configure for the AI Guardrail.

Parameters:

sensitiveInformationPolicyConfig - Contains details about PII entities and regular expressions to configure for the AI Guardrail.

Returns:

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

sensitiveInformationPolicyConfig

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

Contains details about PII entities and regular expressions 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)

status

AIGuardrailData.Builder status(String status)

The status of the AI Guardrail.

Parameters:

status - The status of the AI Guardrail.

Returns:

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

See Also:

Status, Status

status

AIGuardrailData.Builder status(Status status)

The status of the AI Guardrail.

Parameters:

status - The status of the AI Guardrail.

Returns:

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

See Also:

Status, Status

tags

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

topicPolicyConfig

AIGuardrailData.Builder topicPolicyConfig(AIGuardrailTopicPolicyConfig topicPolicyConfig)

Contains details about topics that the AI Guardrail should identify and deny.

Parameters:

topicPolicyConfig - Contains details about topics that the AI Guardrail should identify and deny.

Returns:

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

topicPolicyConfig

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

Contains details about topics that the AI Guardrail should identify and deny.

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)

visibilityStatus

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

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

wordPolicyConfig

AIGuardrailData.Builder wordPolicyConfig(AIGuardrailWordPolicyConfig wordPolicyConfig)

Contains details about the word policy to configured for the AI Guardrail.

Parameters:

wordPolicyConfig - Contains details about the word policy to configured for the AI Guardrail.

Returns:

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

wordPolicyConfig

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

Contains details about the word policy to configured 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)