| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.IdentityStore.DescribeGroup
Description
Retrieves the group metadata and attributes from GroupId in an
identity store.
Synopsis
- data DescribeGroup = DescribeGroup' {
- identityStoreId :: Text
- groupId :: Text
- newDescribeGroup :: Text -> Text -> DescribeGroup
- describeGroup_identityStoreId :: Lens' DescribeGroup Text
- describeGroup_groupId :: Lens' DescribeGroup Text
- data DescribeGroupResponse = DescribeGroupResponse' {
- description :: Maybe (Sensitive Text)
- displayName :: Maybe (Sensitive Text)
- externalIds :: Maybe (NonEmpty ExternalId)
- httpStatus :: Int
- groupId :: Text
- identityStoreId :: Text
- newDescribeGroupResponse :: Int -> Text -> Text -> DescribeGroupResponse
- describeGroupResponse_description :: Lens' DescribeGroupResponse (Maybe Text)
- describeGroupResponse_displayName :: Lens' DescribeGroupResponse (Maybe Text)
- describeGroupResponse_externalIds :: Lens' DescribeGroupResponse (Maybe (NonEmpty ExternalId))
- describeGroupResponse_httpStatus :: Lens' DescribeGroupResponse Int
- describeGroupResponse_groupId :: Lens' DescribeGroupResponse Text
- describeGroupResponse_identityStoreId :: Lens' DescribeGroupResponse Text
Creating a Request
data DescribeGroup Source #
See: newDescribeGroup smart constructor.
Constructors
| DescribeGroup' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DescribeGroup |
Create a value of DescribeGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeGroup, describeGroup_identityStoreId - The globally unique identifier for the identity store, such as
d-1234567890. In this example, d- is a fixed prefix, and
1234567890 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.
DescribeGroup, describeGroup_groupId - The identifier for a group in the identity store.
Request Lenses
describeGroup_identityStoreId :: Lens' DescribeGroup Text Source #
The globally unique identifier for the identity store, such as
d-1234567890. In this example, d- is a fixed prefix, and
1234567890 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.
describeGroup_groupId :: Lens' DescribeGroup Text Source #
The identifier for a group in the identity store.
Destructuring the Response
data DescribeGroupResponse Source #
See: newDescribeGroupResponse smart constructor.
Constructors
| DescribeGroupResponse' | |
Fields
| |
Instances
newDescribeGroupResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> DescribeGroupResponse |
Create a value of DescribeGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeGroupResponse, describeGroupResponse_description - A string containing a description of the group.
DescribeGroupResponse, describeGroupResponse_displayName - 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.
DescribeGroupResponse, describeGroupResponse_externalIds - A list of ExternalId objects that contains the identifiers issued to
this resource by an external identity provider.
$sel:httpStatus:DescribeGroupResponse', describeGroupResponse_httpStatus - The response's http status code.
DescribeGroup, describeGroupResponse_groupId - The identifier for a group in the identity store.
DescribeGroup, describeGroupResponse_identityStoreId - The globally unique identifier for the identity store.
Response Lenses
describeGroupResponse_description :: Lens' DescribeGroupResponse (Maybe Text) Source #
A string containing a description of the group.
describeGroupResponse_displayName :: Lens' DescribeGroupResponse (Maybe Text) Source #
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.
describeGroupResponse_externalIds :: Lens' DescribeGroupResponse (Maybe (NonEmpty ExternalId)) Source #
A list of ExternalId objects that contains the identifiers issued to
this resource by an external identity provider.
describeGroupResponse_httpStatus :: Lens' DescribeGroupResponse Int Source #
The response's http status code.
describeGroupResponse_groupId :: Lens' DescribeGroupResponse Text Source #
The identifier for a group in the identity store.
describeGroupResponse_identityStoreId :: Lens' DescribeGroupResponse Text Source #
The globally unique identifier for the identity store.