Skip to content

DescribeResourceResponse

Source code in docs_src/capo_workmail/types/describe_resource_response.py
class DescribeResourceResponse(TypedDict, closed=True):
    resource_id: NotRequired["capo_workmail.types.resource_id.ResourceId"]
    """<p>The identifier of the described resource.</p>"""
    email: NotRequired["capo_workmail.types.email_address.EmailAddress"]
    """<p>The email of the described resource.</p>"""
    name: NotRequired["capo_workmail.types.resource_name.ResourceName"]
    """<p>The name of the described resource.</p>"""
    type: NotRequired["capo_workmail.types.resource_type.ResourceType"]
    """<p>The type of the described resource.</p>"""
    booking_options: NotRequired["capo_workmail.types.booking_options.BookingOptions"]
    """<p>The booking options for the described resource.</p>"""
    state: NotRequired["capo_workmail.types.entity_state.EntityState"]
    """<p>The state of the resource: enabled (registered to WorkMail), disabled (deregistered or never registered to WorkMail), or deleted.</p>"""
    enabled_date: NotRequired["capo_workmail.types.timestamp.Timestamp"]
    """<p>The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.</p>"""
    disabled_date: NotRequired["capo_workmail.types.timestamp.Timestamp"]
    """<p>The date and time when a resource was disabled from WorkMail, in UNIX epoch time format.</p>"""
    description: NotRequired[
        "capo_workmail.types.resource_description.ResourceDescription"
    ]
    """<p>Description of the resource.</p>"""
    hidden_from_global_address_list: "capo_workmail.types.boolean.Boolean"
    """<p>If enabled, the resource is hidden from the global address list.</p>"""

booking_options instance-attribute

booking_options: NotRequired[BookingOptions]

The booking options for the described resource.

description instance-attribute

description: NotRequired[ResourceDescription]

Description of the resource.

disabled_date instance-attribute

disabled_date: NotRequired[Timestamp]

The date and time when a resource was disabled from WorkMail, in UNIX epoch time format.

email instance-attribute

email: NotRequired[EmailAddress]

The email of the described resource.

enabled_date instance-attribute

enabled_date: NotRequired[Timestamp]

The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.

hidden_from_global_address_list instance-attribute

hidden_from_global_address_list: Boolean

If enabled, the resource is hidden from the global address list.

name instance-attribute

name: NotRequired[ResourceName]

The name of the described resource.

resource_id instance-attribute

resource_id: NotRequired[ResourceId]

The identifier of the described resource.

state instance-attribute

state: NotRequired[EntityState]

The state of the resource: enabled (registered to WorkMail), disabled (deregistered or never registered to WorkMail), or deleted.

type instance-attribute

type: NotRequired[ResourceType]

The type of the described resource.