WorkMail / Client / associate_member_to_group

associate_member_to_group#

WorkMail.Client.associate_member_to_group(**kwargs)#

Adds a member (user or group) to the group’s set.

See also: AWS API Documentation

Request Syntax

response = client.associate_member_to_group(
    OrganizationId='string',
    GroupId='string',
    MemberId='string'
)
Parameters:
  • OrganizationId (string) –

    [REQUIRED]

    The organization under which the group exists.

  • GroupId (string) –

    [REQUIRED]

    The group to which the member (user or group) is associated.

    The identifier can accept GroupId, Groupname, or email. The following identity formats are available:

    • Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: group@domain.tld

    • Group name: group

  • MemberId (string) –

    [REQUIRED]

    The member (user or group) to associate to the group.

    The member ID can accept UserID or GroupId, Username or Groupname, or email.

    • Member: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: member@domain.tld

    • Member name: member

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • WorkMail.Client.exceptions.DirectoryServiceAuthenticationFailedException

  • WorkMail.Client.exceptions.DirectoryUnavailableException

  • WorkMail.Client.exceptions.EntityNotFoundException

  • WorkMail.Client.exceptions.EntityStateException

  • WorkMail.Client.exceptions.InvalidParameterException

  • WorkMail.Client.exceptions.OrganizationNotFoundException

  • WorkMail.Client.exceptions.OrganizationStateException

  • WorkMail.Client.exceptions.UnsupportedOperationException