aws_sdk_identitystore/client/
describe_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 [`DescribeGroup`](crate::operation::describe_group::builders::DescribeGroupFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`identity_store_id(impl Into<String>)`](crate::operation::describe_group::builders::DescribeGroupFluentBuilder::identity_store_id) / [`set_identity_store_id(Option<String>)`](crate::operation::describe_group::builders::DescribeGroupFluentBuilder::set_identity_store_id):<br>required: **true**<br><p>The globally unique identifier for the identity store, such as <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and <code>1234567890</code> is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.</p><br>
7    ///   - [`group_id(impl Into<String>)`](crate::operation::describe_group::builders::DescribeGroupFluentBuilder::group_id) / [`set_group_id(Option<String>)`](crate::operation::describe_group::builders::DescribeGroupFluentBuilder::set_group_id):<br>required: **true**<br><p>The identifier for a group in the identity store.</p><br>
8    /// - On success, responds with [`DescribeGroupOutput`](crate::operation::describe_group::DescribeGroupOutput) with field(s):
9    ///   - [`group_id(String)`](crate::operation::describe_group::DescribeGroupOutput::group_id): <p>The identifier for a group in the identity store.</p>
10    ///   - [`display_name(Option<String>)`](crate::operation::describe_group::DescribeGroupOutput::display_name): <p>The group’s display name value. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time that the group is created and stored as an attribute of the group object in the identity store.</p>
11    ///   - [`external_ids(Option<Vec::<ExternalId>>)`](crate::operation::describe_group::DescribeGroupOutput::external_ids): <p>A list of <code>ExternalId</code> objects that contains the identifiers issued to this resource by an external identity provider.</p>
12    ///   - [`description(Option<String>)`](crate::operation::describe_group::DescribeGroupOutput::description): <p>A string containing a description of the group.</p>
13    ///   - [`created_at(Option<DateTime>)`](crate::operation::describe_group::DescribeGroupOutput::created_at): <p>The date and time the group was created.</p>
14    ///   - [`updated_at(Option<DateTime>)`](crate::operation::describe_group::DescribeGroupOutput::updated_at): <p>The date and time the group was last updated.</p>
15    ///   - [`created_by(Option<String>)`](crate::operation::describe_group::DescribeGroupOutput::created_by): <p>The identifier of the user or system that created the group.</p>
16    ///   - [`updated_by(Option<String>)`](crate::operation::describe_group::DescribeGroupOutput::updated_by): <p>The identifier of the user or system that last updated the group.</p>
17    ///   - [`identity_store_id(String)`](crate::operation::describe_group::DescribeGroupOutput::identity_store_id): <p>The globally unique identifier for the identity store.</p>
18    /// - On failure, responds with [`SdkError<DescribeGroupError>`](crate::operation::describe_group::DescribeGroupError)
19    pub fn describe_group(&self) -> crate::operation::describe_group::builders::DescribeGroupFluentBuilder {
20        crate::operation::describe_group::builders::DescribeGroupFluentBuilder::new(self.handle.clone())
21    }
22}
aws_sdk_identitystore/client/describe_group.rs

aws_sdk_identitystore/client/
describe_group.rs
