AWS connect documentation change
Summary
Added documentation about two access methods for analytics data lake (console vs CLI/CloudShell) and made numerous formatting/descriptive improvements to field definitions (punctuation consistency, example phrasing, typo fixes).
Security assessment
Changes focus on documentation clarity, formatting consistency, and access method instructions without introducing or modifying security controls. No evidence of addressing vulnerabilities or security incidents. Fraud detection fields (e.g., voice_id_result_fraud_detection_watch_list_id) were already documented and only received punctuation changes.
Diff
diff --git a/connect/latest/adminguide/data-type-definitions.md b/connect/latest/adminguide/data-type-definitions.md index 91b4627aa..c88705fb8 100644 --- a//connect/latest/adminguide/data-type-definitions.md +++ b//connect/latest/adminguide/data-type-definitions.md @@ -10,0 +11,11 @@ This topic details the content in the Amazon Connect analytics data lake tables. +There are two ways to access the analytics data lake and configure data to be shared: + + * [Option 1: Use the Amazon Connect console](./access-datalake.html#option1-configure-data-to-be-shared) + + * [Option 2: Use CLI or CloudShell](./access-datalake.html#option2-configure-data-to-be-shared) + + + + +If you are unable to access the scheduling tables by using Option 1, try using Option 2. + @@ -46,7 +57,7 @@ instance_id | string | The identifier of the Amazon Connect instance. You ca -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 +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. @@ -57 +68 @@ aws_account_id | string | The ID of the AWS account that owns the contact. -queue_id | string | _The identifier of the queue._ +queue_id | string | The identifier of the queue. @@ -59,2 +70,2 @@ channel | string | The method used to contact your contact center: VOICE, CH -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 Amazon Connect._ -agent_non_response | bigint | _The count of contacts routed to an agent but not answered by that agent, including contacts abandoned by the customer._ +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 Amazon Connect. +agent_non_response | bigint | The count of contacts routed to an agent but not answered by that agent, including contacts abandoned by the customer. @@ -68,2 +79,2 @@ agent_api_connecting_time | bigint | The total time between when a contact i -incoming_connecting_attempts | bigint | The number of attempts initiated by Amazon Connect reserving the agent for the contact for INBOUND initiation type contacts -outbound_connecting_attempts | bigint | The number of attempts initiated by Amazon Connect reserving the agent for the contact for outbound initiation type contacts +incoming_connecting_attempts | bigint | The number of attempts initiated by Amazon Connect reserving the agent for the contact for INBOUND initiation type contacts. +outbound_connecting_attempts | bigint | The number of attempts initiated by Amazon Connect reserving the agent for the contact for outbound initiation type contacts. @@ -71,2 +82,2 @@ callback_connecting_attempts | bigint | The number of contacts where a callb -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 reliably determine data freshness +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 reliably determine data freshness. @@ -78 +89 @@ data_lake_last_processed_timestamp | timestamp | Timestamp which shows the l -asr_statistic_id | string | Unique ID for the ASR record +asr_statistic_id | string | Unique ID for the ASR record. @@ -80,7 +91,7 @@ instance_id | string | The identifier of the Amazon Connect instance. You ca -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 +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. @@ -96,51 +107,51 @@ agent_on_contact_time | bigint | Total time that an agent spent on one or mul -custom_state_time_01 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_02 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_03 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_04 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_05 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_06 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_07 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_08 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_09 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_10 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_11 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_12 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_13 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_14 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_15 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_16 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_17 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_18 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_19 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_20 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_21 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_22 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_23 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_24 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_25 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_26 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_27 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_28 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_29 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_30 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_31 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_32 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_33 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_34 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_35 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_36 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_37 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_38 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_39 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_40 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_41 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_42 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_43 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_44 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_45 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_46 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_47 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_48 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_49 | bigint | Represents custom agent states defined by a customer. Ex: Coffee_break. -custom_state_time_50 | bigint | Represents custom agent states defined by a customer. Ex: 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 reliably determine data freshness +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 reliably determine data freshness. @@ -153 +164 @@ aws_account_id | string | The ID of the AWS account that owns the contact. -version | string | Indicates real-time or post call/chat analysis +version | string | Indicates real-time or post call/chat analysis. @@ -156 +167 @@ instance_arn | string | The ARN of the Amazon Connect instance. -contact_id | string | The ID of the contact being evaluated +contact_id | string | The ID of the contact being evaluated. @@ -158,3 +169,3 @@ channel | string | The method used to contact your contact center: VOICE, CH -language_locale | string | Language used to analyze contact - [AI features](./supported-languages.html#supported-languages-contact-lens) -feature | string | Will always have the same value "contact_lens_conversational_analytics" -categories | array(string) | Array of categories assigned to the contact +language_locale | string | Language used to analyze contact - [AI features](./supported-languages.html#supported-languages-contact-lens). +feature | string | Will always have the same value "contact_lens_conversational_analytics". +categories | array(string) | Array of categories assigned to the contact. @@ -162,2 +173,2 @@ disconnect_timestamp | timestamp | contact disconnect timestamp -greeting_time_agent_ms | bigint | First response time of agents on chat, indicating how quickly they engage with customers after joining the chat -non_talk_time_total_ms | bigint | Total non-talk time in a voice conversation. Non-talk time refers to the combined duration of hold time and periods of silence exceeding 3 seconds, during which neither the agent nor the customer is engaged in conversation +greeting_time_agent_ms | bigint | First response time of agents on chat, indicating how quickly they engage with customers after joining the chat. +non_talk_time_total_ms | bigint | Total non-talk time in a voice conversation. Non-talk time refers to the combined duration of hold time and periods of silence exceeding 3 seconds, during which neither the agent nor the customer is engaged in conversation. @@ -168,6 +179,6 @@ total_conversation_duration_ms | bigint | The total time from the start of t -talk_speed_agent_wpm | float | Words per minute spoken by the agent -talk_speed_customer_wpm | float | Words per minute spoken by the customer -interruptions_time_total_ms | bigint | Amount of time agent or customer were speaking at the same time -interruptions_time_agent_ms | bigint | Amount of time the agent spoke while the customer was already speaking -interruptions_time_customer_ms | bigint | Amount of time the customer spoke while the agent was already speaking -interruptions_total_count | bigint | Count of times interruptions were detected during a conversation +talk_speed_agent_wpm | float | Words per minute spoken by the agent. +talk_speed_customer_wpm | float | Words per minute spoken by the customer. +interruptions_time_total_ms | bigint | Amount of time agent or customer were speaking at the same time. +interruptions_time_agent_ms | bigint | Amount of time the agent spoke while the customer was already speaking. +interruptions_time_customer_ms | bigint | Amount of time the customer spoke while the agent was already speaking.