Skip to content

MonitorContactRequest

Source code in docs_src/capo_connect/types/monitor_contact_request.py
class MonitorContactRequest(TypedDict, closed=True):
    instance_id: "capo_connect.types.instance_id.InstanceId"
    """<p>The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance.</p>"""
    contact_id: "capo_connect.types.contact_id.ContactId"
    """<p>The identifier of the contact.</p>"""
    user_id: "capo_connect.types.agent_resource_id.AgentResourceId"
    """<p>The identifier of the user account.</p>"""
    allowed_monitor_capabilities: NotRequired[
        "capo_connect.types.allowed_monitor_capabilities.AllowedMonitorCapabilities"
    ]
    """<p>Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge. AllowedMonitorCapabilities is required if barge is enabled.</p>"""
    client_token: NotRequired["capo_connect.types.client_token.ClientToken"]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>"""

allowed_monitor_capabilities instance-attribute

allowed_monitor_capabilities: NotRequired[AllowedMonitorCapabilities]

Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge. AllowedMonitorCapabilities is required if barge is enabled.

client_token instance-attribute

client_token: NotRequired[ClientToken]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

contact_id instance-attribute

contact_id: ContactId

The identifier of the contact.

instance_id instance-attribute

instance_id: InstanceId

The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance.

user_id instance-attribute

user_id: AgentResourceId

The identifier of the user account.