aws_sdk_cognitoidentityprovider/client/
describe_terms.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 [`DescribeTerms`](crate::operation::describe_terms::builders::DescribeTermsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`terms_id(impl Into<String>)`](crate::operation::describe_terms::builders::DescribeTermsFluentBuilder::terms_id) / [`set_terms_id(Option<String>)`](crate::operation::describe_terms::builders::DescribeTermsFluentBuilder::set_terms_id):<br>required: **true**<br><p>The ID of the terms documents that you want to describe.</p><br>
7    ///   - [`user_pool_id(impl Into<String>)`](crate::operation::describe_terms::builders::DescribeTermsFluentBuilder::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::operation::describe_terms::builders::DescribeTermsFluentBuilder::set_user_pool_id):<br>required: **true**<br><p>The ID of the user pool that contains the terms documents that you want to describe.</p><br>
8    /// - On success, responds with [`DescribeTermsOutput`](crate::operation::describe_terms::DescribeTermsOutput) with field(s):
9    ///   - [`terms(Option<TermsType>)`](crate::operation::describe_terms::DescribeTermsOutput::terms): <p>A summary of the requested terms documents. Includes a unique identifier for later changes to the terms documents.</p>
10    /// - On failure, responds with [`SdkError<DescribeTermsError>`](crate::operation::describe_terms::DescribeTermsError)
11    pub fn describe_terms(&self) -> crate::operation::describe_terms::builders::DescribeTermsFluentBuilder {
12        crate::operation::describe_terms::builders::DescribeTermsFluentBuilder::new(self.handle.clone())
13    }
14}