Spec-Zone.ru › AWS CLI v2

[ aws . connectcases ]

batch-get-case-rule

Описание

Получает пакет правил для случаев. В веб-приложении администратора Amazon Connect правила случаев известны как условия полей для случаев. Дополнительную информацию об условиях полей для случаев см. в разделе Добавление условий полей для случаев в шаблон случая.

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

Синтаксис

  batch-get-case-rule
--case-rules <value>
--domain-id <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]

Параметры

--case-rules (список)

Список идентификаторов правил для случаев.

(структура)

Объект, содержащий информацию об идентификаторе правила случая.

id -> (строка)

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

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

id=string ...

Синтаксис JSON:

[
  {
    "id": "string"
  }
  ...
]

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

Уникальный идентификатор домена случаев.

--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 (строка)

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

--no-verify-ssl (булево)

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

--no-paginate (булево)

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

--output (строка)

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

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

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • вкл
  • выкл
  • авто

--no-sign-request (булево)

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

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

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

--cli-read-timeout (целое число)

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

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 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.

Вывод

caseRules -> (список)

Список подробной информации о правилах кейса.

(структура)

Подробная информация о правиле кейса. В веб-приложении администрирования Amazon Connect правила кейсов известны как условия полей кейсов. Дополнительную информацию об условиях полей кейсов см. в разделе Добавление условий полей кейсов в шаблон кейса.

caseRuleArn -> (строка)

Идентификатор ресурса Amazon (ARN) правила кейса.

caseRuleId -> (строка)

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

createdTime -> (метка времени)

Отметка времени создания ресурса.

deleted -> (булево)

Указывает, был ли ресурс удалён.

description -> (строка)

Описание правила кейса.

lastModifiedTime -> (метка времени)

Отметка времени создания или последнего изменения ресурса.

name -> (строка)

Имя правила кейса.

rule -> (структура помеченного объединения)

Представляет тип правила, который должен выполняться при определенных условиях.

Примечание

Это структура помеченного объединения. Может быть установлено только одно из следующих верхнеуровневых ключей: required.

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

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

conditions -> (список)

Список условий для правила; первое условие, которое оценивается как истинное, определяет значение правила.

(структура помеченного объединения)

Булево условие для правила. В веб-приложении администрирования Amazon Connect правила кейсов известны как условия полей кейсов. Дополнительную информацию об условиях полей кейсов см. в разделе Добавление условий полей кейсов в шаблон кейса.

Примечание

Это структура помеченного объединения. Может быть установлено только одно из следующих верхнеуровневых ключей: equalTo, notEqualTo.

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

Проверяет, что operandOne равно operandTwo.

operandOne -> (структура помеченного объединения)

Представляет левую операнду в условии.

Примечание

Это структура помеченного объединения. Может быть установлено только одно из следующих верхнеуровневых ключей: fieldId.

fieldId -> (строка)

Идентификатор поля, значение которого должна принять эта операндa.

operandTwo -> (структура помеченного объединения)

Представляет правую операнду в условии.

Примечание

Это структура помеченного объединения. Может быть установлено только одно из следующих верхнеуровневых ключей: booleanValue, doubleValue, emptyValue, stringValue.

booleanValue -> (булево)

Тип булевого значения.

doubleValue -> (двойное)

Тип значения с плавающей точкой.

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

Тип пустого значения.

stringValue -> (строка)

Тип строкового значения.

result -> (булево)

Значение внешнего правила, если условие оценивается как истинное.

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

Проверяет, что operandOne не равно operandTwo.

operandOne -> (структура помеченного объединения)

Представляет левую операнду в условии.

Примечание

Это структура помеченного объединения. Может быть установлено только одно из следующих верхнеуровневых ключей: fieldId.

fieldId -> (строка)

Идентификатор поля, значение которого должна принять эта операндa.

operandTwo -> (структура помеченного объединения)

Представляет правую операнду в условии.

Примечание

Это структура помеченного объединения. Может быть установлено только одно из следующих верхнеуровневых ключей: booleanValue, doubleValue, emptyValue, stringValue.

booleanValue -> (булево)

Тип булевого значения.

doubleValue -> (двойное)

Тип значения с плавающей точкой.

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

Тип пустого значения.

stringValue -> (строка)

Тип строкового значения.

result -> (булево)

Значение внешнего правила, если условие оценивается как истинное.

defaultValue -> (булево)

Значение правила (т.е. является ли поле обязательным), если ни одно из условий не оценивается как истинное.

tags -> (карта)

Карта пар ключ-значение, представляющих теги ресурса. Теги используются для организации, отслеживания или управления доступом к этому ресурсу.

key -> (строка)

value -> (строка)

errors -> (список)

Список ошибок правил кейса.

(структура)

Ошибка для сбоя API batch describe case rules. В веб-приложении администрирования Amazon Connect правила кейсов известны как условия полей кейсов. Дополнительную информацию об условиях полей кейсов см. в разделе Добавление условий полей кейсов в шаблон кейса.

errorCode -> (строка)

Код ошибки при получении правила кейса.

id -> (строка)

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

message -> (строка)

Сообщение об ошибке при получении правила кейса.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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