Skip to content

aws.connect.describe_contact

Example SQL Queries

SELECT * FROM
aws.connect.describe_contact
WHERE
"instance_id" = 'VALUE'
AND "contact_id" = 'VALUE';

Description

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

Describes the specified contact.

Contact information remains available in Amazon Connect for 24 months, and then it is deleted.

Only data from November 12, 2021, and later is returned by this API.

Table Definition

Column NameColumn Data Type
contact_id Required Input Column

The identifier of the contact.

VARCHAR
instance_id Required Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
contact

Information about the contact.

STRUCT(
"arn" VARCHAR,
"id" VARCHAR,
"initial_contact_id" VARCHAR,
"previous_contact_id" VARCHAR,
"initiation_method" VARCHAR,
"name" VARCHAR,
"description" VARCHAR,
"channel" VARCHAR,
"queue_info" STRUCT(
"id" VARCHAR,
"enqueue_timestamp" TIMESTAMP_S
),
"agent_info" STRUCT(
"id" VARCHAR,
"connected_to_agent_timestamp" TIMESTAMP_S,
"agent_pause_duration_in_seconds" BIGINT,
"hierarchy_groups" STRUCT(
"level1" STRUCT(
"arn" VARCHAR
),
"level2" STRUCT(
"arn" VARCHAR
),
"level3" STRUCT(
"arn" VARCHAR
),
"level4" STRUCT(
"arn" VARCHAR
),
"level5" STRUCT(
"arn" VARCHAR
)
),
"device_info" STRUCT(
"platform_name" VARCHAR,
"platform_version" VARCHAR,
"operating_system" VARCHAR
),
"capabilities" STRUCT(
"video" VARCHAR
)
),
"initiation_timestamp" TIMESTAMP_S,
"disconnect_timestamp" TIMESTAMP_S,
"last_update_timestamp" TIMESTAMP_S,
"last_paused_timestamp" TIMESTAMP_S,
"last_resumed_timestamp" TIMESTAMP_S,
"total_pause_count" BIGINT,
"total_pause_duration_in_seconds" BIGINT,
"scheduled_timestamp" TIMESTAMP_S,
"related_contact_id" VARCHAR,
"wisdom_info" STRUCT(
"session_arn" VARCHAR
),
"queue_time_adjustment_seconds" BIGINT,
"queue_priority" BIGINT,
"tags" MAP(VARCHAR, VARCHAR),
"connected_to_system_timestamp" TIMESTAMP_S,
"routing_criteria" STRUCT(
"steps" STRUCT(
"expiry" STRUCT(
"duration_in_seconds" BIGINT,
"expiry_timestamp" TIMESTAMP_S
),
"expression" STRUCT(
"attribute_condition" STRUCT(
"name" VARCHAR,
"value" VARCHAR,
"proficiency_level" DOUBLE,
"match_criteria" STRUCT(
"agents_criteria" STRUCT(
"agent_ids" VARCHAR[]
)
),
"comparison_operator" VARCHAR
)
),
"status" VARCHAR
)[],
"activation_timestamp" TIMESTAMP_S,
"index" BIGINT
),
"customer" STRUCT(
"device_info" STRUCT(
"platform_name" VARCHAR,
"platform_version" VARCHAR,
"operating_system" VARCHAR
),
"capabilities" STRUCT(
"video" VARCHAR
)
),
"campaign" STRUCT(
"campaign_id" VARCHAR
),
"answering_machine_detection_status" VARCHAR,
"customer_voice_activity" STRUCT(
"greeting_start_timestamp" TIMESTAMP_S,
"greeting_end_timestamp" TIMESTAMP_S
),
"quality_metrics" STRUCT(
"agent" STRUCT(
"audio" STRUCT(
"quality_score" DOUBLE,
"potential_quality_issues" VARCHAR[]
)
),
"customer" STRUCT(
"audio" STRUCT(
"quality_score" DOUBLE,
"potential_quality_issues" VARCHAR[]
)
)
),
"disconnect_details" STRUCT(
"potential_disconnect_issue" VARCHAR
),
"segment_attributes" MAP(VARCHAR, STRUCT(
"value_string" VARCHAR
))
)
Show child fields
contact.agent_info

