aws_sdk_cognitoidentityprovider/client/

list_terms.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListTerms`](crate::operation::list_terms::builders::ListTermsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`user_pool_id(impl Into<String>)`](crate::operation::list_terms::builders::ListTermsFluentBuilder::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::operation::list_terms::builders::ListTermsFluentBuilder::set_user_pool_id):<br>required: **true**<br><p>The ID of the user pool where you want to list terms documents.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_terms::builders::ListTermsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_terms::builders::ListTermsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of terms documents that you want Amazon Cognito to return in the response.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_terms::builders::ListTermsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_terms::builders::ListTermsFluentBuilder::set_next_token):<br>required: **false**<br><p>This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.</p><br>
    /// - On success, responds with [`ListTermsOutput`](crate::operation::list_terms::ListTermsOutput) with field(s):
    ///   - [`terms(Vec::<TermsDescriptionType>)`](crate::operation::list_terms::ListTermsOutput::terms): <p>A summary of the requested terms documents. Includes unique identifiers for later changes to the terms documents.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_terms::ListTermsOutput::next_token): <p>This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.</p>
    /// - On failure, responds with [`SdkError<ListTermsError>`](crate::operation::list_terms::ListTermsError)
    pub fn list_terms(&self) -> crate::operation::list_terms::builders::ListTermsFluentBuilder {
        crate::operation::list_terms::builders::ListTermsFluentBuilder::new(self.handle.clone())
    }
}