aws_sdk_bedrockruntime/client/
apply_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 [`ApplyGuardrail`](crate::operation::apply_guardrail::builders::ApplyGuardrailFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`guardrail_identifier(impl Into<String>)`](crate::operation::apply_guardrail::builders::ApplyGuardrailFluentBuilder::guardrail_identifier) / [`set_guardrail_identifier(Option<String>)`](crate::operation::apply_guardrail::builders::ApplyGuardrailFluentBuilder::set_guardrail_identifier):<br>required: **true**<br><p>The guardrail identifier used in the request to apply the guardrail.</p><br>
7    ///   - [`guardrail_version(impl Into<String>)`](crate::operation::apply_guardrail::builders::ApplyGuardrailFluentBuilder::guardrail_version) / [`set_guardrail_version(Option<String>)`](crate::operation::apply_guardrail::builders::ApplyGuardrailFluentBuilder::set_guardrail_version):<br>required: **true**<br><p>The guardrail version used in the request to apply the guardrail.</p><br>
8    ///   - [`source(GuardrailContentSource)`](crate::operation::apply_guardrail::builders::ApplyGuardrailFluentBuilder::source) / [`set_source(Option<GuardrailContentSource>)`](crate::operation::apply_guardrail::builders::ApplyGuardrailFluentBuilder::set_source):<br>required: **true**<br><p>The source of data used in the request to apply the guardrail.</p><br>
9    ///   - [`content(GuardrailContentBlock)`](crate::operation::apply_guardrail::builders::ApplyGuardrailFluentBuilder::content) / [`set_content(Option<Vec::<GuardrailContentBlock>>)`](crate::operation::apply_guardrail::builders::ApplyGuardrailFluentBuilder::set_content):<br>required: **true**<br><p>The content details used in the request to apply the guardrail.</p><br>
10    ///   - [`output_scope(GuardrailOutputScope)`](crate::operation::apply_guardrail::builders::ApplyGuardrailFluentBuilder::output_scope) / [`set_output_scope(Option<GuardrailOutputScope>)`](crate::operation::apply_guardrail::builders::ApplyGuardrailFluentBuilder::set_output_scope):<br>required: **false**<br><p>Specifies the scope of the output that you get in the response. Set to <code>FULL</code> to return the entire output, including any detected and non-detected entries in the response for enhanced debugging.</p> <p>Note that the full output scope doesn't apply to word filters or regex in sensitive information filters. It does apply to all other filtering policies, including sensitive information with filters that can detect personally identifiable information (PII).</p><br>
11    /// - On success, responds with [`ApplyGuardrailOutput`](crate::operation::apply_guardrail::ApplyGuardrailOutput) with field(s):
12    ///   - [`usage(Option<GuardrailUsage>)`](crate::operation::apply_guardrail::ApplyGuardrailOutput::usage): <p>The usage details in the response from the guardrail.</p>
13    ///   - [`action(GuardrailAction)`](crate::operation::apply_guardrail::ApplyGuardrailOutput::action): <p>The action taken in the response from the guardrail.</p>
14    ///   - [`action_reason(Option<String>)`](crate::operation::apply_guardrail::ApplyGuardrailOutput::action_reason): <p>The reason for the action taken when harmful content is detected.</p>
15    ///   - [`outputs(Vec::<GuardrailOutputContent>)`](crate::operation::apply_guardrail::ApplyGuardrailOutput::outputs): <p>The output details in the response from the guardrail.</p>
16    ///   - [`assessments(Vec::<GuardrailAssessment>)`](crate::operation::apply_guardrail::ApplyGuardrailOutput::assessments): <p>The assessment details in the response from the guardrail.</p>
17    ///   - [`guardrail_coverage(Option<GuardrailCoverage>)`](crate::operation::apply_guardrail::ApplyGuardrailOutput::guardrail_coverage): <p>The guardrail coverage details in the apply guardrail response.</p>
18    /// - On failure, responds with [`SdkError<ApplyGuardrailError>`](crate::operation::apply_guardrail::ApplyGuardrailError)
19    pub fn apply_guardrail(&self) -> crate::operation::apply_guardrail::builders::ApplyGuardrailFluentBuilder {
20        crate::operation::apply_guardrail::builders::ApplyGuardrailFluentBuilder::new(self.handle.clone())
21    }
22}
aws_sdk_bedrockruntime/client/apply_guardrail.rs

aws_sdk_bedrockruntime/client/
apply_guardrail.rs
