IdentityStore / Client / create_group_membership

create_group_membership#

IdentityStore.Client.create_group_membership(**kwargs)#

Creates a relationship between a member and a group. The following identifiers must be specified: GroupId, IdentityStoreId, and MemberId.

See also: AWS API Documentation

Request Syntax

response = client.create_group_membership(
    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 newly created GroupMembership in an identity store.

    • IdentityStoreId (string) –

      The globally unique identifier for the identity store.

Exceptions