Table Of Contents

Feedback

User Guide

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

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . workmail ]

create-alias

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

Options

--organization-id (string)

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

--entity-id (string)

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

--alias (string)

The alias to add to the member 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 create an alias

The following create-alias command creates an alias for the specified entity (user or group).

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

This command produces no output.

Output

None