Table Of Contents


User Guide

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

[ aws . workmail ]



Provides more information regarding a given organization based on its identifier.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


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


--organization-id (string)

The identifier for the organization to be described.

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

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


OrganizationId -> (string)

The identifier of an organization.

Alias -> (string)

The alias for an organization.

State -> (string)

The state of an organization.

DirectoryId -> (string)

The identifier for the directory associated with an Amazon WorkMail organization.

DirectoryType -> (string)

The type of directory associated with the Amazon WorkMail organization.

DefaultMailDomain -> (string)

The default mail domain associated with the organization.

CompletedDate -> (timestamp)

The date at which the organization became usable in the Amazon WorkMail context, in UNIX epoch time format.

ErrorMessage -> (string)

The (optional) error message indicating if unexpected behavior was encountered with regards to the organization.