Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1480317256.9 KB

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

post/#X-Amz-Target=WorkMailService.DescribeOrganization

Headers

X-Amz-Target'WorkMailService.DescribeOrganization' required

Request body

OrganizationIdstring required

The identifier for the organization to be described.

Response

Success

OrganizationIdstring

The identifier of an organization.

Aliasstring

The alias for an organization.

Statestring

The state of an organization.

DirectoryIdstring

The identifier for the directory associated with an WorkMail organization.

DirectoryTypestring

The type of directory associated with the WorkMail organization.

DefaultMailDomainstring

The default mail domain associated with the organization.

CompletedDatestring date-time

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

ErrorMessagestring

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

ARNstring

The Amazon Resource Name (ARN) of the organization.