aws_sdk_cognitoidentityprovider/client/
describe_user_pool.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 [`DescribeUserPool`](crate::operation::describe_user_pool::builders::DescribeUserPoolFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`user_pool_id(impl Into<String>)`](crate::operation::describe_user_pool::builders::DescribeUserPoolFluentBuilder::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::operation::describe_user_pool::builders::DescribeUserPoolFluentBuilder::set_user_pool_id):<br>required: **true**<br><p>The ID of the user pool you want to describe.</p><br>
7    /// - On success, responds with [`DescribeUserPoolOutput`](crate::operation::describe_user_pool::DescribeUserPoolOutput) with field(s):
8    ///   - [`user_pool(Option<UserPoolType>)`](crate::operation::describe_user_pool::DescribeUserPoolOutput::user_pool): <p>The details of the requested user pool.</p>
9    /// - On failure, responds with [`SdkError<DescribeUserPoolError>`](crate::operation::describe_user_pool::DescribeUserPoolError)
10    pub fn describe_user_pool(&self) -> crate::operation::describe_user_pool::builders::DescribeUserPoolFluentBuilder {
11        crate::operation::describe_user_pool::builders::DescribeUserPoolFluentBuilder::new(self.handle.clone())
12    }
13}