Interface UpdateGuardrailRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BedrockRequest.Builder, Buildable, CopyableBuilder<UpdateGuardrailRequest.Builder,UpdateGuardrailRequest>, SdkBuilder<UpdateGuardrailRequest.Builder,UpdateGuardrailRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateGuardrailRequest

@Mutable
@NotThreadSafe
public static interface UpdateGuardrailRequest.Builder
extends BedrockRequest.Builder, SdkPojo, CopyableBuilder<UpdateGuardrailRequest.Builder,UpdateGuardrailRequest>

Method Summary

Modifier and Type	Method	Description
UpdateGuardrailRequest.Builder	blockedInputMessaging(String blockedInputMessaging)	The message to return when the guardrail blocks a prompt.
UpdateGuardrailRequest.Builder	blockedOutputsMessaging(String blockedOutputsMessaging)	The message to return when the guardrail blocks a model response.
default UpdateGuardrailRequest.Builder	contentPolicyConfig(Consumer<GuardrailContentPolicyConfig.Builder> contentPolicyConfig)	The content policy to configure for the guardrail.
UpdateGuardrailRequest.Builder	contentPolicyConfig(GuardrailContentPolicyConfig contentPolicyConfig)	The content policy to configure for the guardrail.
default UpdateGuardrailRequest.Builder	contextualGroundingPolicyConfig(Consumer<GuardrailContextualGroundingPolicyConfig.Builder> contextualGroundingPolicyConfig)	The contextual grounding policy configuration used to update a guardrail.
UpdateGuardrailRequest.Builder	contextualGroundingPolicyConfig(GuardrailContextualGroundingPolicyConfig contextualGroundingPolicyConfig)	The contextual grounding policy configuration used to update a guardrail.
default UpdateGuardrailRequest.Builder	crossRegionConfig(Consumer<GuardrailCrossRegionConfig.Builder> crossRegionConfig)	The system-defined guardrail profile that you're using with your guardrail.
UpdateGuardrailRequest.Builder	crossRegionConfig(GuardrailCrossRegionConfig crossRegionConfig)	The system-defined guardrail profile that you're using with your guardrail.
UpdateGuardrailRequest.Builder	description(String description)	A description of the guardrail.
UpdateGuardrailRequest.Builder	guardrailIdentifier(String guardrailIdentifier)	The unique identifier of the guardrail.
UpdateGuardrailRequest.Builder	kmsKeyId(String kmsKeyId)	The ARN of the KMS key with which to encrypt the guardrail.
UpdateGuardrailRequest.Builder	name(String name)	A name for the guardrail.
UpdateGuardrailRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdateGuardrailRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default UpdateGuardrailRequest.Builder	sensitiveInformationPolicyConfig(Consumer<GuardrailSensitiveInformationPolicyConfig.Builder> sensitiveInformationPolicyConfig)	The sensitive information policy to configure for the guardrail.
UpdateGuardrailRequest.Builder	sensitiveInformationPolicyConfig(GuardrailSensitiveInformationPolicyConfig sensitiveInformationPolicyConfig)	The sensitive information policy to configure for the guardrail.
default UpdateGuardrailRequest.Builder	topicPolicyConfig(Consumer<GuardrailTopicPolicyConfig.Builder> topicPolicyConfig)	The topic policy to configure for the guardrail.
UpdateGuardrailRequest.Builder	topicPolicyConfig(GuardrailTopicPolicyConfig topicPolicyConfig)	The topic policy to configure for the guardrail.
default UpdateGuardrailRequest.Builder	wordPolicyConfig(Consumer<GuardrailWordPolicyConfig.Builder> wordPolicyConfig)	The word policy to configure for the guardrail.
UpdateGuardrailRequest.Builder	wordPolicyConfig(GuardrailWordPolicyConfig wordPolicyConfig)	The word policy to configure for the guardrail.

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

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.bedrock.model.BedrockRequest.Builder

build

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 Details

guardrailIdentifier

UpdateGuardrailRequest.Builder guardrailIdentifier(String guardrailIdentifier)

The unique identifier of the guardrail. This can be an ID or the ARN.

Parameters:

guardrailIdentifier - The unique identifier of the guardrail. This can be an ID or the ARN.

Returns:

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

name

UpdateGuardrailRequest.Builder name(String name)

A name for the guardrail.

Parameters:

name - A name for the guardrail.

Returns:

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

description

UpdateGuardrailRequest.Builder description(String description)

A description of the guardrail.

Parameters:

description - A description of the guardrail.

Returns:

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

topicPolicyConfig

UpdateGuardrailRequest.Builder topicPolicyConfig(GuardrailTopicPolicyConfig topicPolicyConfig)

The topic policy to configure for the guardrail.

Parameters:

topicPolicyConfig - The topic policy to configure for the guardrail.

