Package software.amazon.awssdk.services.bedrock.model

Class UpdateGuardrailRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.bedrock.model.BedrockRequest

software.amazon.awssdk.services.bedrock.model.UpdateGuardrailRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateGuardrailRequest.Builder,UpdateGuardrailRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateGuardrailRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	blockedInputMessaging()	The message to return when the guardrail blocks a prompt.
String	blockedOutputsMessaging()	The message to return when the guardrail blocks a model response.
static UpdateGuardrailRequest.Builder	builder()
GuardrailContentPolicyConfig	contentPolicyConfig()	The content policy to configure for the guardrail.
GuardrailContextualGroundingPolicyConfig	contextualGroundingPolicyConfig()	The contextual grounding policy configuration used to update a guardrail.
GuardrailCrossRegionConfig	crossRegionConfig()	The system-defined guardrail profile that you're using with your guardrail.
String	description()	A description of the guardrail.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	guardrailIdentifier()	The unique identifier of the guardrail.
int	hashCode()
String	kmsKeyId()	The ARN of the KMS key with which to encrypt the guardrail.
String	name()	A name for the guardrail.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
GuardrailSensitiveInformationPolicyConfig	sensitiveInformationPolicyConfig()	The sensitive information policy to configure for the guardrail.
static Class<? extends UpdateGuardrailRequest.Builder>	serializableBuilderClass()
UpdateGuardrailRequest.Builder	toBuilder()
GuardrailTopicPolicyConfig	topicPolicyConfig()	The topic policy to configure for the guardrail.
String	toString()	Returns a string representation of this object.
GuardrailWordPolicyConfig	wordPolicyConfig()	The word policy to configure for the 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

guardrailIdentifier

public final String guardrailIdentifier()

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

Returns:

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

name

public final String name()

A name for the guardrail.

Returns:

A name for the guardrail.

description

public final String description()

A description of the guardrail.

Returns:

A description of the guardrail.

topicPolicyConfig

public final GuardrailTopicPolicyConfig topicPolicyConfig()

The topic policy to configure for the guardrail.

Returns:

The topic policy to configure for the guardrail.

contentPolicyConfig

public final GuardrailContentPolicyConfig contentPolicyConfig()

The content policy to configure for the guardrail.

Returns:

The content policy to configure for the guardrail.

wordPolicyConfig

public final GuardrailWordPolicyConfig wordPolicyConfig()

The word policy to configure for the guardrail.

Returns:

The word policy to configure for the guardrail.

sensitiveInformationPolicyConfig

public final GuardrailSensitiveInformationPolicyConfig sensitiveInformationPolicyConfig()

The sensitive information policy to configure for the guardrail.

Returns:

The sensitive information policy to configure for the guardrail.

contextualGroundingPolicyConfig

public final GuardrailContextualGroundingPolicyConfig contextualGroundingPolicyConfig()

The contextual grounding policy configuration used to update a guardrail.

Returns:

The contextual grounding policy configuration used to update a guardrail.

crossRegionConfig

public final 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.

Returns:

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.

blockedInputMessaging

public final String blockedInputMessaging()

The message to return when the guardrail blocks a prompt.

Returns:

The message to return when the guardrail blocks a prompt.

blockedOutputsMessaging

public final String blockedOutputsMessaging()

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

Returns:

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

kmsKeyId

public final String kmsKeyId()

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

Returns:

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

toBuilder

public UpdateGuardrailRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateGuardrailRequest.Builder,UpdateGuardrailRequest>

Specified by:

toBuilder in class BedrockRequest

builder

public static UpdateGuardrailRequest.Builder builder()

serializableBuilderClass

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