Spec-Zone.ru › AWS CLI v2

[ aws . connectcases ]

create-case

Описание

Примечание

Если вы предоставляете значение для PerformedBy.UserArn, вам также необходимо иметь разрешение connect:DescribeUser на ресурс User ARN, который вы предоставляете

Создает случай в указанном домене случаев. Система случаев и пользовательские поля принимаются в виде массива пар id/значение с объявленными типами данных.

При создании случая необходимы следующие поля:

  • customer_id - Вы должны предоставить полный ARN профиля клиента в таком формате: arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID
  • title

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

Синтаксис

  create-case
[--client-token <value>]
--domain-id <value>
--fields <value>
[--performed-by <value>]
--template-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]

Параметры

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

Уникальный, чувствительный к регистру идентификатор, который вы предоставляете, чтобы обеспечить идемпотентность запроса. Если не указан, Amazon Web Services SDK заполняет это поле. Дополнительную информацию об идемпотентности см. в разделе Обеспечение безопасности повторных попыток с помощью идемпотентных API .

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

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

--fields (список)

Массив объектов с идентификатором поля (соответствующим ListFields/DescribeField) и данными значения типа union.

(структура)

Объект для значений полей случая.

id -> (строка)

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

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

Объединение потенциальных типов значений поля.

Примечание

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

booleanValue -> (булево)

Может быть либо null, либо иметь тип значения Boolean. Может быть предоставлено только одно значение.

doubleValue -> (double)

Может быть либо null, либо иметь тип значения Double. Может быть предоставлено только одно значение.

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

Пустое значение.

stringValue -> (строка)

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

userArnValue -> (строка)

Представляет пользователя, выполнившего аудит.

Краткая запись:

id=string,value={booleanValue=boolean,doubleValue=double,emptyValue={},stringValue=string,userArnValue=string} ...

Синтаксис JSON:

[
  {
    "id": "string",
    "value": {
      "booleanValue": true|false,
      "doubleValue": double,
      "emptyValue": {

      },
      "stringValue": "string",
      "userArnValue": "string"
    }
  }
  ...
]

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

Представляет сущность, выполнившую действие.

Примечание

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

customEntity -> (строка)

Любая предоставленная сущность.

userArn -> (строка)

Представляет Amazon Connect ARN пользователя.

Краткая запись:

customEntity=string,userArn=string

Синтаксис JSON:

{
  "customEntity": "string",
  "userArn": "string"
}

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

Переопределить стандартный URL команды на указанный 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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

caseArn -> (строка)

Amazon Resource Name (ARN) случая.

caseId -> (строка)

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

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

Spec-Zone.ru

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