AWS cli documentation change
Summary
Updated AWS CLI version reference from 2.34.28 to 2.34.29 and significantly expanded documentation for the GetMetricDataV2 command's filtering capabilities. Added comprehensive list of valid filter keys, clarified authorization requirements, added limits (5 filter keys, 100 filter values), and enhanced documentation for AI-related metrics with links to definitions.
Security assessment
The changes are primarily documentation improvements and feature updates. While the documentation mentions that certain filter keys 'are used for authorizing requests,' this appears to be describing existing authorization mechanisms rather than addressing a specific security vulnerability or weakness. There is no evidence of security patches, vulnerability disclosures, or incident response in the diff.
Diff
diff --git a/cli/latest/reference/connect/get-metric-data-v2.md b/cli/latest/reference/connect/get-metric-data-v2.md index f871003e4..c970ef309 100644 --- a//cli/latest/reference/connect/get-metric-data-v2.md +++ b//cli/latest/reference/connect/get-metric-data-v2.md @@ -15 +15 @@ - * [AWS CLI 2.34.28 Command Reference](../../index.html) » + * [AWS CLI 2.34.29 Command Reference](../../index.html) » @@ -201 +201 @@ JSON Syntax: -> The filters to apply to returned metrics. You can filter on the following resources: +> Filtering is an operation that selects records that match a set of specified criteria. By narrowing the dataset before aggregation, filters ensure that only relevant records are included in the computation. @@ -203,8 +203 @@ JSON Syntax: -> * Agents -> * Campaigns -> * Channels -> * Feature -> * Queues -> * Routing profiles -> * Routing step expression -> * User hierarchy groups +>> **Filter keys** @@ -212 +205 @@ JSON Syntax: - +> The following are valid filter keys for a `GetMetricDataV2` request: @@ -214 +207 @@ JSON Syntax: -> At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups. +>> `AGENT` | `AGENT_HIERARCHY_LEVEL_ONE` | `AGENT_HIERARCHY_LEVEL_TWO` | `AGENT_HIERARCHY_LEVEL_THREE` | `AGENT_HIERARCHY_LEVEL_FOUR` | `AGENT_HIERARCHY_LEVEL_FIVE` | `ANSWERING_MACHINE_DETECTION_STATUS` | `BOT_ALIAS` | `BOT_ID` | `BOT_INTENT_NAME` | `BOT_LOCALE` | `BOT_VERSION` | `CAMPAIGN` | `CAMPAIGN_DELIVERY_EVENT_TYPE` | `CAMPAIGN_EXCLUDED_EVENT_TYPE` | `CASE_STATUS` | `CASE_TEMPLATE_ARN` | `CHANNEL` | `contact/segmentAttributes/connect:Subtype` | `contact/segmentAttributes/connect:ValidationTestType` | `DISCONNECT_REASON` | `EVALUATION_FORM` | `EVALUATION_QUESTION` | `EVALUATION_SECTION` | `EVALUATION_SOURCE` | `EVALUATOR_ID` | `FEATURE` | `FLOW_ACTION_ID` | `FLOW_TYPE` | `FLOWS_MODULE_RESOURCE_ID` | `FLOWS_NEXT_RESOURCE_ID` | `FLOWS_NEXT_RESOURCE_QUEUE_ID` | `FLOWS_OUTCOME_TYPE` | `FLOWS_RESOURCE_ID` | `FORM_VERSION` | `INITIATING_FLOW` | `INITIATION_METHOD` | `INVOKING_RESOURCE_PUBLISHED_TIMESTAMP` | `INVOKING_RESOURCE_TYPE` | `PARENT_FLOWS_RESOURCE_ID` | `Q_CONNECT_ENABLED` | `QUEUE` | `RESOURCE_PUBLISHED_TIMESTAMP` | `ROUTING_PROFILE` | `ROUTING_STEP_EXPRESSION` | `TEST_CASE` | `TEST_CASE_EXECUTION_FAILURE_REASON` | `TEST_CASE_EXECUTION_RESULT` | `TEST_CASE_EXECUTION_STATE` @@ -216 +209 @@ JSON Syntax: -> For metrics for outbound campaigns analytics, you can also use campaigns to satisfy at least one filter requirement. +> ### Note @@ -218 +211,5 @@ JSON Syntax: -> To filter by phone number, see [Create a historical metrics report](https://docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html) in the _Amazon Connect Administrator Guide_ . +>> The following filter keys correspond to Amazon Connect resources and are used for authorizing requests. A `GetMetricDataV2` request requires at least one of these filters: +>> +>>> `QUEUE` , `ROUTING_PROFILE` , `AGENT` , `AGENT_HIERARCHY_LEVEL_ONE` , `AGENT_HIERARCHY_LEVEL_TWO` , `AGENT_HIERARCHY_LEVEL_THREE` , `AGENT_HIERARCHY_LEVEL_FOUR` , `AGENT_HIERARCHY_LEVEL_FIVE` , `CAMPAIGN` , `EVALUATION_FORM` , `EVALUATOR_ID` +>> +>> You can use up to 5 filter keys in a single request, and up to 100 filter values across all filter keys. @@ -220 +217 @@ JSON Syntax: -> Note the following limits: +> **Filter values** @@ -222,2 +219,5 @@ JSON Syntax: -> * **Filter keys** : A maximum of 5 filter keys are supported in a single request. Valid filter keys: `AGENT` | `AGENT_HIERARCHY_LEVEL_FIVE` | `AGENT_HIERARCHY_LEVEL_FOUR` | `AGENT_ HIERARCHY_LEVEL_ONE` | `AGENT_HIERARCHY_LEVEL_THREE` | `AGENT_HIERARCHY_LEVEL_TWO` | `ANSWERING_MACHINE_DETECTION_STATUS` | `BOT_ALIAS` | `BOT_ID` | `BOT_INTENT_NAME` | `BOT_LOCALE` | `BOT_VERSION` | `CAMPAIGN` | `CAMPAIGN_DELIVERY_EVENT_TYPE` | `CAMPAIGN_EXCLUDED_EVENT_TYPE` | `CASE_STATUS` | `CASE_TEMPLATE_ARN` | `CHANNEL` | `contact/segmentAttributes/connect:Subtype` | `contact/segmentAttributes/connect:ValidationTestType` | `DISCONNECT_REASON` | `EVALUATION_FORM` | `EVALUATION_QUESTION` | `EVALUATION_SECTION` | `EVALUATION_SOURCE` | `EVALUATOR_ID` | `FEATURE` | `FLOW_ACTION_ID` | `FLOW_TYPE` | `FLOWS_MODULE_RESOURCE_ID` | `FLOWS_NEXT_RESOURCE_ID` | `FLOWS_NEXT_RESOURCE_QUEUE_ID` | `FLOWS_OUTCOME_TYPE` | `FLOWS_RESOURCE_ID` | `FORM_VERSION` | `INITIATING_FLOW` | `INITIATION_METHOD` | `INVOKING_RESOURCE_PUBLISHED_TIMESTAMP` | `INVOKING_RESOURCE_TYPE` | `PARENT_FLOWS_RESOURCE_ID` | `Q_CONNECT_ENABLED` | `QUEUE` | `RESOURCE_PUBLISHED_ TIMESTAMP` | `ROUTING_PROFILE` | `ROUTING_STEP_EXPRESSION` | `TEST_CASE` | `TEST_ CASE_EXECUTION_FAILURE_REASON` | `TEST_CASE_EXECUTION_RESULT` | `TEST_CASE_EXECUTION_STATE` -> * **Filter values** : A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid `filterValue` for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters. `contact_lens_conversational_analytics` is a valid filterValue for the `FEATURE` filter key. It is available only to contacts analyzed by Contact Lens conversational analytics. `connect:Chat` , `connect:SMS` , `connect:Telephony` , and `connect:WebRTC` are valid `filterValue` examples (not exhaustive) for the `contact/segmentAttributes/connect:Subtype filter` key. `ROUTING_STEP_EXPRESSION` is a valid filter key with a filter value up to 3000 length. This filter is case and order sensitive. JSON string fields must be sorted in ascending order and JSON array order should be kept as is. `Q_CONNECT_ENABLED` . TRUE and FALSE are the only valid filterValues for the `Q_CONNECT_ENABLED` filter key. +> * VOICE, CHAT, TASK, and EMAIL are valid filter values for the `CHANNEL` filter key. They do not count towards the limit of 100 filter values. For example, a `GetMetricDataV2` request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 4 channel filters. +> * `contact_lens_conversational_analytics` is a valid filter value for the `FEATURE` filter key. It is available only for contacts analyzed by Contact Lens conversational analytics. +> * `connect:Chat` , `connect:SMS` , `connect:Telephony` , and `connect:WebRTC` are valid filter value examples (not exhaustive) for the `contact/segmentAttributes/connect:Subtype` filter key. +> * `ROUTING_STEP_EXPRESSION` accepts a filter value up to 3,000 characters in length. This filter is case-sensitive and order-sensitive. JSON string fields must be sorted in ascending order, and JSON array order must be preserved. +> * TRUE and FALSE are the only valid filter values for the `Q_CONNECT_ENABLED` filter key. @@ -225,2 +225,4 @@ JSON Syntax: -> * FALSE includes all contacts that did not have Connect AI Agents enabled as part of the flow -> * EXPERIENCE_VALIDATION and FLOW_VALIDATION are the only valid filterValues for the contact/segmentAttributes/connect:ValidationTestType filter key +> * FALSE includes all contacts that did not have Connect AI Agents enabled as part of the flow. +> * `EXPERIENCE_VALIDATION` and `FLOW_VALIDATION` are the only valid filter values for the `contact/segmentAttributes/connect:ValidationTestType` filter key. This filter is available only for contact record-driven metrics. +> * [Campaign](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-outbound-campaigns_Campaign.html) ARNs are valid filter values for the `CAMPAIGN` filter key. +> * To filter by phone number, see [Create a historical metrics report](https://docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html) in the _Amazon Connect Administrator Guide_ . @@ -229,4 +230,0 @@ JSON Syntax: -> -> This filter is available only for contact record-driven metrics. -> ->> [Campaign](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-outbound-campaigns_Campaign.html) ARNs are valid `filterValues` for the `CAMPAIGN` filter key. @@ -629 +627 @@ Syntax: -> UI name: Active AI Agents +> UI name: [Active AI Agents](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#active-ai-agents) @@ -637 +635 @@ Syntax: -> UI name: Handoff Rate +> UI name: [AI Handoff Rate](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#ai-handoff-rate) @@ -645 +643 @@ Syntax: -> UI name: AI Handoff Count +> UI name: [AI Handoffs](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#ai-handoffs) @@ -653 +651 @@ Syntax: -> UI name: AI Agent Invocation Success Count +> UI name: [AI Agent Invocation Success](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#ai-agent-invocation-success) @@ -665 +663 @@ Syntax: -> UI name: AI Agent Invocation Success Rate +> UI name: [AI Agent Invocation Success Rate](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#ai-agent-invocation-success-rate) @@ -677 +675 @@ Syntax: -> UI name: AI Agent Invocation Count +> UI name: [AI Agent Invocations](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#ai-agent-invocations) @@ -689 +687 @@ Syntax: -> UI name: AI Response Completion Rate +> UI name: [AI Response Completion Rate](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#ai-response-completion-rate) @@ -697 +695 @@ Syntax: -> UI name: AI Contacts +> UI name: [AI Involved Contacts](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#ai-involved-contacts) @@ -705 +703 @@ Syntax: -> UI name: AI Prompt Invocation Success Count +> UI name: [AI Prompt Invocation Success](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#ai-prompt-invocation-success) @@ -717 +715,37 @@ Syntax: -> UI name: AI Prompt Invocation Success Rate +> UI name: [AI Prompt Invocation Success Rate](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#ai-prompt-invocation-success-rate) +> +> ### Note +> +> AI Agent Name Version is not a valid filter but a valid grouping. +> +> AI_PROMPT_INVOCATIONS +> +> Unit: Count +> +> Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Prompt, AI Prompt ID, AI Prompt Name, AI Prompt Type, AI Use Case, Channel, Queue, Routing Profile +> +> UI name: [AI Prompt Invocations](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#ai-prompt-invocations) +> +> ### Note +> +> AI Agent Name Version is not a valid filter but a valid grouping. +> +> AI_TOOL_INVOCATION_SUCCESS +> +> Unit: Count +> +> Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Tool ID, AI Tool Name, AI Tool Type, AI Use Case, Channel, Queue, Routing Profile +> +> UI name: [AI Tool Invocation Success](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#ai-tool-invocation-success) +> +> ### Note +> +> AI Agent Name Version is not a valid filter but a valid grouping. +> +> AI_TOOL_INVOCATION_SUCCESS_RATE +> +> Unit: Percent +> +> Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Tool ID, AI Tool Name, AI Tool Type, AI Use Case, Channel, Queue, Routing Profile +> +> UI name: [AI Tool Invocation Success Rate](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#ai-tool-invocation-success-rate) @@ -729 +763 @@ Syntax: -> UI name: AI Tool Invocation Count +> UI name: [AI Tool Invocations](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#ai-tool-invocations) @@ -741 +775 @@ Syntax: -> UI name: Average AI Agent Conversation Turns +> UI name: [Average AI Agent Conversation Turns](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-ai-agent-conversation-turns) @@ -753 +787 @@ Syntax: -> UI name: AI Conversation Turns +> UI name: [Average AI Conversation Turns](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-ai-conversation-turns) @@ -761 +795 @@ Syntax: -> UI name: Average AI Prompt Invocation Latency +> UI name: [Average AI Prompt Invocation Latency](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-ai-prompt-invocation-latency) @@ -773 +807 @@ Syntax: -> UI name: Average AI Tool Invocation Latency +> UI name: [Average AI Tool Invocation Latency](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-ai-tool-invocation-latency) @@ -785 +819 @@ Syntax: -> UI name: KnowledgeBase Reference Count +> UI name: [Knowledge Content References](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#knowledge-content-references) @@ -793 +827 @@ Syntax: -> UI name: Proactive Intent Engagement Rate +> UI name: [Proactive Intent Engagement Rate](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#proactive-intents-engagement-rate) @@ -801 +835 @@ Syntax: -> UI name: Proactive Intent Response Rate +> UI name: [Proactive Intent Response Rate](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#proactive-intents-response-rate) @@ -809 +843 @@ Syntax: -> UI name: Proactive Intents Answered +> UI name: [Proactive Intents Answered](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#proactive-intents-answered) @@ -817,13 +851 @@ Syntax: -> UI name: Proactive Intents Detected -> -> Unit: -> -> Valid groupings and filters: -> -> UI name: -> -> Unit: -> -> Valid groupings and filters: -> -> UI name: +> UI name: [Proactive Intents Detected](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#proactive-intents-detected) @@ -837 +859 @@ Syntax: -> UI name: UI name: +> UI name: [Proactive Intents Engaged](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#proactive-intents-engaged) @@ -2205 +2227 @@ MetricResults -> (list) - * [AWS CLI 2.34.28 Command Reference](../../index.html) » + * [AWS CLI 2.34.29 Command Reference](../../index.html) »