IdentityStore / Client / describe_group_membership

describe_group_membership#

IdentityStore.Client.describe_group_membership(**kwargs)#

Retrieves membership metadata and attributes from MembershipId 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_membership(
    IdentityStoreId='string',
    MembershipId='string'
)
Parameters:

  • IdentityStoreId (string) –

    [REQUIRED]

    The globally unique identifier for the identity store.

  • MembershipId (string) –

    [REQUIRED]

    The identifier for a GroupMembership in an identity store.

Return type:

dict

Returns:

Response Syntax

{
    'IdentityStoreId': 'string',
    'MembershipId': 'string',
    'GroupId': 'string',
    'MemberId': {
        'UserId': 'string'
    }
}

Response Structure

  • (dict) –

    • IdentityStoreId (string) –

      The globally unique identifier for the identity store.

    • MembershipId (string) –

      The identifier for a GroupMembership in an identity store.

    • GroupId (string) –

      The identifier for a group in the identity store.

    • MemberId (dict) –

      An object containing the identifier of a group member.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: UserId. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • UserId (string) –

        An object containing the identifiers of resources that can be members.

Exceptions

  • IdentityStore.Client.exceptions.ResourceNotFoundException

  • IdentityStore.Client.exceptions.ThrottlingException

  • IdentityStore.Client.exceptions.AccessDeniedException

  • IdentityStore.Client.exceptions.InternalServerException

  • IdentityStore.Client.exceptions.ValidationException