Amazon WorkMail
API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

OrganizationSummary

The representation of an organization.

Contents

Alias

The alias associated with the organization.

Type: String

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

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

Required: No

ErrorMessage

The error message associated with the organization. It is only present if unexpected behavior has occurred with regards to the organization. It provides insight or solutions regarding unexpected behavior.

Type: String

Length Constraints: Maximum length of 256.

Required: No

OrganizationId

The identifier associated with the organization.

Type: String

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

Required: No

State

The state associated with the organization.

Type: String

Length Constraints: Maximum length of 256.

Required: No

See Also

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

On this page: