Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . workmail ]

delete-alias

Description

Remove the alias from a set of aliases for a given user.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  delete-alias
--organization-id <value>
--entity-id <value>
--alias <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--organization-id (string)

The identifier for the organization under which the user exists.

--entity-id (string)

The identifier for the Amazon WorkMail entity to have the aliases removed.

--alias (string)

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).

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To delete an alias

This example deletes the alias for the specified entity (user or group).

Command:

aws workmail delete-alias --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 --entity-id S-1-1-11-1122222222-2222233333-3333334444-4444 --alias exampleAlias@site.awsapps.com

Output:

None

Output