Menu
Amazon WorkMail
API Reference (API Version 2017-10-01)

DescribeOrganization

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

Request Syntax

{ "OrganizationId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

OrganizationId

The identifier for the organization to be described.

Type: String

Pattern: ^m-[0-9a-f]{32}$

Required: Yes

Response Syntax

{ "Alias": "string", "CompletedDate": number, "DefaultMailDomain": "string", "DirectoryId": "string", "DirectoryType": "string", "ErrorMessage": "string", "OrganizationId": "string", "State": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Alias

The alias for an organization.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 62.

Pattern: ^(?!d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*

CompletedDate

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

Type: Timestamp

DefaultMailDomain

The default mail domain associated with the organization.

Type: String

Length Constraints: Maximum length of 256.

DirectoryId

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

Type: String

Length Constraints: Maximum length of 256.

DirectoryType

The type of directory associated with the WorkMail organization.

Type: String

Length Constraints: Maximum length of 256.

ErrorMessage

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

Type: String

Length Constraints: Maximum length of 256.

OrganizationId

The identifier of an organization.

Type: String

Pattern: ^m-[0-9a-f]{32}$

State

The state of an organization.

Type: String

Length Constraints: Maximum length of 256.

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterException

One or more of the input parameters don't match the service's restrictions.

HTTP Status Code: 400

OrganizationNotFoundException

An operation received a valid organization identifier that either doesn't belong or exist in the system.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: