get-current-metric-data

Описание

Получает данные метрик в режиме реального времени для указанного экземпляра Amazon Connect.

Описание каждой метрики см. в разделе Определения метрик в руководстве администратора Amazon Connect.

См. также: Документация API AWS

Синтаксис

  get-current-metric-data
--instance-id <value>
--filters <value>
[--groupings <value>]
--current-metrics <value>
[--next-token <value>]
[--max-results <value>]
[--sort-criteria <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--instance-id (строка)

Идентификатор экземпляра Amazon Connect. Идентификатор экземпляра можно найти в имени ресурса (ARN) экземпляра.

--filters (структура)

Фильтры для применения к возвращаемым метрикам. Вы можете фильтровать до следующих пределов:

Очереди: 100
Профили маршрутизации: 100
Каналы: 3 (поддерживаются каналы VOICE, CHAT и TASK)
RoutingStepExpressions: 50

Данные метрик извлекаются только для ресурсов, связанных с очередями или профилями маршрутизации, и по любым каналам, включенным в фильтр. (Вы не можете фильтровать по очереди И профилю маршрутизации.) Вы можете включать как идентификаторы ресурсов, так и ARN ресурсов в одном запросе.

При использовании фильтра RoutingStepExpression, необходимо передать ровно один QueueId. Фильтр также чувствителен к регистру, поэтому при использовании фильтра RoutingStepExpression, группировка по ROUTING_STEP_EXPRESSION обязательна.

В настоящее время тегирование поддерживается только для ресурсов, переданных в фильтре.

Очереди -> (список)

Очереди для фильтрации метрик. Вы должны указать как минимум одну очередь и можете указать до 100 очередей за один запрос. API GetCurrentMetricsData особенно требует очереди, когда вы включаете Filter в свой запрос.

(строка)

Каналы -> (список)

Канал для фильтрации метрик.

(строка)

Профили маршрутизации -> (список)

Список из до 100 идентификаторов или ARN профилей маршрутизации.

(строка)

RoutingStepExpressions -> (список)

Список выражений в качестве фильтра, где выражение — это объект шага в критериях маршрутизации.

(строка)

Сокращенный синтаксис:

Queues=string,string,Channels=string,string,RoutingProfiles=string,string,RoutingStepExpressions=string,string

Синтаксис JSON:

{
  "Queues": ["string", ...],
  "Channels": ["VOICE"|"CHAT"|"TASK"|"EMAIL", ...],
  "RoutingProfiles": ["string", ...],
  "RoutingStepExpressions": ["string", ...]
}

--groupings (список)

Группировка, применяемая к возвращаемым метрикам. Например, при группировке по QUEUE возвращаемые метрики относятся к каждой очереди, а не агрегируются для всех очередей.

Если вы группируете по CHANNEL, вы должны включить фильтр Каналы. Поддерживаются каналы VOICE, CHAT и TASK.
Если вы группируете по ROUTING_PROFILE, вы должны включить либо фильтр очереди, либо фильтр профиля маршрутизации. Кроме того, фильтр профиля маршрутизации требуется для метрик CONTACTS_SCHEDULED, CONTACTS_IN_QUEUE и OLDEST_CONTACT_AGE.
Если в запросе нет Grouping, возвращается сводная информация по метрикам.
При использовании фильтра RoutingStepExpression, требуется группировка по ROUTING_STEP_EXPRESSION.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  QUEUE
  CHANNEL
  ROUTING_PROFILE
  ROUTING_STEP_EXPRESSION

--current-metrics (список)

Метрики для извлечения. Укажите имя и единицу измерения для каждой метрики. Доступны следующие метрики. Подробное описание всех метрик см. в разделе Определения метрик в руководстве администратора Amazon Connect.

AGENTS_AFTER_CONTACT_WORK

Единица измерения: COUNT

Имя в отчете о метриках в режиме реального времени: ACW

AGENTS_AVAILABLE

Единица измерения: COUNT

Имя в отчете о метриках в режиме реального времени: Available

AGENTS_ERROR

Единица измерения: COUNT

Имя в отчете о метриках в режиме реального времени: Error

AGENTS_NON_PRODUCTIVE

Единица измерения: COUNT

Имя в отчете о метриках в режиме реального времени: NPT (Непродуктивное время)

AGENTS_ON_CALL

Единица измерения: COUNT

Имя в отчете о метриках в режиме реального времени: On contact

AGENTS_ON_CONTACT

Единица измерения: COUNT

Имя в отчете о метриках в режиме реального времени: On contact

AGENTS_ONLINE

Единица измерения: COUNT

Имя в отчете о метриках в режиме реального времени: Online

AGENTS_STAFFED

Единица измерения: COUNT

Имя в отчете о метриках в режиме реального времени: Staffed

CONTACTS_IN_QUEUE

Единица измерения: COUNT

Имя в отчете о метриках в режиме реального времени: In queue

CONTACTS_SCHEDULED

Единица измерения: COUNT

Имя в отчете о метриках в режиме реального времени: Scheduled

OLDEST_CONTACT_AGE

Единица измерения: СЕКУНДЫ

При использовании группировок, Unit говорит SECONDS, а Value возвращается в СЕКУНДАХ.

Если группировка не используется, Unit говорит SECONDS, но Value возвращается в МИЛЛИСЕКУНДАХ. Например, если вы получаете такой ответ:

{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0 }

Фактическое значение OLDEST_CONTACT_AGE составляет 24 секунды.

Когда используется фильтр RoutingStepExpression, эта метрика по-прежнему рассчитывается с момента постановки в очередь. Например, если контакт, находящийся в очереди под <Expression 1> в течение 10 секунд, истек, и <Expression 2> стал активным, то OLDEST_CONTACT_AGE для этой очереди будет рассчитываться с 10, а не с 0.

Имя в отчете о метриках в режиме реального времени: Oldest

SLOTS_ACTIVE

Единица измерения: COUNT

Имя в отчете о метриках в режиме реального времени: Active

SLOTS_AVAILABLE

Единица измерения: COUNT

Имя в отчете о метриках в режиме реального времени: Availability

(структура)

Содержит информацию о метрике в режиме реального времени. Для описания каждой метрики см. раздел Определения метрик в руководстве администратора Amazon Connect.

Name -> (строка)

Имя метрики.

Unit -> (строка)

Единица измерения метрики.

Сокращенный синтаксис:

Name=string,Unit=string ...

Синтаксис JSON:

[
  {
    "Name": "AGENTS_ONLINE"|"AGENTS_AVAILABLE"|"AGENTS_ON_CALL"|"AGENTS_NON_PRODUCTIVE"|"AGENTS_AFTER_CONTACT_WORK"|"AGENTS_ERROR"|"AGENTS_STAFFED"|"CONTACTS_IN_QUEUE"|"OLDEST_CONTACT_AGE"|"CONTACTS_SCHEDULED"|"AGENTS_ON_CONTACT"|"SLOTS_ACTIVE"|"SLOTS_AVAILABLE",
    "Unit": "SECONDS"|"COUNT"|"PERCENT"
  }
  ...
]

--next-token (строка)

Токен для следующего набора результатов. Используйте значение, возвращенное в предыдущем ответе, в следующем запросе для получения следующего набора результатов.

Токен действует в течение 5 минут с момента его создания. Последующие запросы, использующие токен, должны использовать те же параметры запроса, что и запрос, который сгенерировал токен.

--max-results (целое число)

Максимальное количество результатов, возвращаемых за одну страницу.

--sort-criteria (список)

Способ сортировки результирующего ответа по метрикам. Вы можете ввести один критерий сортировки. По умолчанию ресурсы сортируются по AGENTS_ONLINE, DESCENDING. Сбор метрик сортируется на основе входных метрик.

Обратите внимание на следующее:

Сортировка по SLOTS_ACTIVE и SLOTS_AVAILABLE не поддерживается.

(структура)

Способ сортировки результирующего ответа по метрикам. По умолчанию ресурсы сортируются по AGENTS_ONLINE, DESCENDING. Сбор метрик сортируется на основе входных метрик.

SortByMetric -> (строка)

Текущие имена метрик.

SortOrder -> (строка)

Способ сортировки.

Сокращенный синтаксис:

SortByMetric=string,SortOrder=string ...

Синтаксис JSON:

[
  {
    "SortByMetric": "AGENTS_ONLINE"|"AGENTS_AVAILABLE"|"AGENTS_ON_CALL"|"AGENTS_NON_PRODUCTIVE"|"AGENTS_AFTER_CONTACT_WORK"|"AGENTS_ERROR"|"AGENTS_STAFFED"|"CONTACTS_IN_QUEUE"|"OLDEST_CONTACT_AGE"|"CONTACTS_SCHEDULED"|"AGENTS_ON_CONTACT"|"SLOTS_ACTIVE"|"SLOTS_AVAILABLE",
    "SortOrder": "ASCENDING"|"DESCENDING"
  }
  ...
]

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, указанному в --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения, используя предоставленное в JSON значение, так как строка будет взята буквально. Это может не быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если не указано значение или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если указано значение output, он проверит входные данные команды и вернет пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Общие параметры

--debug (boolean)

Включить отладку логирования.

--endpoint-url (string)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команд.

json
text
table
yaml
yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла аутентификации.

--region (string)

Регион для использования. Переопределяет настройки из конфигурации/среды.

--version (string)

Показать версию этого инструмента.

--color (string)

Включить/отключить цветной вывод.

on
off
auto

--no-sign-request (boolean)

Не подписывать запросы. Кредиты не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Файл с сертификатом CA для проверки SSL-сертификатов. Переопределяет настройки из конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое отображается в двоичный блок fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для конфигурированного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическое запросы параметров ввода CLI.

Вывод

NextToken -> (строка)

Если есть дополнительные результаты, это маркер для следующего набора результатов.

Токен истекает через 5 минут после создания. При последующих запросах, использующих токен, необходимо использовать те же параметры запроса, что и при создании токена.

MetricResults -> (список)

Информация о метриках в реальном времени.

(структура)

Содержит информацию о наборе метрик в реальном времени.

Dimensions -> (структура)

Размеры для метрик.

Queue -> (структура)

Информация о очереди, для которой возвращаются метрики.

Id -> (строка)

Идентификатор очереди.

Arn -> (строка)

Amazon Resource Name (ARN) очереди.

Channel -> (строка)

Канал, используемый для группировки и фильтров.

RoutingProfile -> (структура)

Информация о профиле маршрутизации, назначенном пользователю.

Id -> (строка)

Идентификатор профиля маршрутизации.

Arn -> (строка)

Amazon Resource Name (ARN) профиля маршрутизации.

RoutingStepExpression -> (строка)

Выражение шага в критериях маршрутизации.

Collections -> (список)

Набор метрик.

(структура)

Содержит данные для метрики в реальном времени.

Metric -> (структура)

Информация о метрике.

Name -> (строка)

Название метрики.

Unit -> (строка)

Единица измерения метрики.

Value -> (двойное число)

Значение метрики.

DataSnapshotTime -> (временная метка)

Время, в которое метрики были извлечены и кэшированы для постраничной навигации.

ApproximateTotalCount -> (длинное целое число)

Общее количество результатов независимо от текущего размера страницы.