WorkMail / Client / describe_organization



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

See also: AWS API Documentation

Request Syntax

response = client.describe_organization(

OrganizationId (string) –


The identifier for the organization to be described.

Return type:



Response Syntax

    'OrganizationId': 'string',
    'Alias': 'string',
    'State': 'string',
    'DirectoryId': 'string',
    'DirectoryType': 'string',
    'DefaultMailDomain': 'string',
    'CompletedDate': datetime(2015, 1, 1),
    'ErrorMessage': 'string',
    'ARN': 'string',
    'MigrationAdmin': 'string',
    'InteroperabilityEnabled': True|False

Response Structure

  • (dict) –

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

    • DirectoryType (string) –

      The type of directory associated with the WorkMail organization.

    • DefaultMailDomain (string) –

      The default mail domain associated with the organization.

    • CompletedDate (datetime) –

      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.

    • MigrationAdmin (string) –

      The user ID of the migration admin if migration is enabled for the organization.

    • InteroperabilityEnabled (boolean) –

      Indicates if interoperability is enabled for this organization.


  • WorkMail.Client.exceptions.InvalidParameterException

  • WorkMail.Client.exceptions.OrganizationNotFoundException