AWS connect documentation change
Summary
Restructured the documentation to remove detailed column definitions for multiple data types (Agent queue statistic record, Agent statistic record, AI Agent, etc.) and replaced them with hyperlinks to new dedicated documentation pages. Added a new 'Reference queries' section.
Security assessment
The changes involve reorganization of documentation content without any references to security vulnerabilities, patches, or security features. The modifications focus on improving documentation structure by moving detailed data definitions to separate pages and adding navigation links.
Diff
diff --git a/connect/latest/adminguide/data-type-definitions.md b/connect/latest/adminguide/data-type-definitions.md index 6d3b01c99..2f213eae2 100644 --- a//connect/latest/adminguide/data-type-definitions.md +++ b//connect/latest/adminguide/data-type-definitions.md @@ -7 +7 @@ -Important things to knowAgent queue statistic recordAgent statistic recordAI AgentAI Agent Knowledge BaseAI PromptAI SessionAI ToolConnect test case execution resultsContact Lens conversational analyticsContact evaluation recordContact flow eventsContact recordContact statistic recordAgent eventResource tags +Important things to know @@ -28 +28 @@ If you are unable to access the scheduling tables by using Option 1, try using O - * Agent queue statistic record + * [Agent data](./data-lake-agent-data.html) @@ -30 +30 @@ If you are unable to access the scheduling tables by using Option 1, try using O - * Agent statistic record + * [Contact data](./data-lake-contact-data.html) @@ -32 +32 @@ If you are unable to access the scheduling tables by using Option 1, try using O - * AI Agent + * [Contact analytics data](./data-lake-contact-analytics-data.html) @@ -34 +34 @@ If you are unable to access the scheduling tables by using Option 1, try using O - * AI Agent Knowledge Base + * [AI agent data](./data-lake-ai-agent-data.html) @@ -36,19 +36 @@ If you are unable to access the scheduling tables by using Option 1, try using O - * AI Prompt - - * AI Session - - * AI Tool - - * Connect test case execution results - - * Contact Lens conversational analytics - - * Contact evaluation record - - * Contact flow events - - * Contact record - - * Contact statistic record - - * Agent event + * [Flow data](./data-lake-flow-data.html) @@ -66 +48 @@ If you are unable to access the scheduling tables by using Option 1, try using O - * Resource tags + * [Resource tags data](./data-lake-resource-tags-data.html) @@ -69,0 +52,2 @@ If you are unable to access the scheduling tables by using Option 1, try using O + * [Reference queries](./data-lake-reference-queries.html) + @@ -84,665 +67,0 @@ If you are unable to access the scheduling tables by using Option 1, try using O -## Agent queue statistic record - -**Column** | **Type** | **Description** ----|---|--- -aqsr_statistic_id | string | Unique ID for the AQSR record -instance_id | string | The identifier of the Connect Customer instance. You can [find the instance ID](./find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance. -user_id | string | The identifier of the user account. -routing_profile_id | string | ID of routing profile. -agent_hierarchy_level_1_id | string | ID of level 1 Hierarchy Group. -agent_hierarchy_level_2_id | string | ID of level 2 Hierarchy Group. -agent_hierarchy_level_3_id | string | ID of level 3 Hierarchy Group. -agent_hierarchy_level_4_id | string | ID of level 4 Hierarchy Group. -agent_hierarchy_level_5_id | string | ID of level 5 Hierarchy Group. -interval_start_time | Timestamp | Timestamp of the conversation when interval started. -interval_end_time | Timestamp | Timestamp of the conversation when interval ended. -published_date | Timestamp | -aws_account_id | string | The ID of the AWS account that owns the contact. -queue_id | string | The identifier of the queue. -channel | string | The method used to contact your contact center: VOICE, CHAT, TASK, EMAIL. -queue_type | string | QueueType specifies the classification of the queue, indicating its intended use and behavior. Valid values for QueueType are STANDARD, which is a general-purpose queue where contacts wait before they are routed to and accepted by agents, and AGENT, which are created automatically for every agent user you add Connect Customer. -agent_non_response | bigint | The count of contacts routed to an agent but not answered by that agent, including contacts abandoned by the customer. -contacts_offered | bigint | -contacts_handled | bigint | The count of contacts that were connected to an agent. It doesn't matter how the contact got to the agent. It could be a customer calling your contact center, or an agent calling the customer. It could be a contact transferred from one agent to another. It could be a contact where the agent answered it, but then they weren't sure what to do and they transferred the contact away again. As long as the agent was connected to the contact, it increments **Contacts handled**. -handle_time | bigint | The average time, from start to finish, that a contact was connected with an agent (average handled time). It includes talk time, hold time, After Contact Work (ACW) time, custom status time, and agent pause duration (which applies only to tasks). AHT is calculated by averaging the amount of time between the contact being answered by an agent and the conversation ending. It applies to both inbound and outbound calls. -agent_incoming_connecting_time | bigint | The total time between when a contact is initiated by Connect Customer reserving the agent for the contact, and the agent is connected. -agent_outbound_connecting_time | bigint | Total time between when an outbound contact is initiated by Connect Customer reserving the agent for the contact, and the agent is connected. -agent_callback_connecting_time | bigint | The total time between when a callback contact is initiated by Connect Customer reserving the agent for the contact, and the agent is connected. -agent_api_connecting_time | bigint | The total time between when a contact is initiated using an Connect Customer API, and the agent is connected. -incoming_connecting_attempts | bigint | The number of attempts initiated by Connect Customer reserving the agent for the contact for INBOUND initiation type contacts. -outbound_connecting_attempts | bigint | The number of attempts initiated by Connect Customer reserving the agent for the contact for outbound initiation type contacts. -callback_connecting_attempts | bigint | The number of contacts where a callback was attempted, but the customer did not pick up. -api_connecting_attempts | bigint | Used for calculating - [Average agent incoming connecting time](./metrics-definitions.html#average-agent-incoming-connecting-time). -data_lake_last_processed_Timestamp | Timestamp | Timestamp, which shows the last time the data lake processed the record. This can include transformation and backfill. This field cannot be used to determine reliably data freshness. - -## Agent statistic record - -**Column** | **Type** | **Description** ----|---|--- -asr_statistic_id | string | Unique ID for the ASR record. -instance_id | string | The identifier of the Connect Customer instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance. -user_id | string | The identifier of the user account. -routing_profile_id | string | ID of routing profile. -agent_hierarchy_level_1_id | string | ID of level 1 Hierarchy Group. -agent_hierarchy_level_2_id | string | ID of level 2 Hierarchy Group. -agent_hierarchy_level_3_id | string | ID of level 3 Hierarchy Group. -agent_hierarchy_level_4_id | string | ID of level 4 Hierarchy Group. -agent_hierarchy_level_5_id | string | ID of level 5 Hierarchy Group. -interval_start_time | Timestamp | Timestamp of the conversation when interval started. -interval_end_time | Timestamp | Timestamp of the conversation when interval ended. -published_date | Timestamp | -aws_account_id | string | The ID of the AWS account that owns the contact. -online_time | bigint | Total time that an agent spent with their CCP set to a status other than **Offline**. This includes any time spent in a custom status. When you create a historical metrics reports, this metric can't be grouped or filtered by queue, phone number, or channels. -error_time | bigint | For a specific agent, the total time contacts were in an error status. This metric can't be grouped or filtered by queue. -non_productive_time | bigint | Total time that agents spent in a [custom status](https://docs.aws.amazon.com/connect/latest/adminguide/agent-custom.html). That is, their CCP status is other than **Available** or **Offline**. This metric doesn't mean that the agent was spending their time unproductively. -agent_idle_time | bigint | After the agent sets their status in the CCP to **Available** , this is the amount of time they weren't handling contacts + any time their contacts were in an Error state. Agent idle time doesn't include the amount of time from when Connect Customer starts routing the contact to the agent, to when agent picks up or declines the contact. -agent_on_contact_time | bigint | Total time that an agent spent on one or multiple contacts, including [Customer hold time](./metrics-definitions.html#customer-hold-time) and [After contact work time](./metrics-definitions.html#after-contact-work-time). This does **not** include time spent on a contact while in a custom status or **Offline** status. (Custom status = the agent's CCP status is other than **Available** or **Offline**. For example, Training would be a custom status). -custom_state_time_01 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_02 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_03 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_04 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_05 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_06 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_07 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_08 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_09 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_10 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_11 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_12 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_13 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_14 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_15 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_16 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_17 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_18 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_19 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_20 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_21 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_22 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_23 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_24 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_25 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_26 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_27 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_28 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_29 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_30 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_31 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_32 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_33 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_34 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_35 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_36 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_37 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_38 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_39 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_40 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_41 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_42 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_43 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_44 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_45 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_46 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_47 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_48 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_49 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -custom_state_time_50 | bigint | Represents custom agent states defined by a customer. For example: Coffee_break. -data_lake_last_processed_timestamp | Timestamp | Timestamp, which shows the last time the data lake processed the record. This can include transformation and backfill. This field cannot be used to determine reliably data freshness. - -## AI Agent - -**Column** | **Type** | **Description** ----|---|--- -instance_arn | string | The ARN of the Connect instance. -instance_id | string | The ID of the Connect instance. -contact_id | string | The ID of the contact. -ai_agent_id | string | The Id of the requested AI Agent. -ai_agent_version | string | The version of the requested AI Agent. -ai_agent_event_id | string | Id of the event. -aws_account_id | string | The ID of the AWS account where AI Assistant is used. -assistant_id | string | The ID of the AI Assistant. -ai_session_id | string | The ID of AI-Agent session. -creation_timestamp | bigint | The timestamp of the event is created in the data lake. -update_timestamp | bigint | The timestamp of the event is updated in the data lake. -ai_use_case | string | The use case of the AI agent. -ai_agent_type | string | The type of the requested AI Agent. -ai_agent_name | string | The name of the requested AI Agent. -ai_agent_arn | string | The Arn of the requested AI Agent. -invocation_success | bool | A boolean field which indicates whether the invocation of the AI agent has been successful or not. -invocation_latency_ms | float | The invocation latency of the AI Agent in the evaluated contact. -conversation_turns_in_response | bigint | The number of conversation turns responded by the requested AI Agent. -response_helpful | int | The count of AI suggestions rated as helpful with a thumbs-up. -response_not_helpful | int | The count of AI suggestions rated as unhelpful with a thumbs-down. - -## AI Agent Knowledge Base - -**Column** | **Type** | **Description** ----|---|--- -instance_arn | string | The ARN of the Connect instance. -aws_account_id | string | The identifer of the AWS account that owns Connect AI Assistant. -instance_id | string | The ID of the Connect instance. -contact_id | string | The ID of the specific contact . -knowledge_content_id | string | The ID of the referenced knowledge content. -ai_agent_type | string | The type of the requested AI Agent. -ai_agent_knowledge_base_event_id | string | The ID of the knowledge base reference event. -assistant_id | string | The ID of the Amazon Connect AI Assistant. -ai_session_id | string | The ID of AI Agent session. -creation_timestamp | string | The instant the data lake event was created. -update_timestamp | string | The instant the data lake event was last modified. -ai_agent_id | string | The ID of requested AI Agent. -ai_agent_name | string | The name of the requested AI Agent. -ai_agent_version | string | The version number of the requested AI Agent. -ai_agent_arn | string | The ARN of the requested AI Agent. -knowledge_base_id | string | The ID of the referenced knowledge base.