IdentityStore / Client / get_group_membership_id

get_group_membership_id

IdentityStore.Client.get_group_membership_id(**kwargs)

Retrieves the 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.get_group_membership_id(
    IdentityStoreId='string',
    GroupId='string',
    MemberId={
        'UserId': 'string'
    }
)
Parameters:
  • IdentityStoreId (string) –

    [REQUIRED]

    The globally unique identifier for the identity store.

  • GroupId (string) –

    [REQUIRED]

    The identifier for a group in the identity store.

  • MemberId (dict) –

    [REQUIRED]

    An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: UserId.

    • UserId (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'MembershipId': 'string',
    'IdentityStoreId': 'string'
}

Response Structure

  • (dict) –

    • MembershipId (string) –

      The identifier for a GroupMembership in an identity store.

    • IdentityStoreId (string) –

      The globally unique identifier for the identity store.

Exceptions

  • IdentityStore.Client.exceptions.ResourceNotFoundException

  • IdentityStore.Client.exceptions.ThrottlingException

  • IdentityStore.Client.exceptions.AccessDeniedException

  • IdentityStore.Client.exceptions.InternalServerException

  • IdentityStore.Client.exceptions.ValidationException