Information about the agent who accepted the contact.

Show child fields
contact.agent_info.agent_pause_duration_in_seconds

Agent pause duration for a contact in seconds.

contact.agent_info.capabilities

The configuration for the allowed capabilities for participants present over the call.

Show child fields
contact.agent_info.capabilities.video

The configuration having the video sharing capabilities for participants over the call.

contact.agent_info.connected_to_agent_timestamp

The timestamp when the contact was connected to the agent.

contact.agent_info.device_info

Information regarding Agent’s device.

Show child fields
contact.agent_info.device_info.operating_system

Operating system that the participant used for the call.

contact.agent_info.device_info.platform_name

Name of the platform that the participant used for the call.

contact.agent_info.device_info.platform_version

Version of the platform that the participant used for the call.

contact.agent_info.hierarchy_groups

The agent hierarchy groups for the agent.

Show child fields
contact.agent_info.hierarchy_groups.level1

The group at level one of the agent hierarchy.

Show child fields
contact.agent_info.hierarchy_groups.level1.arn

The Amazon Resource Name (ARN) of the group.

contact.agent_info.hierarchy_groups.level2

The group at level two of the agent hierarchy.

Show child fields
contact.agent_info.hierarchy_groups.level2.arn

The Amazon Resource Name (ARN) of the group.

contact.agent_info.hierarchy_groups.level3

The group at level three of the agent hierarchy.

Show child fields
contact.agent_info.hierarchy_groups.level3.arn

The Amazon Resource Name (ARN) of the group.

contact.agent_info.hierarchy_groups.level4

The group at level four of the agent hierarchy.

Show child fields
contact.agent_info.hierarchy_groups.level4.arn

The Amazon Resource Name (ARN) of the group.

contact.agent_info.hierarchy_groups.level5

The group at level five of the agent hierarchy.

Show child fields
contact.agent_info.hierarchy_groups.level5.arn

The Amazon Resource Name (ARN) of the group.

contact.agent_info.id

The identifier of the agent who accepted the contact.

contact.answering_machine_detection_status

Indicates how an outbound campaign call is actually disposed if the contact is connected to Amazon Connect.

contact.arn

The Amazon Resource Name (ARN) for the contact.

contact.campaign

Information associated with a campaign.

Show child fields
contact.campaign.campaign_id

A unique identifier for a campaign.

contact.channel

How the contact reached your contact center.

contact.connected_to_system_timestamp

The timestamp when customer endpoint connected to Amazon Connect.

contact.customer

Information about the Customer on the contact.

Show child fields
contact.customer.capabilities

The configuration for the allowed capabilities for participants present over the call.

Show child fields
contact.customer.capabilities.video

The configuration having the video sharing capabilities for participants over the call.

contact.customer.device_info

Information regarding Customer’s device.

Show child fields
contact.customer.device_info.operating_system

Operating system that the participant used for the call.

contact.customer.device_info.platform_name

Name of the platform that the participant used for the call.

contact.customer.device_info.platform_version

Version of the platform that the participant used for the call.

contact.customer_voice_activity

Information about customer’s voice activity.

Show child fields
contact.customer_voice_activity.greeting_end_timestamp

Timestamp that measures the end of the customer greeting from an outbound voice call.

contact.customer_voice_activity.greeting_start_timestamp

Timestamp that measures the beginning of the customer greeting from an outbound voice call.

contact.description

The description of the contact.

contact.disconnect_details

Information about the call disconnect experience.

Show child fields
contact.disconnect_details.potential_disconnect_issue

Indicates the potential disconnection issues for a call. This field is not populated if the service does not detect potential issues.

contact.disconnect_timestamp

The timestamp when the customer endpoint disconnected from Amazon Connect.

contact.id

The identifier for the contact.

contact.initial_contact_id

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

contact.initiation_method

Indicates how the contact was initiated.

contact.initiation_timestamp

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.

