create_alias

create_alias(**kwargs)

Adds an alias to the set of a given member (user or group) of WorkMail.

See also: AWS API Documentation

Request Syntax

response = client.create_alias(
    OrganizationId='string',
    EntityId='string',
    Alias='string'
)
Parameters
  • OrganizationId (string) --

    [REQUIRED]

    The organization under which the member (user or group) exists.

  • EntityId (string) --

    [REQUIRED]

    The member (user or group) to which this alias is added.

  • Alias (string) --

    [REQUIRED]

    The alias to add to the member set.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • WorkMail.Client.exceptions.EmailAddressInUseException
  • WorkMail.Client.exceptions.EntityNotFoundException
  • WorkMail.Client.exceptions.EntityStateException
  • WorkMail.Client.exceptions.InvalidParameterException
  • WorkMail.Client.exceptions.MailDomainNotFoundException
  • WorkMail.Client.exceptions.MailDomainStateException
  • WorkMail.Client.exceptions.OrganizationNotFoundException
  • WorkMail.Client.exceptions.OrganizationStateException
  • WorkMail.Client.exceptions.LimitExceededException