WorkMail / Client / delete_alias

delete_alias#

WorkMail.Client.delete_alias(**kwargs)#

Remove one or more specified aliases from a set of aliases for a given user.

Request Syntax

response = client.delete_alias(
    OrganizationId='string',
    EntityId='string',
    Alias='string'
)

Parameters:

OrganizationId (string) –
[REQUIRED]

The identifier for the organization under which the user exists.
EntityId (string) –
[REQUIRED]

The identifier for the member (user or group) from which to have the aliases removed.
Alias (string) –
[REQUIRED]

The aliases to be removed from the user’s set of aliases. Duplicate entries in the list are collapsed into single entries (the list is transformed into a set).

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

Exceptions