Skip to content

DescribeOrganizationResponse

Source code in docs_src/capo_workmail/types/describe_organization_response.py
class DescribeOrganizationResponse(TypedDict, closed=True):
    organization_id: NotRequired["capo_workmail.types.organization_id.OrganizationId"]
    """<p>The identifier of an organization.</p>"""
    alias: NotRequired["capo_workmail.types.organization_name.OrganizationName"]
    """<p>The alias for an organization.</p>"""
    state: NotRequired["capo_workmail.types.string.String"]
    """<p>The state of an organization.</p>"""
    directory_id: NotRequired["capo_workmail.types.string.String"]
    """<p>The identifier for the directory associated with an WorkMail organization.</p>"""
    directory_type: NotRequired["capo_workmail.types.string.String"]
    """<p>The type of directory associated with the WorkMail organization.</p>"""
    default_mail_domain: NotRequired["capo_workmail.types.string.String"]
    """<p>The default mail domain associated with the organization.</p>"""
    completed_date: NotRequired["capo_workmail.types.timestamp.Timestamp"]
    """<p>The date at which the organization became usable in the WorkMail context, in UNIX epoch time format.</p>"""
    error_message: NotRequired["capo_workmail.types.string.String"]
    """<p>(Optional) The error message indicating if unexpected behavior was encountered with regards to the organization.</p>"""
    arn: NotRequired["capo_workmail.types.amazon_resource_name.AmazonResourceName"]
    """<p>The Amazon Resource Name (ARN) of the organization.</p>"""
    migration_admin: NotRequired[
        "capo_workmail.types.work_mail_identifier.WorkMailIdentifier"
    ]
    """<p>The user ID of the migration admin if migration is enabled for the organization.</p>"""
    interoperability_enabled: "capo_workmail.types.boolean.Boolean"
    """<p>Indicates if interoperability is enabled for this organization.</p>"""

alias instance-attribute

alias: NotRequired[OrganizationName]

The alias for an organization.

arn instance-attribute

arn: NotRequired[AmazonResourceName]

The Amazon Resource Name (ARN) of the organization.

completed_date instance-attribute

completed_date: NotRequired[Timestamp]

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

default_mail_domain instance-attribute

default_mail_domain: NotRequired[String]

The default mail domain associated with the organization.

directory_id instance-attribute

directory_id: NotRequired[String]

The identifier for the directory associated with an WorkMail organization.

directory_type instance-attribute

directory_type: NotRequired[String]

The type of directory associated with the WorkMail organization.

error_message instance-attribute

error_message: NotRequired[String]

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

interoperability_enabled instance-attribute

interoperability_enabled: Boolean

Indicates if interoperability is enabled for this organization.

migration_admin instance-attribute

migration_admin: NotRequired[WorkMailIdentifier]

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

organization_id instance-attribute

organization_id: NotRequired[OrganizationId]

The identifier of an organization.

state instance-attribute

state: NotRequired[String]

The state of an organization.