Table Of Contents

Feedback

User Guide

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

[ aws . workmail ]

register-to-work-mail

Description

Registers an existing and disabled user, group, or resource/entity for Amazon WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the entity is enabled and fails if the entity is deleted. This operation results in the accumulation of costs. For more information, see Pricing . The equivalent console functionality for this operation is Enable . Users can either be created by calling the CreateUser API or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  register-to-work-mail
--organization-id <value>
--entity-id <value>
--email <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--organization-id (string)

The identifier for the organization under which the Amazon WorkMail entity exists.

--entity-id (string)

The identifier for the entity to be updated.

--email (string)

The email for the entity to be updated.

--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 register an existing or disabled entity

This example enables an existing entity (user, group, or resource) to use Amazon WorkMail.

Command:

aws workmail register-to-work-mail --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 --entity-id S-1-1-11-1122222222-2222233333-3333334444-4444 --email exampleGroup1@site.awsapps.com

Output:

None

Output