[ aws . workmail ]

create-user

Description

Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-user
--organization-id <value>
--name <value>
--display-name <value>
--password <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--organization-id (string)

The identifier of the organization for which the user is created.

--name (string)

The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a maximum length of 20.

--display-name (string)

The display name for the new user.

--password (string)

The password for the new user.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To create a new user

The following create-user command creates a new user.

aws workmail create-user \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --name exampleName \
    --display-name exampleDisplayName \
    --password examplePa$$w0rd

Output:

{
    "UserId": "S-1-1-11-1111111111-2222222222-3333333333-3333"
}

Output

UserId -> (string)

The identifier for the new user.