AWS cli documentation change
Summary
Updated metric documentation with UI names and detailed links to Amazon Connect Administrator Guide. Added comprehensive metric definitions and mappings between CLI metric names and their corresponding UI names.
Security assessment
The changes are documentation improvements adding UI name mappings and metric descriptions. There is no evidence of addressing security vulnerabilities or describing security features. Changes focus on usability and clarity of metric definitions rather than security aspects.
Diff
diff --git a/cli/latest/reference/connect/get-metric-data.md b/cli/latest/reference/connect/get-metric-data.md index 8cebf18e7..d39062d4a 100644 --- a//cli/latest/reference/connect/get-metric-data.md +++ b//cli/latest/reference/connect/get-metric-data.md @@ -15 +15 @@ - * [AWS CLI 2.28.4 Command Reference](../../index.html) » + * [AWS CLI 2.28.6 Command Reference](../../index.html) » @@ -210,0 +211,2 @@ Syntax: +> UI name: [Average queue abandon time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time) +> @@ -216,0 +219,2 @@ Syntax: +> UI name: [After contact work time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#after-contact-work-time) +> @@ -222,0 +227,10 @@ Syntax: +> UI name: [API contacts handled](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#api-contacts-handled) +> +>> AVG_HOLD_TIME +> +> Unit: SECONDS +> +> Statistic: AVG +> +> UI name: [Average customer hold time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-hold-time) +> @@ -228,0 +243,2 @@ Syntax: +> UI name: [Callback contacts handled](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#callback-contacts-handled) +> @@ -234,0 +251,2 @@ Syntax: +> UI name: [Contacts abandoned](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-abandoned) +> @@ -240,0 +259,2 @@ Syntax: +> UI name: [Contacts agent hung up first](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-agent-hung-up-first) +> @@ -246,0 +267,2 @@ Syntax: +> UI name: [Contacts consulted](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-consulted) +> @@ -252,0 +275,2 @@ Syntax: +> UI name: [Contacts handled](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled) +> @@ -258,0 +283,2 @@ Syntax: +> UI name: [Contacts handled incoming](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-incoming) +> @@ -264,0 +291,2 @@ Syntax: +> UI name: [Contacts handled outbound](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-outbound) +> @@ -270,0 +299,2 @@ Syntax: +> UI name: [Contacts hold disconnect](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-disconnect) +> @@ -276,0 +307,2 @@ Syntax: +> UI name: [AGENT_NON_RESPONSE](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-response) +> @@ -282,0 +315,2 @@ Syntax: +> UI name: [Contacts queued](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-queued) +> @@ -288,0 +323,2 @@ Syntax: +> UI name: [Contacts transferred in](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-in) +> @@ -294,0 +331,2 @@ Syntax: +> UI name: [Contacts transferred out queue](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue) +> @@ -300,0 +339,2 @@ Syntax: +> UI name: [Contacts transferred out](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out) +> @@ -306,0 +347,2 @@ Syntax: +> UI name: [Contacts transferred out queue](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue) +> @@ -313,5 +355 @@ Syntax: ->> HOLD_TIME -> -> Unit: SECONDS -> -> Statistic: AVG +> UI name: [Average handle time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-handle-time) @@ -324,0 +363,2 @@ Syntax: +> UI name: [Average agent interaction and customer hold time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interaction-and-customer-hold-time) +> @@ -330,0 +371,2 @@ Syntax: +> UI name: [Average agent interaction time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#aaverage-agent-interaction-time) +> @@ -336,0 +379,2 @@ Syntax: +> UI name: [Occupancy](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#occupancy) +> @@ -342,0 +387,2 @@ Syntax: +> UI name: [Average queue answer time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html##average-queue-answer-time) +> @@ -348,0 +395,2 @@ Syntax: +> UI name: [Minimum flow time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#minimum-flow-time) +> @@ -358,0 +407,2 @@ Syntax: +> UI name: [Average queue abandon time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time) +> @@ -361 +411 @@ Syntax: ->> Contains information about a historical metric. For a description of each metric, see [Metrics definitions](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html) in the _Amazon Connect Administrator Guide_ . +>> Contains information about a historical metric. @@ -365 +415,205 @@ Syntax: ->>> The name of the metric. +>>> The name of the metric. Following is a list of each supported metric mapped to the UI name, linked to a detailed description in the _Amazon Connect Administrator Guide_ . +>>> +>>>> ABANDON_TIME +>>> +>>> Unit: SECONDS +>>> +>>> Statistic: AVG +>>> +>>> UI name: [Average queue abandon time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time) +>>> +>>>> AFTER_CONTACT_WORK_TIME +>>> +>>> Unit: SECONDS +>>> +>>> Statistic: AVG +>>> +>>> UI name: [After contact work time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#after-contact-work-time) +>>> +>>>> API_CONTACTS_HANDLED +>>> +>>> Unit: COUNT +>>> +>>> Statistic: SUM +>>> +>>> UI name: [API contacts handled](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#api-contacts-handled) +>>> +>>>> AVG_HOLD_TIME +>>> +>>> Unit: SECONDS +>>> +>>> Statistic: AVG +>>> +>>> UI name: [Average customer hold time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-hold-time) +>>> +>>>> CALLBACK_CONTACTS_HANDLED +>>> +>>> Unit: COUNT +>>> +>>> Statistic: SUM +>>> +>>> UI name: [Callback contacts handled](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#callback-contacts-handled) +>>> +>>>> CONTACTS_ABANDONED +>>> +>>> Unit: COUNT +>>> +>>> Statistic: SUM +>>> +>>> UI name: [Contacts abandoned](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-abandoned) +>>> +>>>> CONTACTS_AGENT_HUNG_UP_FIRST +>>> +>>> Unit: COUNT +>>> +>>> Statistic: SUM +>>> +>>> UI name: [Contacts agent hung up first](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-agent-hung-up-first) +>>> +>>>> CONTACTS_CONSULTED +>>> +>>> Unit: COUNT +>>> +>>> Statistic: SUM +>>> +>>> UI name: [Contacts consulted](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-consulted) +>>> +>>>> CONTACTS_HANDLED +>>> +>>> Unit: COUNT +>>> +>>> Statistic: SUM +>>> +>>> UI name: [Contacts handled](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled) +>>> +>>>> CONTACTS_HANDLED_INCOMING +>>> +>>> Unit: COUNT +>>> +>>> Statistic: SUM +>>> +>>> UI name: [Contacts handled incoming](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-incoming) +>>> +>>>> CONTACTS_HANDLED_OUTBOUND +>>> +>>> Unit: COUNT +>>> +>>> Statistic: SUM +>>> +>>> UI name: [Contacts handled outbound](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-outbound) +>>> +>>>> CONTACTS_HOLD_ABANDONS +>>> +>>> Unit: COUNT +>>> +>>> Statistic: SUM +>>> +>>> UI name: [Contacts hold disconnect](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-disconnect) +>>> +>>>> CONTACTS_MISSED +>>> +>>> Unit: COUNT +>>> +>>> Statistic: SUM +>>>