pub struct UpdateGuardrailFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to UpdateGuardrail.
Updates a guardrail with the values you specify.
-
Specify a
nameand optionaldescription. -
Specify messages for when the guardrail successfully blocks a prompt or a model response in the
blockedInputMessagingandblockedOutputsMessagingfields. -
Specify topics for the guardrail to deny in the
topicPolicyConfigobject. Each GuardrailTopicConfig object in thetopicsConfiglist pertains to one topic.-
Give a
nameanddescriptionso that the guardrail can properly identify the topic. -
Specify
DENYin thetypefield. -
(Optional) Provide up to five prompts that you would categorize as belonging to the topic in the
exampleslist.
-
-
Specify filter strengths for the harmful categories defined in Amazon Bedrock in the
contentPolicyConfigobject. Each GuardrailContentFilterConfig object in thefiltersConfiglist 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
typefield. -
Specify the strength of the filter for prompts in the
inputStrengthfield and for model responses in thestrengthfield of the GuardrailContentFilterConfig.
-
-
(Optional) For security, include the ARN of a KMS key in the
kmsKeyIdfield.
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. This can be an ID or the ARN.
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. This can be an ID or the ARN.
Sourcepub fn get_guardrail_identifier(&self) -> &Option<String>
pub fn get_guardrail_identifier(&self) -> &Option<String>
The unique identifier of the guardrail. This can be an ID or the ARN.
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 contextual_grounding_policy_config(
self,
input: GuardrailContextualGroundingPolicyConfig,
) -> Self
pub fn contextual_grounding_policy_config( self, input: GuardrailContextualGroundingPolicyConfig, ) -> Self
The contextual grounding policy configuration used to update a guardrail.
Sourcepub fn set_contextual_grounding_policy_config(
self,
input: Option<GuardrailContextualGroundingPolicyConfig>,
) -> Self
pub fn set_contextual_grounding_policy_config( self, input: Option<GuardrailContextualGroundingPolicyConfig>, ) -> Self
The contextual grounding policy configuration used to update a guardrail.
Sourcepub fn get_contextual_grounding_policy_config(
&self,
) -> &Option<GuardrailContextualGroundingPolicyConfig>
pub fn get_contextual_grounding_policy_config( &self, ) -> &Option<GuardrailContextualGroundingPolicyConfig>
The contextual grounding policy configuration used to update a guardrail.
Sourcepub fn automated_reasoning_policy_config(
self,
input: GuardrailAutomatedReasoningPolicyConfig,
) -> Self
pub fn automated_reasoning_policy_config( self, input: GuardrailAutomatedReasoningPolicyConfig, ) -> Self
Updated configuration for Automated Reasoning policies associated with the guardrail.
Sourcepub fn set_automated_reasoning_policy_config(
self,
input: Option<GuardrailAutomatedReasoningPolicyConfig>,
) -> Self
pub fn set_automated_reasoning_policy_config( self, input: Option<GuardrailAutomatedReasoningPolicyConfig>, ) -> Self
Updated configuration for Automated Reasoning policies associated with the guardrail.
Sourcepub fn get_automated_reasoning_policy_config(
&self,
) -> &Option<GuardrailAutomatedReasoningPolicyConfig>
pub fn get_automated_reasoning_policy_config( &self, ) -> &Option<GuardrailAutomatedReasoningPolicyConfig>
Updated configuration for Automated Reasoning policies associated with the guardrail.
Sourcepub fn cross_region_config(self, input: GuardrailCrossRegionConfig) -> Self
pub fn cross_region_config(self, input: GuardrailCrossRegionConfig) -> Self
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.
Sourcepub fn set_cross_region_config(
self,
input: Option<GuardrailCrossRegionConfig>,
) -> Self
pub fn set_cross_region_config( self, input: Option<GuardrailCrossRegionConfig>, ) -> Self
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.
Sourcepub fn get_cross_region_config(&self) -> &Option<GuardrailCrossRegionConfig>
pub fn get_cross_region_config(&self) -> &Option<GuardrailCrossRegionConfig>
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.
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);