aws_sdk_bedrock/client/
get_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 [`GetGuardrail`](crate::operation::get_guardrail::builders::GetGuardrailFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`guardrail_identifier(impl Into<String>)`](crate::operation::get_guardrail::builders::GetGuardrailFluentBuilder::guardrail_identifier) / [`set_guardrail_identifier(Option<String>)`](crate::operation::get_guardrail::builders::GetGuardrailFluentBuilder::set_guardrail_identifier):<br>required: **true**<br><p>The unique identifier of the guardrail for which to get details. This can be an ID or the ARN.</p><br>
7    ///   - [`guardrail_version(impl Into<String>)`](crate::operation::get_guardrail::builders::GetGuardrailFluentBuilder::guardrail_version) / [`set_guardrail_version(Option<String>)`](crate::operation::get_guardrail::builders::GetGuardrailFluentBuilder::set_guardrail_version):<br>required: **false**<br><p>The version of the guardrail for which to get details. If you don't specify a version, the response returns details for the <code>DRAFT</code> version.</p><br>
8    /// - On success, responds with [`GetGuardrailOutput`](crate::operation::get_guardrail::GetGuardrailOutput) with field(s):
9    ///   - [`name(String)`](crate::operation::get_guardrail::GetGuardrailOutput::name): <p>The name of the guardrail.</p>
10    ///   - [`description(Option<String>)`](crate::operation::get_guardrail::GetGuardrailOutput::description): <p>The description of the guardrail.</p>
11    ///   - [`guardrail_id(String)`](crate::operation::get_guardrail::GetGuardrailOutput::guardrail_id): <p>The unique identifier of the guardrail.</p>
12    ///   - [`guardrail_arn(String)`](crate::operation::get_guardrail::GetGuardrailOutput::guardrail_arn): <p>The ARN of the guardrail.</p>
13    ///   - [`version(String)`](crate::operation::get_guardrail::GetGuardrailOutput::version): <p>The version of the guardrail.</p>
14    ///   - [`status(GuardrailStatus)`](crate::operation::get_guardrail::GetGuardrailOutput::status): <p>The status of the guardrail.</p>
15    ///   - [`topic_policy(Option<GuardrailTopicPolicy>)`](crate::operation::get_guardrail::GetGuardrailOutput::topic_policy): <p>The topic policy that was configured for the guardrail.</p>
16    ///   - [`content_policy(Option<GuardrailContentPolicy>)`](crate::operation::get_guardrail::GetGuardrailOutput::content_policy): <p>The content policy that was configured for the guardrail.</p>
17    ///   - [`word_policy(Option<GuardrailWordPolicy>)`](crate::operation::get_guardrail::GetGuardrailOutput::word_policy): <p>The word policy that was configured for the guardrail.</p>
18    ///   - [`sensitive_information_policy(Option<GuardrailSensitiveInformationPolicy>)`](crate::operation::get_guardrail::GetGuardrailOutput::sensitive_information_policy): <p>The sensitive information policy that was configured for the guardrail.</p>
19    ///   - [`contextual_grounding_policy(Option<GuardrailContextualGroundingPolicy>)`](crate::operation::get_guardrail::GetGuardrailOutput::contextual_grounding_policy): <p>The contextual grounding policy used in the guardrail.</p>
20    ///   - [`automated_reasoning_policy(Option<GuardrailAutomatedReasoningPolicy>)`](crate::operation::get_guardrail::GetGuardrailOutput::automated_reasoning_policy): <p>The current Automated Reasoning policy configuration for the guardrail, if any is configured.</p>
21    ///   - [`cross_region_details(Option<GuardrailCrossRegionDetails>)`](crate::operation::get_guardrail::GetGuardrailOutput::cross_region_details): <p>Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).</p>
22    ///   - [`created_at(DateTime)`](crate::operation::get_guardrail::GetGuardrailOutput::created_at): <p>The date and time at which the guardrail was created.</p>
23    ///   - [`updated_at(DateTime)`](crate::operation::get_guardrail::GetGuardrailOutput::updated_at): <p>The date and time at which the guardrail was updated.</p>
24    ///   - [`status_reasons(Option<Vec::<String>>)`](crate::operation::get_guardrail::GetGuardrailOutput::status_reasons): <p>Appears if the <code>status</code> is <code>FAILED</code>. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.</p>
25    ///   - [`failure_recommendations(Option<Vec::<String>>)`](crate::operation::get_guardrail::GetGuardrailOutput::failure_recommendations): <p>Appears if the <code>status</code> of the guardrail is <code>FAILED</code>. A list of recommendations to carry out before retrying the request.</p>
26    ///   - [`blocked_input_messaging(String)`](crate::operation::get_guardrail::GetGuardrailOutput::blocked_input_messaging): <p>The message that the guardrail returns when it blocks a prompt.</p>
27    ///   - [`blocked_outputs_messaging(String)`](crate::operation::get_guardrail::GetGuardrailOutput::blocked_outputs_messaging): <p>The message that the guardrail returns when it blocks a model response.</p>
28    ///   - [`kms_key_arn(Option<String>)`](crate::operation::get_guardrail::GetGuardrailOutput::kms_key_arn): <p>The ARN of the KMS key that encrypts the guardrail.</p>
29    /// - On failure, responds with [`SdkError<GetGuardrailError>`](crate::operation::get_guardrail::GetGuardrailError)
30    pub fn get_guardrail(&self) -> crate::operation::get_guardrail::builders::GetGuardrailFluentBuilder {
31        crate::operation::get_guardrail::builders::GetGuardrailFluentBuilder::new(self.handle.clone())
32    }
33}
aws_sdk_bedrock/client/get_guardrail.rs

aws_sdk_bedrock/client/
get_guardrail.rs
