list_organizations

WorkMail.Client.list_organizations(**kwargs)

Returns summaries of the customer's organizations.

See also: AWS API Documentation

Request Syntax

response = client.list_organizations(
    NextToken='string',
    MaxResults=123
)

Parameters

• NextToken (string) -- The token to use to retrieve the next page of results. The first call does not contain any tokens.
• MaxResults (integer) -- The maximum number of results to return in a single call.

Return type

dict

Returns

Response Syntax

{
    'OrganizationSummaries': [
        {
            'OrganizationId': 'string',
            'Alias': 'string',
            'DefaultMailDomain': 'string',
            'ErrorMessage': 'string',
            'State': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • OrganizationSummaries (list) --

    The overview of owned organizations presented as a list of organization summaries.

    • (dict) --

      The representation of an organization.

      • OrganizationId (string) --

        The identifier associated with the organization.

      • Alias (string) --

        The alias associated with the organization.

      • DefaultMailDomain (string) --

        The default email domain associated with the organization.

      • ErrorMessage (string) --

        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.

      • State (string) --

        The state associated with the organization.

  • NextToken (string) --

    The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.

Exceptions

• WorkMail.Client.exceptions.InvalidParameterException