aws_sdk_cognitoidentityprovider/client/
get_group.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 [`GetGroup`](crate::operation::get_group::builders::GetGroupFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`group_name(impl Into<String>)`](crate::operation::get_group::builders::GetGroupFluentBuilder::group_name) / [`set_group_name(Option<String>)`](crate::operation::get_group::builders::GetGroupFluentBuilder::set_group_name):<br>required: **true**<br><p>The name of the group that you want to get information about.</p><br>
7    ///   - [`user_pool_id(impl Into<String>)`](crate::operation::get_group::builders::GetGroupFluentBuilder::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::operation::get_group::builders::GetGroupFluentBuilder::set_user_pool_id):<br>required: **true**<br><p>The ID of the user pool that contains the group that you want to query.</p><br>
8    /// - On success, responds with [`GetGroupOutput`](crate::operation::get_group::GetGroupOutput) with field(s):
9    ///   - [`group(Option<GroupType>)`](crate::operation::get_group::GetGroupOutput::group): <p>A container for the requested group. Includes description, precedence, and IAM role values.</p>
10    /// - On failure, responds with [`SdkError<GetGroupError>`](crate::operation::get_group::GetGroupError)
11    pub fn get_group(&self) -> crate::operation::get_group::builders::GetGroupFluentBuilder {
12        crate::operation::get_group::builders::GetGroupFluentBuilder::new(self.handle.clone())
13    }
14}