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 access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center 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.

  You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.

• MembershipId (string) –

  [REQUIRED]

  The identifier for a GroupMembership in an identity store.

  You can specify the group membership by ID or by Amazon Resource Name (ARN). For example, membership ID a1b2c3d4-5678-90ab-cdef-EXAMPLE33333 or membership ARN arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333.

Return type:

dict

Returns:

Response Syntax

{
    'IdentityStoreId': 'string',
    'MembershipId': 'string',
    'MembershipArn': 'string',
    'GroupId': 'string',
    'MemberId': {
        'UserId': 'string'
    },
    'CreatedAt': datetime(2015, 1, 1),
    'UpdatedAt': datetime(2015, 1, 1),
    'CreatedBy': 'string',
    'UpdatedBy': '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.

  • MembershipArn (string) –

    The Amazon Resource Name (ARN) of the group membership in the identity store. For example, arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333.

  • 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) –

      The identifier for a user in the identity store.

      You can specify the user by ID or by Amazon Resource Name (ARN). For example, user ID a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 or user ARN arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

  • CreatedAt (datetime) –

    The date and time the group membership was created.

  • UpdatedAt (datetime) –

    The date and time the group membership was last updated.

  • CreatedBy (string) –

    The identifier of the user or system that created the group membership.

  • UpdatedBy (string) –

    The identifier of the user or system that last updated the group membership.

Exceptions

• IdentityStore.Client.exceptions.ResourceNotFoundException

• IdentityStore.Client.exceptions.ThrottlingException

• IdentityStore.Client.exceptions.AccessDeniedException

• IdentityStore.Client.exceptions.InternalServerException

• IdentityStore.Client.exceptions.ValidationException