Spec-Zone.ru › AWS CLI v2

[ aws . apigatewayv2 ]

создание-ответа-интеграции

Описание

Создаёт IntegrationResponses.

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

Синтаксис

  create-integration-response
--api-id <value>
[--content-handling-strategy <value>]
--integration-id <value>
--integration-response-key <value>
[--response-parameters <value>]
[--response-templates <value>]
[--template-selection-expression <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]

Параметры

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

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

--content-handling-strategy (строка)

Указывает, как обрабатывать преобразования типа содержимого ответа полезной нагрузки. Допустимые значения — CONVERT_TO_BINARY и CONVERT_TO_TEXT со следующими особенностями:

CONVERT_TO_BINARY: Преобразует полезную нагрузку ответа из Base64-кодированной строки в соответствующий двоичный блок.

CONVERT_TO_TEXT: Преобразует полезную нагрузку ответа из двоичного блока в Base64-кодированную строку.

Если этот параметр не определён, полезная нагрузка ответа будет передана от ответа интеграции к ответу маршрута или методу без изменений.

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

  • CONVERT_TO_BINARY
  • CONVERT_TO_TEXT

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

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

--integration-response-key (строка)

Ключ ответа интеграции.

--response-parameters (массив)

Массив ключ-значение, определяющий параметры ответа, передаваемые в ответ метода от бэкенда. Ключ — это имя параметра заголовка ответа метода, а сопоставленное значение — значение заголовка ответа интеграции, статическое значение, заключённое в одинарные кавычки, или выражение JSON из тела ответа интеграции. Ключ сопоставления должен соответствовать шаблону method.response.header.{name}, где {name} — допустимое и уникальное имя заголовка. Сопоставленное нестатическое значение должно соответствовать шаблону integration.response.header.{name} или integration.response.body.{JSON-expression}, где {name} — допустимое и уникальное имя заголовка ответа, а {JSON-expression} — допустимое выражение JSON без префикса $.

key -> (строка)

value -> (строка)

Строка длиной от 1 до 512 символов.

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--response-templates (массив)

Коллекция шаблонов ответов для ответа интеграции в виде массива ключ-значение. Шаблоны ответов представлены в виде пары ключ/значение, где ключ — тип содержимого, а значение — шаблон.

key -> (строка)

value -> (строка)

Строка длиной от 0 до 32768 символов.

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--template-selection-expression (строка)

Выражение выбора шаблона для ответа интеграции. Поддерживается только для API WebSocket.

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

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

Вывод

ContentHandlingStrategy -> (строка)

Поддерживается только для API WebSocket. Указывает, как обрабатывать преобразования типа содержимого ответа полезной нагрузки. Поддерживаемые значения — CONVERT_TO_BINARY и CONVERT_TO_TEXT со следующими особенностями:

CONVERT_TO_BINARY: Преобразует полезную нагрузку ответа из Base64-кодированной строки в соответствующий двоичный блок.

CONVERT_TO_TEXT: Преобразует полезную нагрузку ответа из двоичного блока в Base64-кодированную строку.

Если этот параметр не определён, полезная нагрузка ответа будет передана от ответа интеграции к ответу маршрута или методу без изменений.

IntegrationResponseId -> (строка)

Идентификатор ответа интеграции.

IntegrationResponseKey -> (строка)

Ключ ответа интеграции.

ResponseParameters -> (массив)

Массив ключ-значение, определяющий параметры ответа, передаваемые в ответ метода от бэкенда. Ключ — это имя параметра заголовка ответа метода, а сопоставленное значение — значение заголовка ответа интеграции, статическое значение, заключённое в одинарные кавычки, или выражение JSON из тела ответа интеграции. Ключ сопоставления должен соответствовать шаблону method.response.header.{name}, где имя — допустимое и уникальное имя заголовка. Сопоставленное нестатическое значение должно соответствовать шаблону integration.response.header.{name} или integration.response.body.{JSON-expression}, где имя — допустимое и уникальное имя заголовка ответа, а JSON-выражение — допустимое выражение JSON без префикса $.

key -> (строка)

value -> (строка)

Строка длиной от 1 до 512 символов.

ResponseTemplates -> (массив)

Коллекция шаблонов ответов для ответа интеграции в виде массива ключ-значение. Шаблоны ответов представлены в виде пары ключ/значение, где ключ — тип содержимого, а значение — шаблон.

key -> (строка)

value -> (строка)

Строка длиной от 0 до 32768 символов.

TemplateSelectionExpression -> (строка)

Выражения выбора шаблонов для ответа интеграции.

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

Spec-Zone.ru

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