com.amazonaws.services.bedrock.model

Class UpdateGuardrailRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.bedrock.model.UpdateGuardrailRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateGuardrailRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateGuardrailRequest()

Method Summary

Modifier and Type	Method and Description
UpdateGuardrailRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getBlockedInputMessaging() The message to return when the guardrail blocks a prompt.
String	getBlockedOutputsMessaging() The message to return when the guardrail blocks a model response.
GuardrailContentPolicyConfig	getContentPolicyConfig() The content policy to configure for the guardrail.
GuardrailContextualGroundingPolicyConfig	getContextualGroundingPolicyConfig() The contextual grounding policy configuration used to update a guardrail.
String	getDescription() A description of the guardrail.
String	getGuardrailIdentifier() The unique identifier of the guardrail.
String	getKmsKeyId() The ARN of the KMS key with which to encrypt the guardrail.
String	getName() A name for the guardrail.
GuardrailSensitiveInformationPolicyConfig	getSensitiveInformationPolicyConfig() The sensitive information policy to configure for the guardrail.
GuardrailTopicPolicyConfig	getTopicPolicyConfig() The topic policy to configure for the guardrail.
GuardrailWordPolicyConfig	getWordPolicyConfig() The word policy to configure for the guardrail.
int	hashCode()
void	setBlockedInputMessaging(String blockedInputMessaging) The message to return when the guardrail blocks a prompt.
void	setBlockedOutputsMessaging(String blockedOutputsMessaging) The message to return when the guardrail blocks a model response.
void	setContentPolicyConfig(GuardrailContentPolicyConfig contentPolicyConfig) The content policy to configure for the guardrail.
void	setContextualGroundingPolicyConfig(GuardrailContextualGroundingPolicyConfig contextualGroundingPolicyConfig) The contextual grounding policy configuration used to update a guardrail.
void	setDescription(String description) A description of the guardrail.
void	setGuardrailIdentifier(String guardrailIdentifier) The unique identifier of the guardrail.
void	setKmsKeyId(String kmsKeyId) The ARN of the KMS key with which to encrypt the guardrail.
void	setName(String name) A name for the guardrail.
void	setSensitiveInformationPolicyConfig(GuardrailSensitiveInformationPolicyConfig sensitiveInformationPolicyConfig) The sensitive information policy to configure for the guardrail.
void	setTopicPolicyConfig(GuardrailTopicPolicyConfig topicPolicyConfig) The topic policy to configure for the guardrail.
void	setWordPolicyConfig(GuardrailWordPolicyConfig wordPolicyConfig) The word policy to configure for the guardrail.
String	toString() Returns a string representation of this object.
UpdateGuardrailRequest	withBlockedInputMessaging(String blockedInputMessaging) The message to return when the guardrail blocks a prompt.
UpdateGuardrailRequest	withBlockedOutputsMessaging(String blockedOutputsMessaging) The message to return when the guardrail blocks a model response.
UpdateGuardrailRequest	withContentPolicyConfig(GuardrailContentPolicyConfig contentPolicyConfig) The content policy to configure for the guardrail.
UpdateGuardrailRequest	withContextualGroundingPolicyConfig(GuardrailContextualGroundingPolicyConfig contextualGroundingPolicyConfig) The contextual grounding policy configuration used to update a guardrail.
UpdateGuardrailRequest	withDescription(String description) A description of the guardrail.
UpdateGuardrailRequest	withGuardrailIdentifier(String guardrailIdentifier) The unique identifier of the guardrail.
UpdateGuardrailRequest	withKmsKeyId(String kmsKeyId) The ARN of the KMS key with which to encrypt the guardrail.
UpdateGuardrailRequest	withName(String name) A name for the guardrail.
UpdateGuardrailRequest	withSensitiveInformationPolicyConfig(GuardrailSensitiveInformationPolicyConfig sensitiveInformationPolicyConfig) The sensitive information policy to configure for the guardrail.
UpdateGuardrailRequest	withTopicPolicyConfig(GuardrailTopicPolicyConfig topicPolicyConfig) The topic policy to configure for the guardrail.
UpdateGuardrailRequest	withWordPolicyConfig(GuardrailWordPolicyConfig wordPolicyConfig) The word policy to configure for the guardrail.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateGuardrailRequest

public UpdateGuardrailRequest()

Method Detail

setGuardrailIdentifier

