pub struct UpdateGuardrailFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to UpdateGuardrail
.
Updates a guardrail with the values you specify.
-
Specify a
name
and optionaldescription
. -
Specify messages for when the guardrail successfully blocks a prompt or a model response in the
blockedInputMessaging
andblockedOutputsMessaging
fields. -
Specify topics for the guardrail to deny in the
topicPolicyConfig
object. Each GuardrailTopicConfig object in thetopicsConfig
list pertains to one topic.-
Give a
name
anddescription
so that the guardrail can properly identify the topic. -
Specify
DENY
in thetype
field. -
(Optional) Provide up to five prompts that you would categorize as belonging to the topic in the
examples
list.
-
-
Specify filter strengths for the harmful categories defined in Amazon Bedrock in the
contentPolicyConfig
object. Each GuardrailContentFilterConfig object in thefiltersConfig
list pertains to a harmful category. For more information, see Content filters. For more information about the fields in a content filter, see GuardrailContentFilterConfig.-
Specify the category in the
type
field. -
Specify the strength of the filter for prompts in the
inputStrength
field and for model responses in thestrength
field of the GuardrailContentFilterConfig.
-
-
(Optional) For security, include the ARN of a KMS key in the
kmsKeyId
field. -
(Optional) Attach any tags to the guardrail in the
tags
object. For more information, see Tag resources.
Implementations§
source§impl UpdateGuardrailFluentBuilder
impl UpdateGuardrailFluentBuilder
sourcepub fn as_input(&self) -> &UpdateGuardrailInputBuilder
pub fn as_input(&self) -> &UpdateGuardrailInputBuilder
Access the UpdateGuardrail as a reference.
sourcepub async fn send(
self
) -> Result<UpdateGuardrailOutput, SdkError<UpdateGuardrailError, HttpResponse>>
pub async fn send( self ) -> Result<UpdateGuardrailOutput, SdkError<UpdateGuardrailError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self
) -> CustomizableOperation<UpdateGuardrailOutput, UpdateGuardrailError, Self>
pub fn customize( self ) -> CustomizableOperation<UpdateGuardrailOutput, UpdateGuardrailError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn guardrail_identifier(self, input: impl Into<String>) -> Self
pub fn guardrail_identifier(self, input: impl Into<String>) -> Self
The unique identifier of the guardrail
sourcepub fn set_guardrail_identifier(self, input: Option<String>) -> Self
pub fn set_guardrail_identifier(self, input: Option<String>) -> Self
The unique identifier of the guardrail
sourcepub fn get_guardrail_identifier(&self) -> &Option<String>
pub fn get_guardrail_identifier(&self) -> &Option<String>
The unique identifier of the guardrail
sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the guardrail.
sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the guardrail.
sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the guardrail.
sourcepub fn topic_policy_config(self, input: GuardrailTopicPolicyConfig) -> Self
pub fn topic_policy_config(self, input: GuardrailTopicPolicyConfig) -> Self
The topic policy to configure for the guardrail.
sourcepub fn set_topic_policy_config(
self,
input: Option<GuardrailTopicPolicyConfig>
) -> Self
pub fn set_topic_policy_config( self, input: Option<GuardrailTopicPolicyConfig> ) -> Self
The topic policy to configure for the guardrail.
sourcepub fn get_topic_policy_config(&self) -> &Option<GuardrailTopicPolicyConfig>
pub fn get_topic_policy_config(&self) -> &Option<GuardrailTopicPolicyConfig>
The topic policy to configure for the guardrail.
sourcepub fn content_policy_config(self, input: GuardrailContentPolicyConfig) -> Self
pub fn content_policy_config(self, input: GuardrailContentPolicyConfig) -> Self
The content policy to configure for the guardrail.
sourcepub fn set_content_policy_config(
self,
input: Option<GuardrailContentPolicyConfig>
) -> Self
pub fn set_content_policy_config( self, input: Option<GuardrailContentPolicyConfig> ) -> Self
The content policy to configure for the guardrail.
sourcepub fn get_content_policy_config(&self) -> &Option<GuardrailContentPolicyConfig>
pub fn get_content_policy_config(&self) -> &Option<GuardrailContentPolicyConfig>
The content policy to configure for the guardrail.
sourcepub fn word_policy_config(self, input: GuardrailWordPolicyConfig) -> Self
pub fn word_policy_config(self, input: GuardrailWordPolicyConfig) -> Self
The word policy to configure for the guardrail.
sourcepub fn set_word_policy_config(
self,
input: Option<GuardrailWordPolicyConfig>
) -> Self
pub fn set_word_policy_config( self, input: Option<GuardrailWordPolicyConfig> ) -> Self
The word policy to configure for the guardrail.
sourcepub fn get_word_policy_config(&self) -> &Option<GuardrailWordPolicyConfig>
pub fn get_word_policy_config(&self) -> &Option<GuardrailWordPolicyConfig>
The word policy to configure for the guardrail.
sourcepub fn sensitive_information_policy_config(
self,
input: GuardrailSensitiveInformationPolicyConfig
) -> Self
pub fn sensitive_information_policy_config( self, input: GuardrailSensitiveInformationPolicyConfig ) -> Self
The sensitive information policy to configure for the guardrail.
sourcepub fn set_sensitive_information_policy_config(
self,
input: Option<GuardrailSensitiveInformationPolicyConfig>
) -> Self
pub fn set_sensitive_information_policy_config( self, input: Option<GuardrailSensitiveInformationPolicyConfig> ) -> Self
The sensitive information policy to configure for the guardrail.
sourcepub fn get_sensitive_information_policy_config(
&self
) -> &Option<GuardrailSensitiveInformationPolicyConfig>
pub fn get_sensitive_information_policy_config( &self ) -> &Option<GuardrailSensitiveInformationPolicyConfig>
The sensitive information policy to configure for the guardrail.
sourcepub fn blocked_input_messaging(self, input: impl Into<String>) -> Self
pub fn blocked_input_messaging(self, input: impl Into<String>) -> Self
The message to return when the guardrail blocks a prompt.
sourcepub fn set_blocked_input_messaging(self, input: Option<String>) -> Self
pub fn set_blocked_input_messaging(self, input: Option<String>) -> Self
The message to return when the guardrail blocks a prompt.
sourcepub fn get_blocked_input_messaging(&self) -> &Option<String>
pub fn get_blocked_input_messaging(&self) -> &Option<String>
The message to return when the guardrail blocks a prompt.
sourcepub fn blocked_outputs_messaging(self, input: impl Into<String>) -> Self
pub fn blocked_outputs_messaging(self, input: impl Into<String>) -> Self
The message to return when the guardrail blocks a model response.
sourcepub fn set_blocked_outputs_messaging(self, input: Option<String>) -> Self
pub fn set_blocked_outputs_messaging(self, input: Option<String>) -> Self
The message to return when the guardrail blocks a model response.
sourcepub fn get_blocked_outputs_messaging(&self) -> &Option<String>
pub fn get_blocked_outputs_messaging(&self) -> &Option<String>
The message to return when the guardrail blocks a model response.
sourcepub fn kms_key_id(self, input: impl Into<String>) -> Self
pub fn kms_key_id(self, input: impl Into<String>) -> Self
The ARN of the KMS key with which to encrypt the guardrail.
sourcepub fn set_kms_key_id(self, input: Option<String>) -> Self
pub fn set_kms_key_id(self, input: Option<String>) -> Self
The ARN of the KMS key with which to encrypt the guardrail.
sourcepub fn get_kms_key_id(&self) -> &Option<String>
pub fn get_kms_key_id(&self) -> &Option<String>
The ARN of the KMS key with which to encrypt the guardrail.
Trait Implementations§
source§impl Clone for UpdateGuardrailFluentBuilder
impl Clone for UpdateGuardrailFluentBuilder
source§fn clone(&self) -> UpdateGuardrailFluentBuilder
fn clone(&self) -> UpdateGuardrailFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for UpdateGuardrailFluentBuilder
impl !RefUnwindSafe for UpdateGuardrailFluentBuilder
impl Send for UpdateGuardrailFluentBuilder
impl Sync for UpdateGuardrailFluentBuilder
impl Unpin for UpdateGuardrailFluentBuilder
impl !UnwindSafe for UpdateGuardrailFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more