поиск-маршрутизирующих-профилей
Описание
Ищет маршрутизирующие профили в экземпляре Amazon Connect с опциональным фильтрованием.
См. также: Документацию API AWS
search-routing-profiles является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничный запрос аргумент --query должен извлекать данные из результатов следующих выражений запроса: RoutingProfiles
Синтаксис
search-routing-profiles
--instance-id <value>
[--search-filter <value>]
[--search-criteria <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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 (строка)
--search-filter (структура)
Фильтры, которые будут применяться к результатам поиска.
TagFilter -> (структура)
Объект, который можно использовать для указания условий тегов внутри SearchFilter. Он принимает OR типа AND (список списков) в качестве входных данных, где:
- Список верхнего уровня определяет условия, которые необходимо применить с оператором
OR - Вложенный список определяет условия, которые необходимо применить с оператором
AND.
OrConditions -> (список)
Список условий, которые будут применяться вместе с условием OR.
(список)
(структура)
Условие узла листа, которое можно использовать для указания условия тега, например, HAVE BPO = 123.
TagKey -> (строка)
TagValue -> (строка)
AndConditions -> (список)
Список условий, которые будут применяться вместе с условием AND.
(структура)
Условие узла листа, которое можно использовать для указания условия тега, например, HAVE BPO = 123.
TagKey -> (строка)
TagValue -> (строка)
TagCondition -> (структура)
Условие узла листа, которое можно использовать для указания условия тега.
TagKey -> (строка)
TagValue -> (строка)
Синтаксис JSON:
{
"TagFilter": {
"OrConditions": [
[
{
"TagKey": "string",
"TagValue": "string"
}
...
]
...
],
"AndConditions": [
{
"TagKey": "string",
"TagValue": "string"
}
...
],
"TagCondition": {
"TagKey": "string",
"TagValue": "string"
}
}
}
--search-criteria (структура)
Критерии поиска, используемые для возврата маршрутизирующих профилей.
Примечание
Поляname и description поддерживают запросы «содержит» с минимальной длиной 2 символа и максимальной длиной 25 символов. Любые запросы с длиной символов вне этого диапазона приведут к недействительным результатам.OrConditions -> (список)
Список условий, которые будут применяться вместе с условием ИЛИ.
(структура)
Критерии поиска, используемые для возврата маршрутизирующих профилей.
Примечание
Поляname и description поддерживают запросы «содержит» с минимальной длиной 2 символа и максимальной длиной 25 символов. Любые запросы с длиной символов вне этого диапазона приведут к недействительным результатам.OrConditions -> (список)
Список условий, которые будут применяться вместе с условием ИЛИ.
(… рекурсивно …)
AndConditions -> (список)
Список условий, которые будут применяться вместе с условием И.
(… рекурсивно …)
StringCondition -> (структура)
Условие узла листа, которое можно использовать для указания строкового условия.
Примечание
В настоящее время поддерживаемые значения дляFieldName — associatedQueueIds, name, description и resourceID.FieldName -> (строка)
Value -> (строка)
ComparisonType -> (строка)
AndConditions -> (список)
Список условий, которые будут применяться вместе с условием И.
(структура)
Критерии поиска, используемые для возврата маршрутизирующих профилей.
Примечание
Поляname и description поддерживают запросы «содержит» с минимальной длиной 2 символа и максимальной длиной 25 символов. Любые запросы с длиной символов вне этого диапазона приведут к недействительным результатам.OrConditions -> (список)
Список условий, которые будут применяться вместе с условием ИЛИ.
(… рекурсивно …)
AndConditions -> (список)
Список условий, которые будут применяться вместе с условием И.
(… рекурсивно …)
StringCondition -> (структура)
Условие узла листа, которое можно использовать для указания строкового условия.
Примечание
В настоящее время поддерживаемые значения дляFieldName — associatedQueueIds, name, description и resourceID.FieldName -> (строка)
Value -> (строка)
ComparisonType -> (строка)
StringCondition -> (структура)
Условие узла листа, которое можно использовать для указания строкового условия.
Примечание
В настоящее время поддерживаемые значения дляFieldName — associatedQueueIds, name, description и resourceID.FieldName -> (строка)
Value -> (строка)
ComparisonType -> (строка)
Синтаксис JSON:
{
"OrConditions": [
{
"OrConditions": [
{ ... recursive ... }
...
],
"AndConditions": [
{ ... recursive ... }
...
],
"StringCondition": {
"FieldName": "string",
"Value": "string",
"ComparisonType": "STARTS_WITH"|"CONTAINS"|"EXACT"
}
}
...
],
"AndConditions": [
{
"OrConditions": [
{ ... recursive ... }
...
],
"AndConditions": [
{ ... recursive ... }
...
],
"StringCondition": {
"FieldName": "string",
"Value": "string",
"ComparisonType": "STARTS_WITH"|"CONTAINS"|"EXACT"
}
}
...
],
"StringCondition": {
"FieldName": "string",
"Value": "string",
"ComparisonType": "STARTS_WITH"|"CONTAINS"|"EXACT"
}
}
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет взята буквально. Это может не быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Маркер, указывающий, с какой точки начать постраничный вывод. Это NextToken из ранее усеченного ответа.
Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.
--page-size (целое число)
Размер каждой страницы, получаемой в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Уменьшение размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.
Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.
--max-items (целое число)
Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает заданное значение, в выводе команды предоставляется NextToken. Чтобы продолжить постраничный вывод, укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.
--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 V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настроек cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Отключить вывод кли-пейджера.
--cli-auto-prompt (boolean)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматическое запросы параметров ввода CLI.
Вывод
RoutingProfiles -> (список)
Информация о профилях маршрутизации.
(структура)
Содержит информацию о профиле маршрутизации.
InstanceId -> (строка)
Name -> (строка)
RoutingProfileArn -> (строка)
RoutingProfileId -> (строка)
Description -> (строка)
MediaConcurrencies -> (список)
Каналы, которые агенты могут обрабатывать в панели управления контактами (CCP) для этого профиля маршрутизации.
(структура)
Содержит информацию о поддерживаемых каналах и о количестве контактов, которые агент может одновременно обслуживать в канале.
Channel -> (строка)
Concurrency -> (целое число)
Количество контактов, которые агент может одновременно обрабатывать в канале.
Диапазон допустимых значений для VOICE: Минимальное значение 1. Максимальное значение 1.
Диапазон допустимых значений для CHAT: Минимальное значение 1. Максимальное значение 10.
Диапазон допустимых значений для TASK: Минимальное значение 1. Максимальное значение 10.
CrossChannelBehavior -> (структура)
Определяет поведение перекрестной маршрутизации для каждого канала, включенного для этого профиля маршрутизации. Например, это позволяет предложить агенту другой контакт из другого канала, когда он в настоящее время работает с контактом из голосового канала.
BehaviorType -> (строка)
DefaultOutboundQueueId -> (строка)
Tags -> (карта)
Теги для организации, отслеживания или управления доступом к этому ресурсу. Например, { “Tags”: {“key1”:”value1”, “key2”:”value2”} }.
key -> (строка)
value -> (строка)
NumberOfAssociatedQueues -> (длинное целое число)
NumberOfAssociatedUsers -> (длинное целое число)
AgentAvailabilityTimer -> (строка)
LastModifiedTime -> (временная метка)
LastModifiedRegion -> (строка)
IsDefault -> (булево)
AssociatedQueueIds -> (список)
Идентификаторы связанных очередей.
(строка)
NextToken -> (строка)
ApproximateTotalCount -> (длинное целое число)
© Copyright 2025, Amazon Web Services. Created using Sphinx.