list_aliases

WorkMail.Client.list_aliases(**kwargs)

Creates a paginated call to list the aliases associated with a given entity.

See also: AWS API Documentation

Request Syntax

response = client.list_aliases(
    OrganizationId='string',
    EntityId='string',
    NextToken='string',
    MaxResults=123
)

Parameters

• OrganizationId (string) --

  [REQUIRED]

  The identifier for the organization under which the entity exists.

• EntityId (string) --

  [REQUIRED]

  The identifier for the entity for which to list the aliases.

• NextToken (string) -- The token to use to retrieve the next page of results. The first call does not contain any tokens.
• MaxResults (integer) -- The maximum number of results to return in a single call.

Return type

dict

Returns

Response Syntax

{
    'Aliases': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Aliases (list) --

    The entity's paginated aliases.

    • (string) --

  • NextToken (string) --

    The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.

Exceptions

• WorkMail.Client.exceptions.EntityNotFoundException
• WorkMail.Client.exceptions.EntityStateException
• WorkMail.Client.exceptions.InvalidParameterException
• WorkMail.Client.exceptions.OrganizationNotFoundException
• WorkMail.Client.exceptions.OrganizationStateException