aws_sdk_bedrock/client/
update_guardrail.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`UpdateGuardrail`](crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`guardrail_identifier(impl Into<String>)`](crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder::guardrail_identifier) / [`set_guardrail_identifier(Option<String>)`](crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder::set_guardrail_identifier):<br>required: **true**<br><p>The unique identifier of the guardrail. This can be an ID or the ARN.</p><br>
7    ///   - [`name(impl Into<String>)`](crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder::set_name):<br>required: **true**<br><p>A name for the guardrail.</p><br>
8    ///   - [`description(impl Into<String>)`](crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder::set_description):<br>required: **false**<br><p>A description of the guardrail.</p><br>
9    ///   - [`topic_policy_config(GuardrailTopicPolicyConfig)`](crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder::topic_policy_config) / [`set_topic_policy_config(Option<GuardrailTopicPolicyConfig>)`](crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder::set_topic_policy_config):<br>required: **false**<br><p>The topic policy to configure for the guardrail.</p><br>
10    ///   - [`content_policy_config(GuardrailContentPolicyConfig)`](crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder::content_policy_config) / [`set_content_policy_config(Option<GuardrailContentPolicyConfig>)`](crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder::set_content_policy_config):<br>required: **false**<br><p>The content policy to configure for the guardrail.</p><br>
11    ///   - [`word_policy_config(GuardrailWordPolicyConfig)`](crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder::word_policy_config) / [`set_word_policy_config(Option<GuardrailWordPolicyConfig>)`](crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder::set_word_policy_config):<br>required: **false**<br><p>The word policy to configure for the guardrail.</p><br>
12    ///   - [`sensitive_information_policy_config(GuardrailSensitiveInformationPolicyConfig)`](crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder::sensitive_information_policy_config) / [`set_sensitive_information_policy_config(Option<GuardrailSensitiveInformationPolicyConfig>)`](crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder::set_sensitive_information_policy_config):<br>required: **false**<br><p>The sensitive information policy to configure for the guardrail.</p><br>
13    ///   - [`contextual_grounding_policy_config(GuardrailContextualGroundingPolicyConfig)`](crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder::contextual_grounding_policy_config) / [`set_contextual_grounding_policy_config(Option<GuardrailContextualGroundingPolicyConfig>)`](crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder::set_contextual_grounding_policy_config):<br>required: **false**<br><p>The contextual grounding policy configuration used to update a guardrail.</p><br>
14    ///   - [`automated_reasoning_policy_config(GuardrailAutomatedReasoningPolicyConfig)`](crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder::automated_reasoning_policy_config) / [`set_automated_reasoning_policy_config(Option<GuardrailAutomatedReasoningPolicyConfig>)`](crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder::set_automated_reasoning_policy_config):<br>required: **false**<br><p>Updated configuration for Automated Reasoning policies associated with the guardrail.</p><br>
15    ///   - [`cross_region_config(GuardrailCrossRegionConfig)`](crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder::cross_region_config) / [`set_cross_region_config(Option<GuardrailCrossRegionConfig>)`](crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder::set_cross_region_config):<br>required: **false**<br><p>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.</p> <p>For more information, see the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html">Amazon Bedrock User Guide</a>.</p><br>
16    ///   - [`blocked_input_messaging(impl Into<String>)`](crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder::blocked_input_messaging) / [`set_blocked_input_messaging(Option<String>)`](crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder::set_blocked_input_messaging):<br>required: **true**<br><p>The message to return when the guardrail blocks a prompt.</p><br>
17    ///   - [`blocked_outputs_messaging(impl Into<String>)`](crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder::blocked_outputs_messaging) / [`set_blocked_outputs_messaging(Option<String>)`](crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder::set_blocked_outputs_messaging):<br>required: **true**<br><p>The message to return when the guardrail blocks a model response.</p><br>
18    ///   - [`kms_key_id(impl Into<String>)`](crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder::kms_key_id) / [`set_kms_key_id(Option<String>)`](crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder::set_kms_key_id):<br>required: **false**<br><p>The ARN of the KMS key with which to encrypt the guardrail.</p><br>
19    /// - On success, responds with [`UpdateGuardrailOutput`](crate::operation::update_guardrail::UpdateGuardrailOutput) with field(s):
20    ///   - [`guardrail_id(String)`](crate::operation::update_guardrail::UpdateGuardrailOutput::guardrail_id): <p>The unique identifier of the guardrail</p>
21    ///   - [`guardrail_arn(String)`](crate::operation::update_guardrail::UpdateGuardrailOutput::guardrail_arn): <p>The ARN of the guardrail.</p>
22    ///   - [`version(String)`](crate::operation::update_guardrail::UpdateGuardrailOutput::version): <p>The version of the guardrail.</p>
23    ///   - [`updated_at(DateTime)`](crate::operation::update_guardrail::UpdateGuardrailOutput::updated_at): <p>The date and time at which the guardrail was updated.</p>
24    /// - On failure, responds with [`SdkError<UpdateGuardrailError>`](crate::operation::update_guardrail::UpdateGuardrailError)
25    pub fn update_guardrail(&self) -> crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder {
26        crate::operation::update_guardrail::builders::UpdateGuardrailFluentBuilder::new(self.handle.clone())
27    }
28}