IdentityStore / Client / describe_group

describe_group#

IdentityStore.Client.describe_group(**kwargs)#

Retrieves the group metadata and attributes from GroupId in an identity store.

Note

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

See also: AWS API Documentation

Request Syntax

response = client.describe_group(
    IdentityStoreId='string',
    GroupId='string'
)
Parameters:

  • IdentityStoreId (string) –

    [REQUIRED]

    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.

  • GroupId (string) –

    [REQUIRED]

    The identifier for a group in the identity store.

Return type:

dict

Returns:

Response Syntax

{
    'GroupId': 'string',
    'DisplayName': 'string',
    'ExternalIds': [
        {
            'Issuer': 'string',
            'Id': 'string'
        },
    ],
    'Description': 'string',
    'IdentityStoreId': 'string'
}

Response Structure

  • (dict) –

    • GroupId (string) –

      The identifier for a group in the identity store.

    • DisplayName (string) –

      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.

    • ExternalIds (list) –

      A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

      • (dict) –

        The identifier issued to this resource by an external identity provider.

        • Issuer (string) –

          The issuer for an external identifier.

        • Id (string) –

          The identifier issued to this resource by an external identity provider.

    • Description (string) –

      A string containing a description of the group.

    • IdentityStoreId (string) –

      The globally unique identifier for the identity store.

Exceptions