Spec-Zone.ru › AWS CLI v2

[ aws . connectcases ]

create-related-item

Описание

Создаёт связанный элемент (комментарии, задачи и контакты) и связывает его с кейсом.

Примечание

  • Связанный элемент — это ресурс, связанный с кейсом. Он может или не может иметь внешний идентификатор, связывающий его с внешним ресурсом (например, contactArn). Все связанные элементы имеют свой внутренний идентификатор, relatedItemArn. Примеры связанных элементов включают comments и contacts.
  • Если вы предоставляете значение для performedBy.userArn, вам также необходимо разрешение DescribeUser на ARN пользователя, которого вы предоставляете.
  • Поле type предназначено только для внутреннего использования.

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

Синтаксис

  create-related-item
--case-id <value>
--content <value>
--domain-id <value>
[--performed-by <value>]
--type <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-id (строка)

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

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

Содержимое создаваемого связанного элемента.

Примечание

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

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

Представляет содержимое комментария, который будет возвращён агентам.

body -> (строка)

Текст в теле Comment кейса.

contentType -> (строка)

Тип текста в поле Comment кейса.

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

Объект, представляющий контакт в Amazon Connect в качестве поля запроса API.

contactArn -> (строка)

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

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

Файл связанных элементов.

fileArn -> (строка)

Amazon Resource Name (ARN) файла в Amazon Connect.

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

Представляет содержимое создаваемого SLA.

Примечание

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

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

Представляет конфигурацию входного SLA.

fieldId -> (строка)

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

name -> (строка)

Имя SLA.

targetFieldValues -> (список)

Представляет список целевых значений поля для указанного в SlaInputConfiguration fieldId. SLA считается выполненным, если совпадает любое из этих целевых значений поля с фактическим значением поля.

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

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

Примечание

Система поля Summary принимает 3000 символов, в то время как все остальные поля принимают 500 символов.

Примечание

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

booleanValue -> (логическое значение)

Может быть пустым или иметь тип булево значение. Можно указать только одно значение.

doubleValue -> (двойное значение)

Может быть пустым или иметь тип числовое значение с плавающей точкой. Можно указать только одно значение.

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

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

stringValue -> (строка)

Строковое значение.

userArnValue -> (строка)

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

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

Целевое время в минутах, в течение которого SLA должно быть выполнено.

type -> (строка)

Тип SLA.

Синтаксис JSON:

{
  "comment": {
    "body": "string",
    "contentType": "Text/Plain"
  },
  "contact": {
    "contactArn": "string"
  },
  "file": {
    "fileArn": "string"
  },
  "sla": {
    "slaInputConfiguration": {
      "fieldId": "string",
      "name": "string",
      "targetFieldValues": [
        {
          "booleanValue": true|false,
          "doubleValue": double,
          "emptyValue": {

          },
          "stringValue": "string",
          "userArnValue": "string"
        }
        ...
      ],
      "targetSlaMinutes": long,
      "type": "CaseField"
    }
  }
}

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

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

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

Представляет создателя связанного элемента.

Примечание

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

customEntity -> (строка)

Любой предоставленный объект.

userArn -> (строка)

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

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

customEntity=string,userArn=string

Синтаксис JSON:

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

--type (строка)

Тип связанного элемента.

Возможные значения:

  • Contact
  • Comment
  • File
  • Sla

--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-stream

--query (строка)

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

--profile (строка)

Использовать определённый профиль из файла credentials.

--region (строка)

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

--version (строка)

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

--color (строка)

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

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

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

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

--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.

Вывод

relatedItemArn -> (строка)

Amazon Resource Name (ARN) связанного элемента.

relatedItemId -> (строка)

Уникальный идентификатор связанного элемента.

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

Spec-Zone.ru

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