aws_sdk_bedrock/client/

create_guardrail.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateGuardrail`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`name(impl Into<String>)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::set_name):<br>required: **true**<br><p>The name to give the guardrail.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::set_description):<br>required: **false**<br><p>A description of the guardrail.</p><br>
    ///   - [`topic_policy_config(GuardrailTopicPolicyConfig)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::topic_policy_config) / [`set_topic_policy_config(Option<GuardrailTopicPolicyConfig>)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::set_topic_policy_config):<br>required: **false**<br><p>The topic policies to configure for the guardrail.</p><br>
    ///   - [`content_policy_config(GuardrailContentPolicyConfig)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::content_policy_config) / [`set_content_policy_config(Option<GuardrailContentPolicyConfig>)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::set_content_policy_config):<br>required: **false**<br><p>The content filter policies to configure for the guardrail.</p><br>
    ///   - [`word_policy_config(GuardrailWordPolicyConfig)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::word_policy_config) / [`set_word_policy_config(Option<GuardrailWordPolicyConfig>)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::set_word_policy_config):<br>required: **false**<br><p>The word policy you configure for the guardrail.</p><br>
    ///   - [`sensitive_information_policy_config(GuardrailSensitiveInformationPolicyConfig)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::sensitive_information_policy_config) / [`set_sensitive_information_policy_config(Option<GuardrailSensitiveInformationPolicyConfig>)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::set_sensitive_information_policy_config):<br>required: **false**<br><p>The sensitive information policy to configure for the guardrail.</p><br>
    ///   - [`contextual_grounding_policy_config(GuardrailContextualGroundingPolicyConfig)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::contextual_grounding_policy_config) / [`set_contextual_grounding_policy_config(Option<GuardrailContextualGroundingPolicyConfig>)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::set_contextual_grounding_policy_config):<br>required: **false**<br><p>The contextual grounding policy configuration used to create a guardrail.</p><br>
    ///   - [`automated_reasoning_policy_config(GuardrailAutomatedReasoningPolicyConfig)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::automated_reasoning_policy_config) / [`set_automated_reasoning_policy_config(Option<GuardrailAutomatedReasoningPolicyConfig>)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::set_automated_reasoning_policy_config):<br>required: **false**<br><p>Optional configuration for integrating Automated Reasoning policies with the new guardrail.</p><br>
    ///   - [`cross_region_config(GuardrailCrossRegionConfig)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::cross_region_config) / [`set_cross_region_config(Option<GuardrailCrossRegionConfig>)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::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>
    ///   - [`blocked_input_messaging(impl Into<String>)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::blocked_input_messaging) / [`set_blocked_input_messaging(Option<String>)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::set_blocked_input_messaging):<br>required: **true**<br><p>The message to return when the guardrail blocks a prompt.</p><br>
    ///   - [`blocked_outputs_messaging(impl Into<String>)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::blocked_outputs_messaging) / [`set_blocked_outputs_messaging(Option<String>)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::set_blocked_outputs_messaging):<br>required: **true**<br><p>The message to return when the guardrail blocks a model response.</p><br>
    ///   - [`kms_key_id(impl Into<String>)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::kms_key_id) / [`set_kms_key_id(Option<String>)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::set_kms_key_id):<br>required: **false**<br><p>The ARN of the KMS key that you use to encrypt the guardrail.</p><br>
    ///   - [`tags(Tag)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::set_tags):<br>required: **false**<br><p>The tags that you want to attach to the guardrail.</p><br>
    ///   - [`client_request_token(impl Into<String>)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::client_request_token) / [`set_client_request_token(Option<String>)`](crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::set_client_request_token):<br>required: **false**<br><p>A unique, case-sensitive identifier to ensure that the API request completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon S3 User Guide</i>.</p><br>
    /// - On success, responds with [`CreateGuardrailOutput`](crate::operation::create_guardrail::CreateGuardrailOutput) with field(s):
    ///   - [`guardrail_id(String)`](crate::operation::create_guardrail::CreateGuardrailOutput::guardrail_id): <p>The unique identifier of the guardrail that was created.</p>
    ///   - [`guardrail_arn(String)`](crate::operation::create_guardrail::CreateGuardrailOutput::guardrail_arn): <p>The ARN of the guardrail.</p>
    ///   - [`version(String)`](crate::operation::create_guardrail::CreateGuardrailOutput::version): <p>The version of the guardrail that was created. This value will always be <code>DRAFT</code>.</p>
    ///   - [`created_at(DateTime)`](crate::operation::create_guardrail::CreateGuardrailOutput::created_at): <p>The time at which the guardrail was created.</p>
    /// - On failure, responds with [`SdkError<CreateGuardrailError>`](crate::operation::create_guardrail::CreateGuardrailError)
    pub fn create_guardrail(&self) -> crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder {
        crate::operation::create_guardrail::builders::CreateGuardrailFluentBuilder::new(self.handle.clone())
    }
}