AWS connect documentation change
Summary
Enhanced documentation for bot data tables (bot_conversations, bot_intents, bot_slots) with added metadata sections (description, primary key, partition key, join keys) and new 'nullable' indicators in column definitions.
Security assessment
Changes only improve table schema documentation by adding descriptive metadata and data modeling details. No security vulnerabilities, configurations, or security features are mentioned. Added 'nullable' column indicators help understand data structure but don't relate to security controls.
Diff
diff --git a/connect/latest/adminguide/data-lake-botdata.md b/connect/latest/adminguide/data-lake-botdata.md index ef7e185fc..4f5969a87 100644 --- a//connect/latest/adminguide/data-lake-botdata.md +++ b//connect/latest/adminguide/data-lake-botdata.md @@ -37 +37,19 @@ If you are unable to access the scheduling tables by using Option 1, try using O -Table name: bot_conversations +**Table name:** `bot_conversations` + +**Description:** Records bot conversation sessions including conversation outcomes, turn counts, and associated flow and contact context for Lex bot interactions. + +**Primary key:** `instance_id, event_id` + +**Partition key:** `bot_conversation_start_timestamp` (daily) + +**Join keys:** + + * `instance_id` — Joins to all tables + + * `contact_id` — Joins to Contact Record + + * `flow_resource_id` — Joins to Contact Flow Events + + * `bot_originating_request_id`, `bot_session_id` — Joins to bot_intents + + @@ -39 +56,0 @@ Table name: bot_conversations -Composite primary key: {instance_id, event_id} @@ -43,29 +60,29 @@ Column | Type | Description -event_id | String | This is the primary key of the table. This will be a hash of originating request identifier and session identifier. -bot_originating_request_id | String | A unique identifier for a specific bot request. -bot_session_id | String | The identifier of the user session that is having the conversation. -aws_account_id | String | The identifier of the AWS account that owns the contact. -instance_arn | String | The ARN of the Connect Customer instance. -instance_id | String | The identifier of the Connect Customer instance. -invoking_resource_type | String | Can be flow or module. -flow_resource_id | String | Flow identifier. -module_resource_id | String | Module identifier. -invoking_resource_start_timestamp | Timestamp | Time at which flow started. -parent_flow_resource_id | String | Flow Id from which the module was invoked from. This field will only be populated for modules. -contact_id | String | The identifier of the contact. -flow_action_id | String | Identifier for action that was executed. An Action is a single step of a flow's run. -invoking_resource_published_timestamp | Timestamp | "Creation" or "revision" date of the flow itself. -flow_type | String | Connect Customer includes a set of nine flow types. For more information, see [Choose a flow type](./create-contact-flow.html#contact-flow-types). -channel | String | The method used to contact your contact center: VOICE, CHAT, TASK. -sub_type | String | This subtype for the contact. For example, connect:Guide or connect:SMS. -initiation_method | String | Indicates how the contact was initiated. -flow_language_version | String | Flow language version. -invoking_resource_version | String | Version of the contact flow used. -bot_id | String | The identifier of the bot. -bot_alias_id | String | The alias identifier of the bot that the session was held with. -bot_version | String | The version of the bot that the session was held with. -bot_locale | String | Language configuration of the bot. -bot_conversation_start_timestamp | Timestamp | The Timestamp marking the start of the conversation with the bot. -bot_conversation_end_timestamp | Timestamp | The Timestamp marking the end of the conversation with the bot. -bot_conversation_outcome | String | The final state of the conversation. Values: Success | Failure | Dropped -bot_number_of_conversation_turns | Number | The number of turns that the session took. -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. +event_id | String | No | This is the primary key of the table. This will be a hash of originating request identifier and session identifier. +bot_originating_request_id | String | Yes | A unique identifier for a specific bot request. +bot_session_id | String | Yes | The identifier of the user session that is having the conversation. +aws_account_id | String | Yes | The identifier of the AWS account that owns the contact. +instance_arn | String | Yes | The ARN of the Connect Customer instance. +instance_id | String | No | The identifier of the Connect Customer instance. +invoking_resource_type | String | Yes | Can be flow or module. +flow_resource_id | String | Yes | Flow identifier. +module_resource_id | String | Yes | Module identifier. +invoking_resource_start_timestamp | Timestamp | Yes | Time at which flow started. +parent_flow_resource_id | String | Yes | Flow Id from which the module was invoked from. This field will only be populated for modules. +contact_id | String | Yes | The identifier of the contact. +flow_action_id | String | Yes | Identifier for action that was executed. An Action is a single step of a flow's run. +invoking_resource_published_timestamp | Timestamp | Yes | "Creation" or "revision" date of the flow itself. +flow_type | String | Yes | Connect Customer includes a set of nine flow types. For more information, see [Choose a flow type](./create-contact-flow.html#contact-flow-types). +channel | String | Yes | The method used to contact your contact center: VOICE, CHAT, TASK. +sub_type | String | Yes | This subtype for the contact. For example, connect:Guide or connect:SMS. +initiation_method | String | Yes | Indicates how the contact was initiated. +flow_language_version | String | Yes | Flow language version. +invoking_resource_version | String | Yes | Version of the contact flow used. +bot_id | String | Yes | The identifier of the bot. +bot_alias_id | String | Yes | The alias identifier of the bot that the session was held with. +bot_version | String | Yes | The version of the bot that the session was held with. +bot_locale | String | Yes | Language configuration of the bot. +bot_conversation_start_timestamp | Timestamp | Yes | The Timestamp marking the start of the conversation with the bot. +bot_conversation_end_timestamp | Timestamp | Yes | The Timestamp marking the end of the conversation with the bot. +bot_conversation_outcome | String | Yes | The final state of the conversation. Values: Success | Failure | Dropped +bot_number_of_conversation_turns | Number | Yes | The number of turns that the session took. +data_lake_last_processed_timestamp | Timestamp | Yes | 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. @@ -75 +92,19 @@ data_lake_last_processed_timestamp | Timestamp | Timestamp, which shows the last -Table name: bot_intents +**Table name:** `bot_intents` + +**Description:** Records intent-level outcomes for bot conversations, tracking intent names, levels, and resolution status for each bot interaction turn. + +**Primary key:** `instance_id, event_id` + +**Partition key:** `bot_conversation_start_timestamp` (daily) + +**Join keys:** + + * `instance_id` — Joins to all tables + + * `bot_originating_request_id`, `bot_session_id` — Joins to bot_conversations + + * `bot_originating_request_id`, `bot_session_id`, `bot_intent_name`, `bot_intent_level` — Joins to bot_slots + + * `contact_id` — Joins to Contact Record + + @@ -77 +111,0 @@ Table name: bot_intents -Composite primary key: {instance_id, event_id} @@ -81,30 +115,30 @@ Column | Type | Description -event_id | String | This is the primary key of the table. This will be a hash of originating request identifier, session identifier, intent name, and intent level. -bot_originating_request_id | String | A unique identifier for a specific bot request. -bot_session_id | String | The identifier of the user session that is having the conversation. -account_id | String | The identifier of the AWS account that owns the contact. -instance_arn | String | The ARN of the Connect Customer instance. -instance_id | String | The identifier of the Connect Customer instance. -invoking_resource_type | String | Can be flow or module. -flow_resource_id | String | The flow identifier. -module_resource_id | String | The module identifier. -invoking_resource_start_timestamp | Timestamp | The time when the flow started. -parent_flow_resource_id | String | The flow identifier where the module was invoked. This field is only be populated for modules. -contact_id | String | The identifier of the contact. -action_id | String | The identifier for action that was executed. An Action is a single step of a flow's run. -invoking_resource_published_timestamp | Timestamp | The "creation" or "revision" date of the flow itself. -flow_type | String | The type of flow. Connect Customer includes a set of nine flow types. For more information, see [Choose a flow type](./create-contact-flow.html#contact-flow-types). -channel | String | The method used to contact your contact center: VOICE, CHAT, TASK. -sub_type | String | The subtype for the contact. For example, connect:Guide or connect:SMS. -initiation_method | String | How the contact was initiated. -flow_language_version | String | The flow language version. -invoking_resource_version | String | Version of the contact flow used. -bot_id | String | The identifier of the bot. -bot_alias_id | String | The alias identifier of the bot that the session was held. with -bot_version | String | The version of the bot that the session was held with. -bot_locale | String | The language configuration of the bot. -bot_conversation_start_timestamp | Timestamp | The Timestamp marking the start of the conversation with the bot. -bot_conversation_end_timestamp | Timestamp | The Timestamp marking the end of the conversation with the bot. -bot_intent_name | String | The name of the intent. -bot_intent_level | Number | The number of intents up to and including the requested path. -bot_intent_outcome | String | The end state of the intent. Value of Success, Failed, Switched, or Dropped. -data_lake_last_processed_timestamp | Timestamp | The 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. +event_id | String | No | This is the primary key of the table. This will be a hash of originating request identifier, session identifier, intent name, and intent level. +bot_originating_request_id | String | Yes | A unique identifier for a specific bot request. +bot_session_id | String | Yes | The identifier of the user session that is having the conversation. +account_id | String | Yes | The identifier of the AWS account that owns the contact. +instance_arn | String | Yes | The ARN of the Connect Customer instance. +instance_id | String | No | The identifier of the Connect Customer instance. +invoking_resource_type | String | Yes | Can be flow or module. +flow_resource_id | String | Yes | The flow identifier. +module_resource_id | String | Yes | The module identifier. +invoking_resource_start_timestamp | Timestamp | Yes | The time when the flow started. +parent_flow_resource_id | String | Yes | The flow identifier where the module was invoked. This field is only be populated for modules. +contact_id | String | Yes | The identifier of the contact. +action_id | String | Yes | The identifier for action that was executed. An Action is a single step of a flow's run. +invoking_resource_published_timestamp | Timestamp | Yes | The "creation" or "revision" date of the flow itself. +flow_type | String | Yes | The type of flow. Connect Customer includes a set of nine flow types. For more information, see [Choose a flow type](./create-contact-flow.html#contact-flow-types). +channel | String | Yes | The method used to contact your contact center: VOICE, CHAT, TASK. +sub_type | String | Yes | The subtype for the contact. For example, connect:Guide or connect:SMS. +initiation_method | String | Yes | How the contact was initiated. +flow_language_version | String | Yes | The flow language version. +invoking_resource_version | String | Yes | Version of the contact flow used. +bot_id | String | Yes | The identifier of the bot. +bot_alias_id | String | Yes | The alias identifier of the bot that the session was held. with +bot_version | String | Yes | The version of the bot that the session was held with. +bot_locale | String | Yes | The language configuration of the bot. +bot_conversation_start_timestamp | Timestamp | Yes | The Timestamp marking the start of the conversation with the bot. +bot_conversation_end_timestamp | Timestamp | Yes | The Timestamp marking the end of the conversation with the bot. +bot_intent_name | String | Yes | The name of the intent. +bot_intent_level | Number | Yes | The number of intents up to and including the requested path. +bot_intent_outcome | String | Yes | The end state of the intent. Value of Success, Failed, Switched, or Dropped. +data_lake_last_processed_timestamp | Timestamp | Yes | The 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. @@ -114 +148,19 @@ data_lake_last_processed_timestamp | Timestamp | The Timestamp, which shows the -Table name: bot_slots +**Table name:** `bot_slots` + +**Description:** Records slot-level outcomes for bot intent fulfillment, tracking slot resolution status and retry counts for each slot within an intent. + +**Primary key:** `instance_id, event_id` + +**Partition key:** `bot_conversation_start_timestamp` (daily) + +**Join keys:** + + * `instance_id` — Joins to all tables + + * `bot_originating_request_id`, `bot_session_id`, `bot_intent_name`, `bot_intent_level` — Joins to bot_intents + + * `bot_originating_request_id`, `bot_session_id` — Joins to bot_conversations + + * `contact_id` — Joins to Contact Record + + @@ -116 +167,0 @@ Table name: bot_slots -Composite primary key: {instance_id, event_id} @@ -120,33 +171,33 @@ Column | Type | Description -event_id | String | This is the primary key of the table. This will be a hash of originating request identifier, session identifier, intent name, intent level, slot name, and slot level. -bot_originating_request_id | String | A unique identifier for a specific bot request -bot_session_id | String | The identifier of the user session that is having the conversation. -account_id | String | The identifier of the AWS account that owns the contact. -instance_arn | String | The ARN of the Connect Customer instance. -instance_id | String | The identifier of the Connect Customer instance.