Skip to content

UpdateContactRequest

Source code in docs_src/capo_connect/types/update_contact_request.py
class UpdateContactRequest(TypedDict, closed=True):
    instance_id: "capo_connect.types.instance_id.InstanceId"
    """<p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>"""
    contact_id: "capo_connect.types.contact_id.ContactId"
    """<p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.</p>"""
    name: NotRequired["capo_connect.types.name.Name"]
    """<p>The name of the contact.</p>"""
    description: NotRequired["capo_connect.types.description.Description"]
    """<p>The description of the contact.</p>"""
    references: NotRequired["capo_connect.types.contact_references.ContactReferences"]
    """<p>Well-formed data on contact, shown to agents on Contact Control Panel (CCP).</p>"""
    segment_attributes: NotRequired[
        "capo_connect.types.segment_attributes.SegmentAttributes"
    ]
    """<p>A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Connect Customer attributes. They can be accessed in flows.</p> <p>Attribute keys can include only alphanumeric, -, and _.</p> <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p> <p>Contact Expiry, and user-defined attributes (String - String) that are defined in predefined attributes, can be updated by using the UpdateContact API.</p>"""
    queue_info: NotRequired["capo_connect.types.queue_info_input.QueueInfoInput"]
    """<p> Information about the queue associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Connect Customer Contact Lens integration</a> in the <i> Connect Customer Administrator Guide</i>.</p>"""
    user_info: NotRequired["capo_connect.types.user_info.UserInfo"]
    """<p>Information about the agent associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Connect Customer Contact Lens integration</a> in the <i> Connect Customer Administrator Guide</i>.</p>"""
    customer_endpoint: NotRequired["capo_connect.types.endpoint.Endpoint"]
    """<p>The endpoint of the customer for which the contact was initiated. For external audio contacts, this is usually the end customer's phone number. This value can only be updated for external audio contacts. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Connect Customer Contact Lens integration</a> in the <i>Connect Customer Administrator Guide</i>.</p>"""
    system_endpoint: NotRequired["capo_connect.types.endpoint.Endpoint"]
    """<p>External system endpoint for the contact was initiated. For external audio contacts, this is the phone number of the external system such as the contact center. This value can only be updated for external audio contacts. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Connect Customer Contact Lens integration</a> in the <i>Connect Customer Administrator Guide</i>.</p>"""

contact_id instance-attribute

contact_id: ContactId

The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.

customer_endpoint instance-attribute

customer_endpoint: NotRequired[Endpoint]

The endpoint of the customer for which the contact was initiated. For external audio contacts, this is usually the end customer's phone number. This value can only be updated for external audio contacts. For more information, see Connect Customer Contact Lens integration in the Connect Customer Administrator Guide.

description instance-attribute

description: NotRequired[Description]

The description of the contact.

instance_id instance-attribute

instance_id: InstanceId

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

name instance-attribute

name: NotRequired[Name]

The name of the contact.

queue_info instance-attribute

queue_info: NotRequired[QueueInfoInput]

Information about the queue associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Connect Customer Contact Lens integration in the Connect Customer Administrator Guide.

references instance-attribute

references: NotRequired[ContactReferences]

Well-formed data on contact, shown to agents on Contact Control Panel (CCP).

segment_attributes instance-attribute

segment_attributes: NotRequired[SegmentAttributes]

A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Connect Customer attributes. They can be accessed in flows.

Attribute keys can include only alphanumeric, -, and _.

This field can be used to show channel subtype, such as connect:Guide.

Contact Expiry, and user-defined attributes (String - String) that are defined in predefined attributes, can be updated by using the UpdateContact API.

system_endpoint instance-attribute

system_endpoint: NotRequired[Endpoint]

External system endpoint for the contact was initiated. For external audio contacts, this is the phone number of the external system such as the contact center. This value can only be updated for external audio contacts. For more information, see Connect Customer Contact Lens integration in the Connect Customer Administrator Guide.

user_info instance-attribute

user_info: NotRequired[UserInfo]

Information about the agent associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Connect Customer Contact Lens integration in the Connect Customer Administrator Guide.