contact.last_paused_timestamp

The timestamp when the contact was last paused.

contact.last_resumed_timestamp

The timestamp when the contact was last resumed.

contact.last_update_timestamp

The timestamp when contact was last updated.

contact.name

The name of the contact.

contact.previous_contact_id

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

contact.quality_metrics

Information about the quality of the participant's media connection.

Show child fields
contact.quality_metrics.agent

Information about the quality of Agent media connection.

Show child fields
contact.quality_metrics.agent.audio

Information about the audio quality of the Agent

Show child fields
contact.quality_metrics.agent.audio.potential_quality_issues[]
contact.quality_metrics.agent.audio.quality_score

Number measuring the estimated quality of the media connection.

contact.quality_metrics.customer

Information about the quality of Customer media connection.

Show child fields
contact.quality_metrics.customer.audio

Information about the audio quality of the Customer

Show child fields
contact.quality_metrics.customer.audio.potential_quality_issues[]
contact.quality_metrics.customer.audio.quality_score

Number measuring the estimated quality of the media connection.

contact.queue_info

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

Show child fields
contact.queue_info.enqueue_timestamp

The timestamp when the contact was added to the queue.

contact.queue_info.id

The unique identifier for the queue.

contact.queue_priority

An integer that represents the queue priority to be applied to the contact (lower priorities are routed preferentially). Cannot be specified if the QueueTimeAdjustmentSeconds is specified. Must be statically defined, must be larger than zero, and a valid integer value. Default Value is 5.

contact.queue_time_adjustment_seconds

An integer that represents the queue time adjust to be applied to the contact, in seconds (longer/larger queue time are routed preferentially). Cannot be specified if the QueuePriority is specified. Must be statically defined and a valid integer value.

contact.related_contact_id

The contactId that is related to this contact.

contact.routing_criteria

Latest routing criteria on the contact.

Show child fields
contact.routing_criteria.activation_timestamp

The timestamp indicating when the routing criteria is set to active. A routing criteria is activated when contact is transferred to a queue. ActivationTimestamp will be set on routing criteria for contacts in agent queue even though Routing criteria is never activated for contacts in agent queue.

contact.routing_criteria.index

Information about the index of the routing criteria.

contact.routing_criteria.steps[]
Show child fields
contact.routing_criteria.steps[].expiry

An object to specify the expiration of a routing step.

Show child fields
contact.routing_criteria.steps[].expiry.duration_in_seconds

The number of seconds to wait before expiring the routing step.

contact.routing_criteria.steps[].expiry.expiry_timestamp

The timestamp indicating when the routing step expires.

contact.routing_criteria.steps[].expression

A tagged union to specify expression for a routing step.

Show child fields
contact.routing_criteria.steps[].expression.attribute_condition

An object to specify the predefined attribute condition.

Show child fields
contact.routing_criteria.steps[].expression.attribute_condition.comparison_operator

The operator of the condition.

contact.routing_criteria.steps[].expression.attribute_condition.match_criteria

An object to define AgentsCriteria.

Show child fields
contact.routing_criteria.steps[].expression.attribute_condition.match_criteria.agents_criteria

An object to define agentIds.

Show child fields
contact.routing_criteria.steps[].expression.attribute_condition.match_criteria.agents_criteria.agent_ids[]
contact.routing_criteria.steps[].expression.attribute_condition.name

The name of predefined attribute.

contact.routing_criteria.steps[].expression.attribute_condition.proficiency_level

The proficiency level of the condition.

contact.routing_criteria.steps[].expression.attribute_condition.value

The value of predefined attribute.

contact.routing_criteria.steps[].status

Represents status of the Routing step.

contact.scheduled_timestamp

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

contact.segment_attributes

A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes and can be accessed in flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example, connect:Guide or connect:SMS.

contact.tags

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

contact.total_pause_count

Total pause count for a contact.

contact.total_pause_duration_in_seconds

Total pause duration for a contact in seconds.

contact.wisdom_info

Information about Amazon Connect Wisdom.

Show child fields
contact.wisdom_info.session_arn

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