public void setGuardrailIdentifier(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.

getGuardrailIdentifier

public String getGuardrailIdentifier()

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.

withGuardrailIdentifier

public UpdateGuardrailRequest withGuardrailIdentifier(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.

setName

public void setName(String name)

A name for the guardrail.

Parameters:

name - A name for the guardrail.

getName

public String getName()

A name for the guardrail.

Returns:

A name for the guardrail.

withName

public UpdateGuardrailRequest withName(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.

setDescription

public void setDescription(String description)

A description of the guardrail.

Parameters:

description - A description of the guardrail.

getDescription

public String getDescription()

A description of the guardrail.

Returns:

A description of the guardrail.

withDescription

public UpdateGuardrailRequest withDescription(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.

setTopicPolicyConfig

public void setTopicPolicyConfig(GuardrailTopicPolicyConfig topicPolicyConfig)

The topic policy to configure for the guardrail.

Parameters:

topicPolicyConfig - The topic policy to configure for the guardrail.

getTopicPolicyConfig

public GuardrailTopicPolicyConfig getTopicPolicyConfig()

The topic policy to configure for the guardrail.

Returns:

The topic policy to configure for the guardrail.

withTopicPolicyConfig

public UpdateGuardrailRequest withTopicPolicyConfig(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.

setContentPolicyConfig

public void setContentPolicyConfig(GuardrailContentPolicyConfig contentPolicyConfig)

The content policy to configure for the guardrail.

Parameters:

contentPolicyConfig - The content policy to configure for the guardrail.

getContentPolicyConfig

public GuardrailContentPolicyConfig getContentPolicyConfig()

The content policy to configure for the guardrail.

Returns:

The content policy to configure for the guardrail.

withContentPolicyConfig

public UpdateGuardrailRequest withContentPolicyConfig(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.

setWordPolicyConfig

public void setWordPolicyConfig(GuardrailWordPolicyConfig wordPolicyConfig)

The word policy to configure for the guardrail.

Parameters:

wordPolicyConfig - The word policy to configure for the guardrail.

getWordPolicyConfig

public GuardrailWordPolicyConfig getWordPolicyConfig()

The word policy to configure for the guardrail.

Returns:

The word policy to configure for the guardrail.

withWordPolicyConfig

public UpdateGuardrailRequest withWordPolicyConfig(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.

setSensitiveInformationPolicyConfig

public void setSensitiveInformationPolicyConfig(GuardrailSensitiveInformationPolicyConfig sensitiveInformationPolicyConfig)

The sensitive information policy to configure for the guardrail.

Parameters:

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

getSensitiveInformationPolicyConfig

public GuardrailSensitiveInformationPolicyConfig getSensitiveInformationPolicyConfig()

The sensitive information policy to configure for the guardrail.

Returns:

The sensitive information policy to configure for the guardrail.

withSensitiveInformationPolicyConfig

public UpdateGuardrailRequest withSensitiveInformationPolicyConfig(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.

setContextualGroundingPolicyConfig

public void setContextualGroundingPolicyConfig(GuardrailContextualGroundingPolicyConfig contextualGroundingPolicyConfig)

The contextual grounding policy configuration used to update a guardrail.

Parameters:

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

getContextualGroundingPolicyConfig

public GuardrailContextualGroundingPolicyConfig getContextualGroundingPolicyConfig()

The contextual grounding policy configuration used to update a guardrail.

Returns:

The contextual grounding policy configuration used to update a guardrail.

withContextualGroundingPolicyConfig

public UpdateGuardrailRequest withContextualGroundingPolicyConfig(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.

setBlockedInputMessaging

public void setBlockedInputMessaging(String blockedInputMessaging)

The message to return when the guardrail blocks a prompt.

Parameters:

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

getBlockedInputMessaging

public String getBlockedInputMessaging()

The message to return when the guardrail blocks a prompt.

Returns:

The message to return when the guardrail blocks a prompt.

withBlockedInputMessaging

public UpdateGuardrailRequest withBlockedInputMessaging(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.

setBlockedOutputsMessaging

public void setBlockedOutputsMessaging(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.

getBlockedOutputsMessaging

public String getBlockedOutputsMessaging()

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

Returns:

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

withBlockedOutputsMessaging

public UpdateGuardrailRequest withBlockedOutputsMessaging(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.

setKmsKeyId

public void setKmsKeyId(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.

getKmsKeyId

public String getKmsKeyId()

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.

withKmsKeyId

public UpdateGuardrailRequest withKmsKeyId(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateGuardrailRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()