| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
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' {
- httpStatus :: Int
- groupId :: Text
- displayName :: Text
- newDescribeGroupResponse :: Int -> Text -> Text -> DescribeGroupResponse
- describeGroupResponse_httpStatus :: Lens' DescribeGroupResponse Int
- describeGroupResponse_groupId :: Lens' DescribeGroupResponse Text
- describeGroupResponse_displayName :: 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:
$sel:identityStoreId: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 number and
lower case letters. This value is generated at the time that a new
identity store is created.
$sel:groupId: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 number 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:
$sel:httpStatus:DescribeGroupResponse', describeGroupResponse_httpStatus - The response's http status code.
$sel:groupId:DescribeGroup', describeGroupResponse_groupId - The identifier for a group in the identity store.
$sel:displayName:DescribeGroupResponse', describeGroupResponse_displayName - Contains 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. The characters <>;:% are
excluded. 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.
Response Lenses
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_displayName :: Lens' DescribeGroupResponse Text Source #
Contains 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. The characters <>;:% are
excluded. 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.