Table Of Contents

Feedback

User Guide

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

[ aws . workmail ]

update-primary-email-address

Description

Updates the primary email for an entity. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email) and the email provided in the input is promoted as the primary.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-primary-email-address
--organization-id <value>
--entity-id <value>
--email <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--organization-id (string)

The organization that contains the entity to update.

--entity-id (string)

The entity to update (user, group, or resource).

--email (string)

The value of the email to be updated as primary.

--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 update a primary email address

This example updates the primary email address of the specified entity (user, group, or resource).

Command:

aws workmail update-primary-email-address --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 --entity-id S-1-1-11-1111111111-2222222222-3333333333-3333 --email exampleUser2@site.awsapps.com

Output:

None

Output