Spec-Zone.ru › AWS CLI v2

[ aws . connect ]

get-current-user-data

Описание

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

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

Синтаксис

  get-current-user-data
--instance-id <value>
--filters <value>
[--next-token <value>]
[--max-results <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. Идентификатор экземпляра можно найти в Amazon Resource Name (ARN) экземпляра.

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

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

  • Очереди: 100
  • Профили маршрутизации: 100
  • Агенты: 100
  • Состояния контактов: 9
  • Группы иерархии пользователей: 1

Данные пользователя извлекаются только для указанных значений/ресурсов в фильтре. Максимум один фильтр может быть передан для очередей, профилей маршрутизации, агентов и групп иерархии пользователей.

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

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

Список до 100 очередей или ARN.

(строка)

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

Фильтр данных пользователя на основе контактной информации, связанной с пользователем. Он содержит список состояний контактов.

ContactStates -> (список)

Список до 9 состояний контактов.

(строка)

RoutingProfiles -> (список)

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

(строка)

Агенты -> (список)

Список до 100 идентификаторов или ARN агентов.

(строка)

UserHierarchyGroups -> (список)

Идентификатор или ARN UserHierarchyGroup.

(строка)

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

Queues=string,string,ContactFilter={ContactStates=[string,string]},RoutingProfiles=string,string,Agents=string,string,UserHierarchyGroups=string,string

Синтаксис JSON:

{
  "Queues": ["string", ...],
  "ContactFilter": {
    "ContactStates": ["INCOMING"|"PENDING"|"CONNECTING"|"CONNECTED"|"CONNECTED_ONHOLD"|"MISSED"|"ERROR"|"ENDED"|"REJECTED", ...]
  },
  "RoutingProfiles": ["string", ...],
  "Agents": ["string", ...],
  "UserHierarchyGroups": ["string", ...]
}

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

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

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

Максимальное количество результатов на страницу.

--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 (логическое)

Включение отладки регистрации.

--endpoint-url (строка)

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

--no-verify-ssl (логическое)

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

--no-paginate (логическое)

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

--output (строка)

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

  • json
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

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

--profile (строка)

Использование определенного профиля из файла учетных данных.

--region (строка)

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

--version (строка)

Отображение версии этого инструмента.

--color (строка)

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

  • включено
  • выключено
  • автоматически

--no-sign-request (логическое)

Отмена подписи запросов. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

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

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

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

--cli-binary-format (строка)

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

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое)

Отключение постраничной навигации cli для вывода.

--cli-auto-prompt (логическое)

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

--no-cli-auto-prompt (логическое)

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

Вывод

NextToken -> (строка)

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

UserDataList -> (список)

Список возвращаемых данных пользователя.

(структура)

Данные для пользователя.

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

Информация о пользователе для возвращаемых данных. Она содержит resourceId и ARN пользователя.

Id -> (строка)

Уникальный идентификатор пользователя.

Arn -> (строка)

Amazon Resource Name (ARN) пользователя.

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

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

Id -> (строка)

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

Arn -> (строка)

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

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

Содержит информацию о уровнях группы иерархии, назначенной пользователю.

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

Информация об уровне один.

Id -> (строка)

Уникальный идентификатор группы иерархии.

Arn -> (строка)

Amazon Resource Name (ARN) группы иерархии.

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

Информация об уровне два.

Id -> (строка)

Уникальный идентификатор группы иерархии.

Arn -> (строка)

Amazon Resource Name (ARN) группы иерархии.

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

Информация об уровне три.

Id -> (строка)

Уникальный идентификатор группы иерархии.

Arn -> (строка)

Amazon Resource Name (ARN) группы иерархии.

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

Информация об уровне четыре.

Id -> (строка)

Уникальный идентификатор группы иерархии.

Arn -> (строка)

Amazon Resource Name (ARN) группы иерархии.

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

Информация об уровне пять.

Id -> (строка)

Уникальный идентификатор группы иерархии.

Arn -> (строка)

Amazon Resource Name (ARN) группы иерархии.

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

Статус агента, который он вручную установил в панели управления контактами (CCP), или который руководитель вручную изменил в отчёте о метриках в реальном времени.

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

Начальная временная метка статуса агента.

StatusArn -> (строка)

Amazon Resource Name (ARN) статуса агента.

StatusName -> (строка)

Название статуса агента.

AvailableSlotsByChannel -> (карта)

Карта доступных слотов по каналу. Ключ — имя канала. Значение — целое число: доступное количество слотов.

key -> (строка)

value -> (целое число)

MaxSlotsByChannel -> (карта)

Карта максимального количества слотов по каналу. Ключ — имя канала. Значение — целое число: максимальное количество слотов. Это вычисляется из MediaConcurrency назначенного RoutingProfile агенту.

key -> (строка)

value -> (целое число)

ActiveSlotsByChannel -> (карта)

Карта активных слотов по каналу. Ключ — имя канала. Значение — целое число: количество активных слотов.

key -> (строка)

value -> (целое число)

Contacts -> (список)

Список справочной информации о контактах.

(структура)

Информация о контакте, связанном с пользователем.

ContactId -> (строка)

Идентификатор контакта в этом экземпляре Amazon Connect.

Channel -> (строка)

Канал контакта.

InitiationMethod -> (строка)

Способ инициирования контакта.

AgentContactState -> (строка)

Состояние контакта.

Примечание

Когда AgentContactState установлено в CONNECTED_ONHOLD, StateStartTimestamp не изменяется. Вместо этого StateStartTimestamp отражает время, когда контакт был CONNECTED агенту.

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

Временная метка эпохи, когда началось состояние контакта.

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

Время, в которое контакт был подключён к агенту.

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

Содержит информацию о ресурсе очереди, для которого возвращаются метрики.

Id -> (строка)

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

Arn -> (строка)

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

NextStatus -> (строка)

Следующий статус агента.

ApproximateTotalCount -> (длинное)

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

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API