AWS connect documentation change
Summary
Restructured documentation for Amazon Connect analytics data lake scheduling, including updated section headers, expanded content organization, reformatted data schema tables, added staffing group details, and removed 'Users' and 'Routing profiles' sections
Security assessment
Changes focus on documentation structure, formatting improvements, and content reorganization without mentioning security vulnerabilities, access controls, or encryption. Removed user/routing profile sections reduce documentation scope but don't indicate security fixes. No evidence of addressing exploits or vulnerabilities.
Diff
diff --git a/connect/latest/adminguide/data-lake-scheduling.md b/connect/latest/adminguide/data-lake-scheduling.md index 109671e5f..1e5bf3c90 100644 --- a//connect/latest/adminguide/data-lake-scheduling.md +++ b//connect/latest/adminguide/data-lake-scheduling.md @@ -5 +5 @@ -Important things to noteData type definitionsData schemaSample queries +Important things to knowStaff scheduling profileShift activitiesShift profilesStaffing groupsStaffing groups - Forecast groupsStaffing groups - SupervisorsStaff shiftsStaff shift activitiesStaff timeoffsStaff timeoff intervalsData schemaSample queries @@ -7 +7 @@ Important things to noteData type definitionsData schemaSample queries -# Scheduling data in Amazon Connect Analytics data lake +# Scheduling data in the Amazon Connect analytics data lake @@ -11 +11 @@ Important things to noteData type definitionsData schemaSample queries -There are two ways to access the Analytics data lake and [configure data to be shared](./access-datalake.html). If you are unable to access the scheduling tables by using Option 1 - Using the AWS Management Console, proceed to Option 2 - Using CLI or CloudShell. +There are two ways to access the analytics data lake and [configure data to be shared](./access-datalake.html). If you are unable to access the scheduling tables by using Option 1 - Using the AWS Management Console, proceed to Option 2 - Using CLI or CloudShell. @@ -15 +15 @@ There are two ways to access the Analytics data lake and [configure data to be s - * Important things to note + * Important things to know @@ -17 +17 @@ There are two ways to access the Analytics data lake and [configure data to be s - * Data type definitions + * Staff scheduling profile @@ -19 +19 @@ There are two ways to access the Analytics data lake and [configure data to be s - * Data schema + * Shift activities @@ -21 +21 @@ There are two ways to access the Analytics data lake and [configure data to be s - * Sample queries + * Shift profiles @@ -22,0 +23 @@ There are two ways to access the Analytics data lake and [configure data to be s + * Staffing groups @@ -23,0 +25 @@ There are two ways to access the Analytics data lake and [configure data to be s + * Staffing groups - Forecast groups @@ -24,0 +27 @@ There are two ways to access the Analytics data lake and [configure data to be s + * Staffing groups - Supervisors @@ -26 +29 @@ There are two ways to access the Analytics data lake and [configure data to be s -## Important things to note + * Staff shifts @@ -28 +31 @@ There are two ways to access the Analytics data lake and [configure data to be s - * The tables store versioned records. Each new version of the item is appended to the table. + * Staff shift activities @@ -30 +33 @@ There are two ways to access the Analytics data lake and [configure data to be s - * The more recent versions of the items have a higher **_version** number. To get the latest version of the item, you need to query for the latest version of the record. The following is an example query to select all the latest shift activities: + * Staff timeoffs @@ -31,0 +35 @@ There are two ways to access the Analytics data lake and [configure data to be s + * Staff timeoff intervals @@ -32,0 +37 @@ There are two ways to access the Analytics data lake and [configure data to be s + * Data schema @@ -33,0 +39 @@ There are two ways to access the Analytics data lake and [configure data to be s + * Sample queries @@ -35,0 +42,8 @@ There are two ways to access the Analytics data lake and [configure data to be s + + +## Important things to know + + * The tables store versioned records. Each new version of the item is appended to the table. + + * The more recent versions of the items have a higher **_version** number. To get the latest version of the item, you need to query for the latest version of the record. The following is an example query to select all the latest shift activities: + @@ -47,5 +61 @@ There are two ways to access the Analytics data lake and [configure data to be s - * You can create a logical view with the latest version of each item. You can then run queries against this view. If you frequently run queries that only need the latest versions of the data, creating these views will simplify your queries. The folowing is an example query for how to create a view of latest shift activities: - - - - + * You can create a logical view with the latest version of each item. You can then run queries against this view. If you frequently run queries that only need the latest versions of the data, creating these views will simplify your queries. The following is an example query for how to create a view of latest shift activities: @@ -65 +75 @@ There are two ways to access the Analytics data lake and [configure data to be s - * Once you have a view like above, you can directly query the view by using the following: + * After you have a view like above, you can directly query the view by using the following: @@ -66,0 +77 @@ There are two ways to access the Analytics data lake and [configure data to be s +SELECT * from latest_shift_activities @@ -70 +80,0 @@ There are two ways to access the Analytics data lake and [configure data to be s -SELECT * from latest_shift_activities @@ -72,3 +82 @@ SELECT * from latest_shift_activities -## Data type definitions - -### Staff scheduling profile +## Staff scheduling profile @@ -80,16 +88,16 @@ Composite Primary Key: {instance_id, agent_arn, staff_scheduling_profile_version -| Column | Type | Description ----|---|---|--- -1 | instance_id | string | The ID of the Amazon Connect instance -2 | agent_arn | string | The ARN of the Agent -3 | staff_scheduling_profile_version | bigint | The Staff Scheduling Profile Version -4 | instance_arn | string | The ARN of the Amazon Connect instance -5 | staffing_group_arn | string | The ARN of the Staffing Group to which Agent is assigned -6 | start_timestamp | timestamp | StartTimestamp for the Agent configured in Staff Rules (schedules are generated only after this timestamp) -7 | end_timestamp | timestamp | EndTimestamp for the Agent configured in Staff Rules (schedules are not generated beyond this timestamp) -8 | shift_profile_arn | string | ARN of the Shift Profile to which the Agent is Assigned configured in Staff Rules -9 | timezone | string | Timezone configured for the Agent -10 | is_deleted | boolean | Set to True if the Agent is deleted. Else set to False. -11 | last_updated_timestamp | timestamp | Timestamp when the Staff Scheduling Profile was created/updated/deleted -12 | 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 reliably determine data freshness - -### Shift activities +Column | Type | Description +---|---|--- +instance_id | string | The ID of the Amazon Connect instance +agent_arn | string | The ARN of the Agent +staff_scheduling_profile_version | bigint | The Staff Scheduling Profile Version +instance_arn | string | The ARN of the Amazon Connect instance +staffing_group_arn | string | The ARN of the Staffing Group to which Agent is assigned +start_timestamp | timestamp | StartTimestamp for the Agent configured in Staff Rules (schedules are generated only after this timestamp) +end_timestamp | timestamp | EndTimestamp for the Agent configured in Staff Rules (schedules are not generated beyond this timestamp) +shift_profile_arn | string | ARN of the Shift Profile to which the Agent is Assigned configured in Staff Rules +timezone | string | Timezone configured for the Agent +is_deleted | boolean | Set to True if the Agent is deleted. Else set to False. +last_updated_timestamp | timestamp | Timestamp when the Staff Scheduling Profile was created/updated/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 reliably determine data freshness + +## Shift activities @@ -101,16 +109,16 @@ Composite Primary Key: {instance_id, shift_activity_arn, shift_activity_version} -| Column | Type | Description ----|---|---|--- -1 | instance_id | string | The ID of the Amazon Connect instance -2 | shift_activity_arn | string | The ARN of the Shift Activity -3 | shift_activity_version | bigint | The Shift Activity Version -4 | instance_arn | string | The ARN of the Amazon Connect instance -5 | shift_activity_name | string | Name of the Shift Activity -6 | type | string | Type of the Shift Activity. The possible values are PRODUCTIVE, NON_PRODUCTIVE and LEAVE -7 | sub_type | string | SubType of the Shift Activity This is only valid for NON_PRODUCTIVE type activities. The possible values are BREAK_OR_MEAL and NONE. -8 | is_adherence_tracked | boolean | Set to True if the Shift Activity is configured for Adherence tracking. Else set to False. -9 | is_paid | boolean | Set to True if the Shift Activity is configured as Paid. Else set to False. -10 | is_deleted | boolean | Set to True if the Shift Activity is deleted. Else set to False. -11 | last_updated_timestamp | timestamp | Timestamp when the Shift Activity was created/updated/deleted -12 | 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 reliably determine data freshness - -### Shift profiles +Column | Type | Description +---|---|--- +instance_id | string | The ID of the Amazon Connect instance +shift_activity_arn | string | The ARN of the Shift Activity +shift_activity_version | bigint | The Shift Activity Version +instance_arn | string | The ARN of the Amazon Connect instance +shift_activity_name | string | Name of the Shift Activity +type | string | Type of the Shift Activity. The possible values are PRODUCTIVE, NON_PRODUCTIVE and LEAVE +sub_type | string | SubType of the Shift Activity This is only valid for NON_PRODUCTIVE type activities. The possible values are BREAK_OR_MEAL and NONE. +is_adherence_tracked | boolean | Set to True if the Shift Activity is configured for Adherence tracking. Else set to False. +is_paid | boolean | Set to True if the Shift Activity is configured as Paid. Else set to False. +is_deleted | boolean | Set to True if the Shift Activity is deleted. Else set to False. +last_updated_timestamp | timestamp | Timestamp when the Shift Activity was created/updated/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 reliably determine data freshness + +## Shift profiles @@ -122,10 +130,10 @@ Composite Primary Key: {instance_id, shift_profile_arn, shift_profile_version} -| Column | Type | Description ----|---|---|--- -1 | instance_id | string | The ID of the Amazon Connect instance -2 | shift_profile_arn | string | The ARN of the Shift Profile -3 | shift_profile_version | bigint | The Shift Profile Version -4 | instance_arn | string | The ARN of the Amazon Connect instance -5 | shift_profile_name | string | Name of the Shift Profile -6 | is_deleted | boolean | Set to True if the Shift Profile is deleted. Else set to False. -7 | last_updated_timestamp | timestamp | Timestamp when the Shift Profile was created/updated/deleted -8 | 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 reliably determine data freshness +Column | Type | Description +---|---|--- +instance_id | string | The ID of the Amazon Connect instance +shift_profile_arn | string | The ARN of the Shift Profile +shift_profile_version | bigint | The Shift Profile Version +instance_arn | string | The ARN of the Amazon Connect instance +shift_profile_name | string | Name of the Shift Profile +is_deleted | boolean | Set to True if the Shift Profile is deleted. Else set to False. +last_updated_timestamp | timestamp | Timestamp when the Shift Profile was created/updated/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 reliably determine data freshness @@ -133 +141 @@ Composite Primary Key: {instance_id, shift_profile_arn, shift_profile_version} -### Staffing groups +## Staffing groups @@ -139,10 +147,10 @@ Composite Primary Key: {instance_id, staffing_group_arn, staffing_group_version} -| Column | Type | Description ----|---|---|--- -1 | instance_id | string | The ID of the Amazon Connect instance -2 | staffing_group_arn | string | The ARN of the Staffing Group -3 | staffing_group_version | bigint | The Staffing Group Version -4 | instance_arn | string | The ARN of the Amazon Connect instance -5 | staffing_group_name | string | Name of the Staffing Group -6 | is_deleted | boolean | Set to True if the Staffing Group is deleted. Else set to False. -7 | last_updated_timestamp | timestamp | Timestamp when the Staffing Group was created/updated/deleted -8 | 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 reliably determine data freshness +Column | Type | Description +---|---|--- +instance_id | string | The ID of the Amazon Connect instance +staffing_group_arn | string | The ARN of the Staffing Group +staffing_group_version | bigint | The Staffing Group Version +instance_arn | string | The ARN of the Amazon Connect instance +staffing_group_name | string | Name of the Staffing Group +is_deleted | boolean | Set to True if the Staffing Group is deleted. Else set to False. +last_updated_timestamp | timestamp | Timestamp when the Staffing Group was created/updated/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 reliably determine data freshness @@ -150 +158 @@ Composite Primary Key: {instance_id, staffing_group_arn, staffing_group_version} -### Staffing groups \- Forecast groups +## Staffing groups - Forecast groups @@ -158,10 +166,10 @@ This table should be queried by joining with staffing_groups table on staffing_g -| Column | Type | Description ----|---|---|--- -1 | instance_id | string | The ID of the Amazon Connect instance -2 | staffing_group_arn | string | The ARN of the Staffing Group -3 | staffing_group_version | bigint | The Staffing Group Version -4 | forecast_group_arn | string | The ARN of the Forecast Group associated to the Staffing Group -5 | instance_arn | string | The ARN of the Amazon Connect instance -6 | is_deleted | boolean | Set to False when the StaffingGroup-ForecastGroup association is valid. -7 | last_updated_timestamp | timestamp | Timestamp when the Staffing Group was created/updated -8 | 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 reliably determine data freshness +Column | Type | Description