Skip to content

Reference

Source code in docs_src/capo_connect/types/reference.py
class Reference(TypedDict, closed=True):
    value: "capo_connect.types.reference_value.ReferenceValue"
    """<p>A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).</p>"""
    type: "capo_connect.types.reference_type.ReferenceType"
    """<p>The type of the reference. <code>DATE</code> must be of type Epoch timestamp. </p>"""
    status: NotRequired["capo_connect.types.reference_status.ReferenceStatus"]
    """<p>Status of the attachment reference type.</p>"""
    arn: NotRequired["capo_connect.types.reference_arn.ReferenceArn"]
    """<p>The Amazon Resource Name (ARN) of the reference</p>"""
    status_reason: NotRequired[
        "capo_connect.types.reference_status_reason.ReferenceStatusReason"
    ]
    """<p>Relevant details why the reference was not successfully created.</p>"""

arn instance-attribute

arn: NotRequired[ReferenceArn]

The Amazon Resource Name (ARN) of the reference

status instance-attribute

status: NotRequired[ReferenceStatus]

Status of the attachment reference type.

status_reason instance-attribute

status_reason: NotRequired[ReferenceStatusReason]

Relevant details why the reference was not successfully created.

type instance-attribute

The type of the reference. DATE must be of type Epoch timestamp.

value instance-attribute

A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).