Returns:

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

topicPolicyConfig

default UpdateGuardrailRequest.Builder topicPolicyConfig(Consumer<GuardrailTopicPolicyConfig.Builder> topicPolicyConfig)

The topic policy to configure for the guardrail.

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

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

Parameters:

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

Returns:

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

See Also:

• topicPolicyConfig(GuardrailTopicPolicyConfig)

contentPolicyConfig

UpdateGuardrailRequest.Builder contentPolicyConfig(GuardrailContentPolicyConfig contentPolicyConfig)

The content policy to configure for the guardrail.

Parameters:

contentPolicyConfig - The content policy to configure for the guardrail.

Returns:

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

contentPolicyConfig

default UpdateGuardrailRequest.Builder contentPolicyConfig(Consumer<GuardrailContentPolicyConfig.Builder> contentPolicyConfig)

The content policy to configure for the guardrail.

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

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

Parameters:

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

Returns:

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

See Also:

• contentPolicyConfig(GuardrailContentPolicyConfig)

wordPolicyConfig

UpdateGuardrailRequest.Builder wordPolicyConfig(GuardrailWordPolicyConfig wordPolicyConfig)

The word policy to configure for the guardrail.

Parameters:

wordPolicyConfig - The word policy to configure for the guardrail.

Returns:

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

wordPolicyConfig

default UpdateGuardrailRequest.Builder wordPolicyConfig(Consumer<GuardrailWordPolicyConfig.Builder> wordPolicyConfig)

The word policy to configure for the guardrail.

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

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

Parameters:

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

Returns:

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

See Also:

• wordPolicyConfig(GuardrailWordPolicyConfig)

sensitiveInformationPolicyConfig

UpdateGuardrailRequest.Builder sensitiveInformationPolicyConfig(GuardrailSensitiveInformationPolicyConfig sensitiveInformationPolicyConfig)

The sensitive information policy to configure for the guardrail.

Parameters:

sensitiveInformationPolicyConfig - The sensitive information policy to configure for the guardrail.

Returns:

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

sensitiveInformationPolicyConfig

default UpdateGuardrailRequest.Builder sensitiveInformationPolicyConfig(Consumer<GuardrailSensitiveInformationPolicyConfig.Builder> sensitiveInformationPolicyConfig)

The sensitive information policy to configure for the guardrail.

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

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

Parameters:

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

Returns:

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

See Also:

• sensitiveInformationPolicyConfig(GuardrailSensitiveInformationPolicyConfig)

contextualGroundingPolicyConfig

UpdateGuardrailRequest.Builder contextualGroundingPolicyConfig(GuardrailContextualGroundingPolicyConfig contextualGroundingPolicyConfig)

The contextual grounding policy configuration used to update a guardrail.

Parameters:

contextualGroundingPolicyConfig - The contextual grounding policy configuration used to update a guardrail.

Returns:

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

contextualGroundingPolicyConfig

default UpdateGuardrailRequest.Builder contextualGroundingPolicyConfig(Consumer<GuardrailContextualGroundingPolicyConfig.Builder> contextualGroundingPolicyConfig)

The contextual grounding policy configuration used to update a guardrail.

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

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

Parameters:

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

Returns:

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

See Also:

• contextualGroundingPolicyConfig(GuardrailContextualGroundingPolicyConfig)

crossRegionConfig

UpdateGuardrailRequest.Builder crossRegionConfig(GuardrailCrossRegionConfig crossRegionConfig)

The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.

For more information, see the Amazon Bedrock User Guide.

Parameters:

crossRegionConfig - The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.

For more information, see the Amazon Bedrock User Guide.

Returns:

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

crossRegionConfig

default UpdateGuardrailRequest.Builder crossRegionConfig(Consumer<GuardrailCrossRegionConfig.Builder> crossRegionConfig)

The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.

For more information, see the Amazon Bedrock User Guide.

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

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

Parameters:

crossRegionConfig - a consumer that will call methods on GuardrailCrossRegionConfig.Builder

Returns:

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

See Also:

• crossRegionConfig(GuardrailCrossRegionConfig)

blockedInputMessaging

UpdateGuardrailRequest.Builder blockedInputMessaging(String blockedInputMessaging)

The message to return when the guardrail blocks a prompt.

Parameters:

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

Returns:

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

blockedOutputsMessaging

UpdateGuardrailRequest.Builder blockedOutputsMessaging(String blockedOutputsMessaging)

The message to return when the guardrail blocks a model response.

Parameters:

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

Returns:

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

kmsKeyId

UpdateGuardrailRequest.Builder kmsKeyId(String kmsKeyId)

The ARN of the KMS key with which to encrypt the guardrail.

Parameters:

kmsKeyId - The ARN of the KMS key with which to encrypt the guardrail.

Returns:

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

overrideConfiguration

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

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