Amazon Connect Service

Removes the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.

See also: AWS API Documentation

Request Syntax

client.untag_contact(
    ContactId='string',
    InstanceId='string',
    TagKeys=[
        'string',
    ]
)

type ContactId

string

param ContactId

[REQUIRED]

The identifier of the contact in this instance of Amazon Connect.

type InstanceId

string

param InstanceId

[REQUIRED]

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

type TagKeys

list

param TagKeys

[REQUIRED]

A list of tag keys. Existing tags on the contact whose keys are members of this list will be removed.

• (string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --

Adds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.

See also: AWS API Documentation

Request Syntax

client.tag_contact(
    ContactId='string',
    InstanceId='string',
    Tags={
        'string': 'string'
    }
)

type ContactId

string

param ContactId

[REQUIRED]

The identifier of the contact in this instance of Amazon Connect.

type InstanceId

string

param InstanceId

[REQUIRED]

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

type Tags

dict

param Tags

[REQUIRED]

The tags to be assigned to the contact resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

Note

Authorization is not supported by this tag.

• (string) --

  • (string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --

{'Contact': {'Tags': {'string': 'string'}}}

This API is in preview release for Amazon Connect and is subject to change.

Describes the specified contact.

See also: AWS API Documentation

Request Syntax

client.describe_contact(
    InstanceId='string',
    ContactId='string'
)

type InstanceId

string

param InstanceId

[REQUIRED]

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

type ContactId

string

param ContactId

[REQUIRED]

The identifier of the contact.

rtype

dict

returns

Response Syntax

{
    'Contact': {
        'Arn': 'string',
        'Id': 'string',
        'InitialContactId': 'string',
        'PreviousContactId': 'string',
        'InitiationMethod': 'INBOUND'|'OUTBOUND'|'TRANSFER'|'QUEUE_TRANSFER'|'CALLBACK'|'API'|'DISCONNECT'|'MONITOR'|'EXTERNAL_OUTBOUND',
        'Name': 'string',
        'Description': 'string',
        'Channel': 'VOICE'|'CHAT'|'TASK',
        'QueueInfo': {
            'Id': 'string',
            'EnqueueTimestamp': datetime(2015, 1, 1)
        },
        'AgentInfo': {
            'Id': 'string',
            'ConnectedToAgentTimestamp': datetime(2015, 1, 1)
        },
        'InitiationTimestamp': datetime(2015, 1, 1),
        'DisconnectTimestamp': datetime(2015, 1, 1),
        'LastUpdateTimestamp': datetime(2015, 1, 1),
        'ScheduledTimestamp': datetime(2015, 1, 1),
        'RelatedContactId': 'string',
        'WisdomInfo': {
            'SessionArn': 'string'
        },
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

• (dict) --

  • Contact (dict) --

    Information about the contact.

    • Arn (string) --

      The Amazon Resource Name (ARN) for the contact.

    • Id (string) --

      The identifier for the contact.

    • InitialContactId (string) --

      If this contact is related to other contacts, this is the ID of the initial contact.

    • PreviousContactId (string) --

      If this contact is not the first contact, this is the ID of the previous contact.

    • InitiationMethod (string) --

      Indicates how the contact was initiated.

    • Name (string) --

      The name of the contact.

    • Description (string) --

      The description of the contact.

    • Channel (string) --

      How the contact reached your contact center.

    • QueueInfo (dict) --

      If this contact was queued, this contains information about the queue.

      • Id (string) --

        The unique identifier for the queue.

      • EnqueueTimestamp (datetime) --

        The timestamp when the contact was added to the queue.

    • AgentInfo (dict) --

      Information about the agent who accepted the contact.

      • Id (string) --

        The identifier of the agent who accepted the contact.

      • ConnectedToAgentTimestamp (datetime) --

        The timestamp when the contact was connected to the agent.

    • InitiationTimestamp (datetime) --

      The date and time this contact was initiated, in UTC time. For INBOUND , this is when the contact arrived. For OUTBOUND , this is when the agent began dialing. For CALLBACK , this is when the callback contact was created. For TRANSFER and QUEUE_TRANSFER , this is when the transfer was initiated. For API , this is when the request arrived. For EXTERNAL_OUTBOUND , this is when the agent started dialing the external participant. For MONITOR , this is when the supervisor started listening to a contact.

    • DisconnectTimestamp (datetime) --

      The timestamp when the customer endpoint disconnected from Amazon Connect.

    • LastUpdateTimestamp (datetime) --

      The timestamp when contact was last updated.

    • ScheduledTimestamp (datetime) --

      The timestamp, in Unix epoch time format, at which to start running the inbound flow.

    • RelatedContactId (string) --

      The contactId that is related to this contact.

    • WisdomInfo (dict) --

      Information about Amazon Connect Wisdom.

      • SessionArn (string) --

        The Amazon Resource Name (ARN) of the Wisdom session.

    • Tags (dict) --

      Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.

      • (string) --

        • (string) --