aws_sdk_cleanrooms/client/
list_schemas.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 [`ListSchemas`](crate::operation::list_schemas::builders::ListSchemasFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_schemas::builders::ListSchemasFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`collaboration_identifier(impl Into<String>)`](crate::operation::list_schemas::builders::ListSchemasFluentBuilder::collaboration_identifier) / [`set_collaboration_identifier(Option<String>)`](crate::operation::list_schemas::builders::ListSchemasFluentBuilder::set_collaboration_identifier):<br>required: **true**<br><p>A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.</p><br>
8    ///   - [`schema_type(SchemaType)`](crate::operation::list_schemas::builders::ListSchemasFluentBuilder::schema_type) / [`set_schema_type(Option<SchemaType>)`](crate::operation::list_schemas::builders::ListSchemasFluentBuilder::set_schema_type):<br>required: **false**<br><p>If present, filter schemas by schema type.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::list_schemas::builders::ListSchemasFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_schemas::builders::ListSchemasFluentBuilder::set_next_token):<br>required: **false**<br><p>The pagination token that's used to fetch the next set of results.</p><br>
10    ///   - [`max_results(i32)`](crate::operation::list_schemas::builders::ListSchemasFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_schemas::builders::ListSchemasFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.</p><br>
11    /// - On success, responds with [`ListSchemasOutput`](crate::operation::list_schemas::ListSchemasOutput) with field(s):
12    ///   - [`schema_summaries(Vec::<SchemaSummary>)`](crate::operation::list_schemas::ListSchemasOutput::schema_summaries): <p>The retrieved list of schemas.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::list_schemas::ListSchemasOutput::next_token): <p>The pagination token that's used to fetch the next set of results.</p>
14    /// - On failure, responds with [`SdkError<ListSchemasError>`](crate::operation::list_schemas::ListSchemasError)
15    pub fn list_schemas(&self) -> crate::operation::list_schemas::builders::ListSchemasFluentBuilder {
16        crate::operation::list_schemas::builders::ListSchemasFluentBuilder::new(self.handle.clone())
17    }
18}