AWS connect documentation change
Summary
Enhanced documentation for data lake tables (agent_hierarchy_groups, routing_profiles, users) with added descriptions, primary keys, join keys, and required field indicators
Security assessment
The changes improve documentation clarity by adding table descriptions, join relationships, and marking field requirements ('Yes'/'No'). While security-related fields like agent_security_profile_ids exist, the changes don't address vulnerabilities or add new security content. Modifications are structural improvements to existing documentation without security implications.
Diff
diff --git a/connect/latest/adminguide/data-lake-configuration-data.md b/connect/latest/adminguide/data-lake-configuration-data.md index 3b657d49e..a0c118345 100644 --- a//connect/latest/adminguide/data-lake-configuration-data.md +++ b//connect/latest/adminguide/data-lake-configuration-data.md @@ -37 +37,13 @@ If you are unable to access the scheduling tables by using Option 1, try using O -Table Name: agent_hierarchy_groups +**Table name:** `agent_hierarchy_groups` + +**Description:** Dimension table containing the hierarchy group definitions for organizing agents, including group names, ARNs, and active status. + +**Primary key:** `agent_hierarchy_group_id` + +**Join keys:** + + * `instance_id` — Joins to all tables + + * `agent_hierarchy_group_id` — Joins to users table, Agent Statistic Record and Agent Queue Statistic Record (as `agent_hierarchy_level_*_id`) + + @@ -39 +50,0 @@ Table Name: agent_hierarchy_groups -Composite Primary Key: agent_hierarchy_group_id @@ -43,10 +54,10 @@ Column | Type | Description -instance_id | string | The ID of the Connect Customer instance. -instance_arn | string | The ARN of the Connect Customer instance. -aws_account_id | string | The ID of the AWS account that owns the contact. -agent_hierarchy_group_id | string | The identifier of the hierarchy group for the user. -agent_hierarchy_group_arn | string | The ARN of the hierarchy group. -agent_hierarchy_group_name | string | The name of the hierarchy group. -last_modified_region | string | The AWS Region where this resource was last modified. -last_modified_timestamp | timestamp | The Timestamp when this resource was last modified. -is_active | Boolean | Whether the agent hierarchy group exists or has been deleted. -data_lake_last_processed_timestamp | Timestamp | Timestamp, which shows the last time the record was touched by the data lake. This can include transformation and backfill. This field cannot be used to determine reliably data freshness. +instance_id | string | Yes | The ID of the Connect Customer instance. +instance_arn | string | Yes | The ARN of the Connect Customer instance. +aws_account_id | string | Yes | The ID of the AWS account that owns the contact. +agent_hierarchy_group_id | string | No | The identifier of the hierarchy group for the user. +agent_hierarchy_group_arn | string | Yes | The ARN of the hierarchy group. +agent_hierarchy_group_name | string | Yes | The name of the hierarchy group. +last_modified_region | string | Yes | The AWS Region where this resource was last modified. +last_modified_timestamp | timestamp | Yes | The Timestamp when this resource was last modified. +is_active | Boolean | Yes | Whether the agent hierarchy group exists or has been deleted. +data_lake_last_processed_timestamp | Timestamp | Yes | Timestamp, which shows the last time the record was touched by the data lake. This can include transformation and backfill. This field cannot be used to determine reliably data freshness. @@ -56 +67,13 @@ data_lake_last_processed_timestamp | Timestamp | Timestamp, which shows the l -Table Name: routing_profiles +**Table name:** `routing_profiles` + +**Description:** Dimension table containing routing profile configurations, including profile name, default outbound queue, and availability timer settings. + +**Primary key:** `agent_routing_profile_id` + +**Join keys:** + + * `instance_id` — Joins to all tables + + * `agent_routing_profile_id` — Joins to users table, Agent Statistic Record and Agent Queue Statistic Record (as `routing_profile_id`) + + @@ -58 +80,0 @@ Table Name: routing_profiles -Composite Primary Key: agent_routing_profile_id @@ -62,12 +84,12 @@ Column | Type | Description -agent_routing_profile_id | string | The identifier of the routing profile. -agent_routing_profile_arn | string | The ARN of the routing profile. -routing_profile_name | string | The name of the routing profile. -instance_id | string | The ID of the Connect Customer instance. -instance_arn | string | The ARN of the Connect Customer instance. -agent_availability_timer | string | Whether agents with this routing profile will have their routing order calculated based on _longest idle time_ or _time since their last inbound contact_. -default_outbound_queue_id | string | The default outbound queue for the routing profile. -routing_profile_description | string | Description of the routing profile. -last_modified_region | string | The AWS Region where this resource was last modified. -last_modified_timestamp | Timestamp | The Timestamp when this resource was last modified. -is_active | Boolean | Whether the agent exists or has been deleted. -data_lake_last_processed_timestamp | Timestamp | Timestamp, which shows the last time the record was touched by the data lake. This can include transformation and backfill. This field cannot be used to determine reliably data freshness. +agent_routing_profile_id | string | No | The identifier of the routing profile. +agent_routing_profile_arn | string | Yes | The ARN of the routing profile. +routing_profile_name | string | Yes | The name of the routing profile. +instance_id | string | Yes | The ID of the Connect Customer instance. +instance_arn | string | Yes | The ARN of the Connect Customer instance. +agent_availability_timer | string | Yes | Whether agents with this routing profile will have their routing order calculated based on _longest idle time_ or _time since their last inbound contact_. +default_outbound_queue_id | string | Yes | The default outbound queue for the routing profile. +routing_profile_description | string | Yes | Description of the routing profile. +last_modified_region | string | Yes | The AWS Region where this resource was last modified. +last_modified_timestamp | Timestamp | Yes | The Timestamp when this resource was last modified. +is_active | Boolean | Yes | Whether the agent exists or has been deleted. +data_lake_last_processed_timestamp | Timestamp | Yes | Timestamp, which shows the last time the record was touched by the data lake. This can include transformation and backfill. This field cannot be used to determine reliably data freshness. @@ -77 +99,19 @@ data_lake_last_processed_timestamp | Timestamp | Timestamp, which shows the l -Table Name: users +**Table name:** `users` + +**Description:** Master dimension table for agent data containing user identity, contact information, hierarchy assignments, routing profile, security profiles, and phone configuration. + +**Primary key:** `user_id` + +**Join keys:** + + * `instance_id` — Joins to all tables + + * `user_id` — Joins to Contact Record (as `agent_id`), Agent Statistic Record, Agent Queue Statistic Record, Contact Evaluation Record + + * `user_arn` — Joins to Agent Event (as `agent_arn`), scheduling tables (as `agent_arn`) + + * `agent_routing_profile_id` — Joins to routing_profiles + + * `agent_hierarchy_group_id` — Joins to agent_hierarchy_groups + + @@ -79 +118,0 @@ Table Name: users -Composite Primary Key: user_id @@ -83,31 +122,31 @@ Column | Type | Description -user_id | string | The identifier of the user account. -user_arn | string | The ARN of the user account. -directory_user_id | string | The identifier of the user account in the directory used for identity management. -agent_hierarchy_group_id | string | The identifier of the hierarchy group for the user. -agent_hierarchy_group_arn | string | The identifier of level 1 hierarchy group for the user. -agent_hierarchy_group_level_1_id | string | The identifier of level 1 hierarchy group for the user. -agent_hierarchy_group_level_2_id | string | The identifier of level 2 hierarchy group for the user. -agent_hierarchy_group_level_3_id | string | The identifier of level 3 hierarchy group for the user. -agent_hierarchy_group_level_4_id | string | The identifier of level 4 hierarchy group for the user. -agent_hierarchy_group_level_5_id | string | The identifier of level 5 hierarchy group for the user. -agent_email | string | The user's email address. -agent_secondary_email | string | The user's secondary email address. -first_name | string | The first name of the agent. -last_name | string | The last name of the agent. -mobile | string | The user's mobile number. -agent_username | string | The user name of the agent, as entered in their Connect Customer user account. -instance_id | string | The ID of the Connect Customer instance. -instance_arn | string | The ARN of the Connect Customer instance. -agent_routing_profile_id | string | The ID of the routing profile for the agent. -agent_routing_profile_arn | string | The ARN of the routing profile for the agent. -agent_security_profile_ids | array<string> | The IDs of the security profiles for the user. -agent_security_profile_arns | array<string> | The ARNs of the security profiles for the user. -last_modified_region | string | The AWS Region where this resource was last modified. -last_modified_timestamp | Timestamp | The Timestamp when this resource was last modified. -after_contact_work_time_limit | int | The After Call Work (ACW) timeout setting, in seconds. -auto_accept | Boolean | The Auto accept setting. -desk_phone_number | string | The phone number for the user's desk phone. -phone_type | string | The phone type. -is_active | Boolean | Whether the agent exists or has been deleted. -data_lake_last_processed_timestamp | Timestamp | Timestamp, which shows the last time the record was touched by the data lake. This can include transformation and backfill. This field cannot be used to determine reliably data freshness. -agent_voice_enhancement_mode | string | The voice enhancement mode used by the agent. Valid values: VOICE_ISOLATION | NOISE_SUPPRESSION | NONE. A value of null indicates this mode has not yet been set for this user. +user_id | string | No | The identifier of the user account. +user_arn | string | Yes | The ARN of the user account. +directory_user_id | string | Yes | The identifier of the user account in the directory used for identity management. +agent_hierarchy_group_id | string | Yes | The identifier of the hierarchy group for the user. +agent_hierarchy_group_arn | string | Yes | The identifier of level 1 hierarchy group for the user. +agent_hierarchy_group_level_1_id | string | Yes | The identifier of level 1 hierarchy group for the user. +agent_hierarchy_group_level_2_id | string | Yes | The identifier of level 2 hierarchy group for the user. +agent_hierarchy_group_level_3_id | string | Yes | The identifier of level 3 hierarchy group for the user. +agent_hierarchy_group_level_4_id | string | Yes | The identifier of level 4 hierarchy group for the user. +agent_hierarchy_group_level_5_id | string | Yes | The identifier of level 5 hierarchy group for the user. +agent_email | string | Yes | The user's email address. +agent_secondary_email | string | Yes | The user's secondary email address. +first_name | string | Yes | The first name of the agent. +last_name | string | Yes | The last name of the agent. +mobile | string | Yes | The user's mobile number. +agent_username | string | Yes | The user name of the agent, as entered in their Connect Customer user account. +instance_id | string | Yes | The ID of the Connect Customer instance. +instance_arn | string | Yes | The ARN of the Connect Customer instance. +agent_routing_profile_id | string | Yes | The ID of the routing profile for the agent. +agent_routing_profile_arn | string | Yes | The ARN of the routing profile for the agent. +agent_security_profile_ids | array<string> | Yes | The IDs of the security profiles for the user. +agent_security_profile_arns | array<string> | Yes | The ARNs of the security profiles for the user. +last_modified_region | string | Yes | The AWS Region where this resource was last modified. +last_modified_timestamp | Timestamp | Yes | The Timestamp when this resource was last modified. +after_contact_work_time_limit | int | Yes | The After Call Work (ACW) timeout setting, in seconds. +auto_accept | Boolean | Yes | The Auto accept setting. +desk_phone_number | string | Yes | The phone number for the user's desk phone. +phone_type | string | Yes | The phone type. +is_active | Boolean | Yes | Whether the agent exists or has been deleted. +data_lake_last_processed_timestamp | Timestamp | Yes | Timestamp, which shows the last time the record was touched by the data lake. This can include transformation and backfill. This field cannot be used to determine reliably data freshness. +agent_voice_enhancement_mode | string | Yes | The voice enhancement mode used by the agent. Valid values: VOICE_ISOLATION | NOISE_SUPPRESSION | NONE. A value of null indicates this mode has not yet been set for this user.