AWS connect documentation change
Summary
Updated documentation for forecasting data tables by adding structured headers with descriptions, primary/join keys, and nullability indicators for all columns
Security assessment
The changes enhance documentation clarity by adding table descriptions, relationship mappings, and nullability constraints. No security vulnerabilities, fixes, or security features are mentioned. Changes focus on data structure documentation without security implications.
Diff
diff --git a/connect/latest/adminguide/data-lake-forecasting-data.md b/connect/latest/adminguide/data-lake-forecasting-data.md index 8854b48c1..c8d0f3218 100644 --- a//connect/latest/adminguide/data-lake-forecasting-data.md +++ b//connect/latest/adminguide/data-lake-forecasting-data.md @@ -56 +56,15 @@ If you are unable to access the scheduling tables by using Option 1, try using O -Table name: forecast_groups +**Table name:** `forecast_groups` + +**Description:** Defines forecast groups that organize queues and channels for demand forecasting, using versioning for change tracking. + +**Primary key:** `instance_id, forecast_group_arn, forecast_group_version` + +**Join keys:** + + * `instance_id` — Joins to all tables + + * `forecast_group_arn, forecast_group_version` — Joins to long_term_forecasts, short_term_forecasts + + * `forecast_group_arn` — Joins to staffing_group_forecast_groups + + @@ -58 +71,0 @@ Table name: forecast_groups -Composite primary key: {instance_id, forecast_group_arn, forecast_group_version} @@ -62,8 +75,8 @@ Column | Type | Description -instance_id | String | The identifier of the Connect Customer instance. -forecast_group_arn | String | The ARN of the forecast group. -forecast_group_version | Number | The version of the forecast group. A new version is created every time a change is made to a forecast group, for example, addition of new queues. -forecast_group_name | String | The name of the forecast group. -instance_arn | String | The ARN of the Connect Customer instance. -is_deleted | Boolean | Whether the forecast group is deleted. -last_updated_timestamp | String | The epoch Timestamp in milliseconds when the last time the forecast group was created/updated/deleted. -data_lake_last_processed_timestamp | Timestamp | The Timestamp for the last time the data lake processed the record. This can include transformation and backfill processes. This field cannot be used to determine reliably data freshness. +instance_id | String | No | The identifier of the Connect Customer instance. +forecast_group_arn | String | No | The ARN of the forecast group. +forecast_group_version | Number | No | The version of the forecast group. A new version is created every time a change is made to a forecast group, for example, addition of new queues. +forecast_group_name | String | Yes | The name of the forecast group. +instance_arn | String | Yes | The ARN of the Connect Customer instance. +is_deleted | Boolean | Yes | Whether the forecast group is deleted. +last_updated_timestamp | String | Yes | The epoch Timestamp in milliseconds when the last time the forecast group was created/updated/deleted. +data_lake_last_processed_timestamp | Timestamp | Yes | The Timestamp for the last time the data lake processed the record. This can include transformation and backfill processes. This field cannot be used to determine reliably data freshness. @@ -73 +86,15 @@ data_lake_last_processed_timestamp | Timestamp | The Timestamp for the last ti -Table name: long_term_forecasts +**Table name:** `long_term_forecasts` + +**Description:** Contains long-term (daily interval) forecast data including contact volume and average handle time predictions, with support for customer-applied overrides. + +**Primary key:** `instance_id, long_term_forcast_id` + +**Join keys:** + + * `instance_id` — Joins to all tables + + * `forecast_group_arn, forecast_group_version` — Joins to forecast_groups + + * `queue_id` — Joins to Agent Queue Statistic Record + + @@ -75 +101,0 @@ Table name: long_term_forecasts -Composite primary key: {instance_id, long_term_forcast_id} @@ -79,19 +105,19 @@ Column | Type | Description -instance_id | String | The ID of the Connect Customer instance -long_term_forcast_id | String | Unique Identifier of the forecast data row. Key is hash of multiple values: instanceId, forecastGroupId, forecastGroupVersion, forecastType, queueId, channel, forecastStarttime, creationTime. -forecast_group_arn | String | The ARN of the forecast group. -forecast_group_version | Number | The version of the forecast group. -interval | String | Time interval of the forecast data. For example, Daily for long term forecast data. -queue_id | String | The ID of the queue for the forecast. -channel | String | The channel of the forecast. For example, VOICE. -forecast_interval_start_time_ms | Timestamp | Epoch in milliseconds of the start time of the time interval for this data row. -creation_timestamp_ms | Timestamp | Epoch in milliseconds of when this forecast is first computed or published. -computed_timestamp_ms | Timestamp | Epoch in milliseconds of when this forecast is first computed. -published_timestamp_ms | Timestamp | Epoch in milliseconds of when this forecast is first published. -timezone | String | The timezone of the forecast, for example, UTC. -is_published | Boolean | Whether this forecast is published or not. -average_handle_time | Number | The average handle time metric value of the forecast data row. -contact_volume | Number | The contact volume metric value of the forecast data row. -average_handle_time_override | Number | The customer applied override value of the average handle time metric. -contact_volume_override | Number | The customer applied override value of the contact volume metric value. -instance_arn | String | The ARN of the Connect Customer instance of the forecast. -data_lake_last_processed_timestamp | Timestamp | The Timestamp for the last time the data lake processed the record. This can include transformation and backfill processes. This field cannot be used to determine reliably data freshness. +instance_id | String | No | The ID of the Connect Customer instance +long_term_forcast_id | String | Yes | Unique Identifier of the forecast data row. Key is hash of multiple values: instanceId, forecastGroupId, forecastGroupVersion, forecastType, queueId, channel, forecastStarttime, creationTime. +forecast_group_arn | String | Yes | The ARN of the forecast group. +forecast_group_version | Number | Yes | The version of the forecast group. +interval | String | Yes | Time interval of the forecast data. For example, Daily for long term forecast data. +queue_id | String | Yes | The ID of the queue for the forecast. +channel | String | Yes | The channel of the forecast. For example, VOICE. +forecast_interval_start_time_ms | Timestamp | Yes | Epoch in milliseconds of the start time of the time interval for this data row. +creation_timestamp_ms | Timestamp | Yes | Epoch in milliseconds of when this forecast is first computed or published. +computed_timestamp_ms | Timestamp | Yes | Epoch in milliseconds of when this forecast is first computed. +published_timestamp_ms | Timestamp | Yes | Epoch in milliseconds of when this forecast is first published. +timezone | String | Yes | The timezone of the forecast, for example, UTC. +is_published | Boolean | Yes | Whether this forecast is published or not. +average_handle_time | Number | Yes | The average handle time metric value of the forecast data row. +contact_volume | Number | Yes | The contact volume metric value of the forecast data row. +average_handle_time_override | Number | Yes | The customer applied override value of the average handle time metric. +contact_volume_override | Number | Yes | The customer applied override value of the contact volume metric value. +instance_arn | String | Yes | The ARN of the Connect Customer instance of the forecast. +data_lake_last_processed_timestamp | Timestamp | Yes | The Timestamp for the last time the data lake processed the record. This can include transformation and backfill processes. This field cannot be used to determine reliably data freshness. @@ -101 +127,15 @@ data_lake_last_processed_timestamp | Timestamp | The Timestamp for the last time -Table name: short_term_forecasts +**Table name:** `short_term_forecasts` + +**Description:** Contains short-term (15-minute interval) forecast data including contact volume and average handle time predictions, with support for customer-applied overrides. + +**Primary key:** `instance_id, short_term_forecast_id` + +**Join keys:** + + * `instance_id` — Joins to all tables + + * `forecast_group_arn, forecast_group_version` — Joins to forecast_groups + + * `queue_id` — Joins to Agent Queue Statistic Record + + @@ -103 +142,0 @@ Table name: short_term_forecasts -Composite primary key: {instance_id, short_term_forecast_id} @@ -107,18 +146,18 @@ Column | Type | Description -instance_id | String | The ID of the Connect Customer instance. -short_term_forecast_id | String | Unique Identifier of the forecast data row. Key is hash of multiple values: instanceId, forecastGroupId, forecastGroupVersion, forecastType, queueId, channel, forecastStarttime, creationTime. -forecast_group_arn | String | The ARN of the forecast group for the forecast data row. -forecast_group_version | Number | The version of the forecast group. -interval | String | Time interval of the forecast data row. For example, FIFTEEN_MINUTES for short term 15 minutes forecast data row. -queue_id | String | The ID of the queue for the forecast. -channel | String | The channel of this forecast, for example, VOICE. -forecast_interval_start_time_ms | Timestamp | Epoch in milliseconds of the start time of the time interval for this data row. -creation_timestamp_ms | Timestamp | Epoch in milliseconds of when this forecast is first computed or published. -computed_timestamp_ms | Timestamp | Epoch in milliseconds of when this forecast is first computed. -published_timestamp_ms | Timestamp | Epoch in milliseconds of when this forecast is first published. -is_published | Boolean | Whether this forecast is published or not. -average_handle_time | Number | The average handle time metric value of the forecast data row. -contact_volume | Number | The contact volume metric value of the forecast data row. -average_handle_time_override | Number | The customer applied override value of the average handle time metric. -contact_volume_override | Number | The customer applied override value of the contact volume metric value. -instance_arn | String | The ARN of the Connect Customer instance of the forecast. -data_lake_last_processed_timestamp | Timestamp | The Timestamp for the last time the data lake processed the record. This can include transformation and backfill processes. This field cannot be used to determine reliably data freshness. +instance_id | String | No | The ID of the Connect Customer instance. +short_term_forecast_id | String | Yes | Unique Identifier of the forecast data row. Key is hash of multiple values: instanceId, forecastGroupId, forecastGroupVersion, forecastType, queueId, channel, forecastStarttime, creationTime. +forecast_group_arn | String | Yes | The ARN of the forecast group for the forecast data row. +forecast_group_version | Number | Yes | The version of the forecast group. +interval | String | Yes | Time interval of the forecast data row. For example, FIFTEEN_MINUTES for short term 15 minutes forecast data row. +queue_id | String | Yes | The ID of the queue for the forecast. +channel | String | Yes | The channel of this forecast, for example, VOICE. +forecast_interval_start_time_ms | Timestamp | Yes | Epoch in milliseconds of the start time of the time interval for this data row. +creation_timestamp_ms | Timestamp | Yes | Epoch in milliseconds of when this forecast is first computed or published. +computed_timestamp_ms | Timestamp | Yes | Epoch in milliseconds of when this forecast is first computed. +published_timestamp_ms | Timestamp | Yes | Epoch in milliseconds of when this forecast is first published. +is_published | Boolean | Yes | Whether this forecast is published or not. +average_handle_time | Number | Yes | The average handle time metric value of the forecast data row. +contact_volume | Number | Yes | The contact volume metric value of the forecast data row. +average_handle_time_override | Number | Yes | The customer applied override value of the average handle time metric. +contact_volume_override | Number | Yes | The customer applied override value of the contact volume metric value. +instance_arn | String | Yes | The ARN of the Connect Customer instance of the forecast. +data_lake_last_processed_timestamp | Timestamp | Yes | The Timestamp for the last time the data lake processed the record. This can include transformation and backfill processes. This field cannot be used to determine reliably data freshness. @@ -128 +167 @@ data_lake_last_processed_timestamp | Timestamp | The Timestamp for the last time -Table name: intraday_forecasts +**Table name:** `intraday_forecasts` @@ -130 +169 @@ Table name: intraday_forecasts -Composite primary key: {instance_id, intraday_forecast_id} +**Description:** Contains intraday forecast data including forecasted contact volume, average handle time, queue answer time, and effective agent staffing for real-time workforce adjustments. @@ -132,15 +171,28 @@ Composite primary key: {instance_id, intraday_forecast_id} -**Column** | **Type** | **Description** ----|---|--- -intraday_forecast_id | string | Unique identifier of this intraday forecast data. -aws_account_id | string | The identifier of the AWS account that owns the Intraday Forecast. -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. -instance_arn | string | Instance ARN of the Connect Customer instance. -channel | string | The method used to contact your contact center. -queue_arn | string | The Amazon Resource Name of the queue. -forecast_interval_start_time | Timestamp | Start Timestamp of the forecast interval. -creation_timestamp | Timestamp | When the forecast was computed in forecasting system. -average_handle_time | Double | Forecasted metric data: average handle time. -average_queue_answer_time | Double | Forecasted metric data: average queue answer time. -contact_volume | Double | Forecasted metric data: contact volume. -effective_agent_staffing | Double | Forecasted metric data: effective agent staffing. -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. +**Primary key:** `instance_id, intraday_forecast_id` + +**Partition key:** `forecast_interval_start_timestamp` (daily) + +**Join keys:** + + * `instance_id` — Joins to all tables + + * `queue_arn` — Joins to Agent Queue Statistic Record (via queue ARN and ID mapping) + + + + +**Column** | **Type** | **Nullable** | **Description** +---|---|---|--- +intraday_forecast_id | string | No | Unique identifier of this intraday forecast data. +aws_account_id | string | Yes | The identifier of the AWS account that owns the Intraday Forecast. +instance_id | string | No | 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. +instance_arn | string | Yes | Instance ARN of the Connect Customer instance. +channel | string | Yes | The method used to contact your contact center. +queue_arn | string | Yes | The Amazon Resource Name of the queue. +forecast_interval_start_time | Timestamp | Yes | Start Timestamp of the forecast interval. +creation_timestamp | Timestamp | Yes | When the forecast was computed in forecasting system. +average_handle_time | Double | Yes | Forecasted metric data: average handle time.