[ 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 | --cli-input-yaml]
[--generate-cli-skeleton <value>]


--organization-id (string)

The identifier for the organization to be described.

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


To retrieve information for an organization

The following describe-organization command retrieves information for the specified Amazon WorkMail organization.

aws workmail describe-organization \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27


    "OrganizationId": "m-d281d0a2fd824be5b6cd3d3ce909fd27",
    "Alias": "alias",
    "State": "Active",
    "DirectoryId": "d-926726012c",
    "DirectoryType": "VpcDirectory",
    "DefaultMailDomain": "site.awsapps.com",
    "CompletedDate": 1522693605.468,
    "ARN": "arn:aws:workmail:us-west-2:111122223333:organization/m-n1pq2345678r901st2u3vx45x6789yza"

For more information, see Working with Organizations in the Amazon WorkMail Administrator Guide.


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

DefaultMailDomain -> (string)

The default mail domain associated with the organization.

CompletedDate -> (timestamp)

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

ErrorMessage -> (string)

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

ARN -> (string)

The Amazon Resource Name (ARN) of the organization.