aws_sdk_bedrock/client/list_guardrails.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 [`ListGuardrails`](crate::operation::list_guardrails::builders::ListGuardrailsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_guardrails::builders::ListGuardrailsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`guardrail_identifier(impl Into<String>)`](crate::operation::list_guardrails::builders::ListGuardrailsFluentBuilder::guardrail_identifier) / [`set_guardrail_identifier(Option<String>)`](crate::operation::list_guardrails::builders::ListGuardrailsFluentBuilder::set_guardrail_identifier):<br>required: **false**<br><p>The unique identifier of the guardrail. This can be an ID or the ARN.</p><br>
8 /// - [`max_results(i32)`](crate::operation::list_guardrails::builders::ListGuardrailsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_guardrails::builders::ListGuardrailsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in the response.</p><br>
9 /// - [`next_token(impl Into<String>)`](crate::operation::list_guardrails::builders::ListGuardrailsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_guardrails::builders::ListGuardrailsFluentBuilder::set_next_token):<br>required: **false**<br><p>If there are more results than were returned in the response, the response returns a <code>nextToken</code> that you can send in another <code>ListGuardrails</code> request to see the next batch of results.</p><br>
10 /// - On success, responds with [`ListGuardrailsOutput`](crate::operation::list_guardrails::ListGuardrailsOutput) with field(s):
11 /// - [`guardrails(Vec::<GuardrailSummary>)`](crate::operation::list_guardrails::ListGuardrailsOutput::guardrails): <p>A list of objects, each of which contains details about a guardrail.</p>
12 /// - [`next_token(Option<String>)`](crate::operation::list_guardrails::ListGuardrailsOutput::next_token): <p>If there are more results than were returned in the response, the response returns a <code>nextToken</code> that you can send in another <code>ListGuardrails</code> request to see the next batch of results.</p>
13 /// - On failure, responds with [`SdkError<ListGuardrailsError>`](crate::operation::list_guardrails::ListGuardrailsError)
14 pub fn list_guardrails(&self) -> crate::operation::list_guardrails::builders::ListGuardrailsFluentBuilder {
15 crate::operation::list_guardrails::builders::ListGuardrailsFluentBuilder::new(self.handle.clone())
16 }
17}