v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14198281.1 KB

Retrieves the group metadata and attributes from <code>GroupId</code> in an identity store.

post/#X-Amz-Target=AWSIdentityStore.DescribeGroup

Headers

X-Amz-Target'AWSIdentityStore.DescribeGroup' required

Request body

IdentityStoreIdstring required

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.

GroupIdstring required

The identifier for a group in the identity store.

Response

Success

GroupIdstring required

The identifier for a group in the identity store.

DisplayNamestring password

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.

Descriptionstring password

A string containing a description of the group.

IdentityStoreIdstring required

The globally unique identifier for the identity store.