Skip to content

InstanceSummary

Source code in docs_src/capo_connect/types/instance_summary.py
class InstanceSummary(TypedDict, closed=True):
    id: NotRequired["capo_connect.types.instance_id.InstanceId"]
    """<p>The identifier of the instance.</p>"""
    arn: NotRequired["capo_connect.types.arn.ARN"]
    """<p>The Amazon Resource Name (ARN) of the instance.</p>"""
    identity_management_type: NotRequired[
        "capo_connect.types.directory_type.DirectoryType"
    ]
    """<p>The identity management type of the instance.</p>"""
    instance_alias: NotRequired["capo_connect.types.directory_alias.DirectoryAlias"]
    """<p>The alias of the instance.</p>"""
    created_time: NotRequired["capo_connect.types.timestamp.Timestamp"]
    """<p>When the instance was created.</p>"""
    service_role: NotRequired["capo_connect.types.arn.ARN"]
    """<p>The service role of the instance.</p>"""
    instance_status: NotRequired["capo_connect.types.instance_status.InstanceStatus"]
    """<p>The state of the instance.</p>"""
    inbound_calls_enabled: NotRequired[
        "capo_connect.types.inbound_calls_enabled.InboundCallsEnabled"
    ]
    """<p>Whether inbound calls are enabled.</p>"""
    outbound_calls_enabled: NotRequired[
        "capo_connect.types.outbound_calls_enabled.OutboundCallsEnabled"
    ]
    """<p>Whether outbound calls are enabled.</p>"""
    instance_access_url: NotRequired["capo_connect.types.url.Url"]
    """<p>This URL allows contact center users to access the Connect Customer admin website.</p>"""

arn instance-attribute

arn: NotRequired[ARN]

The Amazon Resource Name (ARN) of the instance.

created_time instance-attribute

created_time: NotRequired[Timestamp]

When the instance was created.

id instance-attribute

id: NotRequired[InstanceId]

The identifier of the instance.

identity_management_type instance-attribute

identity_management_type: NotRequired[DirectoryType]

The identity management type of the instance.

inbound_calls_enabled instance-attribute

inbound_calls_enabled: NotRequired[InboundCallsEnabled]

Whether inbound calls are enabled.

instance_access_url instance-attribute

instance_access_url: NotRequired[Url]

This URL allows contact center users to access the Connect Customer admin website.

instance_alias instance-attribute

instance_alias: NotRequired[DirectoryAlias]

The alias of the instance.

instance_status instance-attribute

instance_status: NotRequired[InstanceStatus]

The state of the instance.

outbound_calls_enabled instance-attribute

outbound_calls_enabled: NotRequired[OutboundCallsEnabled]

Whether outbound calls are enabled.

service_role instance-attribute

service_role: NotRequired[ARN]

The service role of the instance.