[ aws . apigateway ]
put-integration-response
Описание
Представляет интеграцию put.
См. также: Документацию API AWS
Синтаксис
put-integration-response
--rest-api-id <value>
--resource-id <value>
--http-method <value>
--status-code <value>
[--selection-pattern <value>]
[--response-parameters <value>]
[--response-templates <value>]
[--content-handling <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]
Параметры
--rest-api-id (строка)
--resource-id (строка)
--http-method (строка)
--status-code (строка)
--selection-pattern (строка)
--response-parameters (массив)
Массив пар ключ-значение, определяющих параметры ответа, передаваемые методу ответа от бэкенда. Ключ — это имя параметра заголовка ответа метода, а сопоставленное значение — значение заголовка ответа интеграции, статическое значение, заключённое в одинарные кавычки, или выражение JSON из тела ответа интеграции. Ключ сопоставления должен соответствовать шаблону method.response.header.{name} , где name — допустимое и уникальное имя заголовка. Сопоставленное нестатическое значение должно соответствовать шаблону integration.response.header.{name} или integration.response.body.{JSON-expression} , где name — допустимое и уникальное имя заголовка ответа, а JSON-expression — допустимое выражение JSON без префикса $.
ключ -> (строка)
значение -> (строка)
Сокращённый синтаксис:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "string"
...}
--response-templates (массив)
Определяет шаблоны интеграции ответа put.
ключ -> (строка)
значение -> (строка)
Сокращённый синтаксис:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "string"
...}
--content-handling (строка)
Указывает способ обработки преобразований типа содержимого полезной нагрузки ответа. Допустимые значения — CONVERT_TO_BINARY и CONVERT_TO_TEXT , с соответствующими действиями:
Если этот параметр не определен, полезная нагрузка ответа будет передана от ответа интеграции к ответу метода без изменений.
Возможные значения:
CONVERT_TO_BINARYCONVERT_TO_TEXT
--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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, отображающего двоичный блок, 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.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в Руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования, характерные для Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. Подробнее см. раздел «Использование кавычек со строками» в Руководстве пользователя AWS CLI.
Для создания ответа интеграции по умолчанию с определённым шаблоном сопоставления
Команда:
aws apigateway put-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --selection-pattern "" --response-templates '{"application/json": "{\"json\": \"template\"}"}'
Для создания ответа интеграции с регулярным выражением 400 и статически определённым значением заголовка
Команда:
aws apigateway put-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 400 --selection-pattern 400 --response-parameters '{"method.response.header.custom-header": "'"'"'custom-value'"'"'"}'
Вывод
statusCode -> (строка)
selectionPattern -> (строка)
.+ для сопоставления ответа об ошибке. Однако убедитесь, что ответ об ошибке не содержит символов новой строки (\n) в таких случаях. Если бэкенд — функция Lambda, сопоставляется заголовок ошибки Lambda-функции. Для всех других HTTP и Amazon Web Services бэкэндов сопоставляется HTTP-код состояния.responseParameters -> (массив)
Массив пар ключ-значение, определяющих параметры ответа, передаваемые методу ответа от бэкенда. Ключ — это имя параметра заголовка ответа метода, а сопоставленное значение — значение заголовка ответа интеграции, статическое значение, заключённое в одинарные кавычки, или выражение JSON из тела ответа интеграции. Ключ сопоставления должен соответствовать шаблону method.response.header.{name} , где name — допустимое и уникальное имя заголовка. Сопоставленное нестатическое значение должно соответствовать шаблону integration.response.header.{name} или integration.response.body.{JSON-expression} , где name — допустимое и уникальное имя заголовка ответа, а JSON-expression — допустимое выражение JSON без префикса $.
ключ -> (строка)
значение -> (строка)
responseTemplates -> (массив)
Определяет шаблоны, используемые для преобразования тела ответа интеграции. Шаблоны ответа представлены в виде массива ключ/значение, где ключ — тип содержимого, а значение — шаблон.
ключ -> (строка)
значение -> (строка)
contentHandling -> (строка)
Указывает способ обработки преобразований типа содержимого полезной нагрузки ответа. Допустимые значения — CONVERT_TO_BINARY и CONVERT_TO_TEXT , с соответствующими действиями:
Если этот параметр не определён, полезная нагрузка ответа будет передана от ответа интеграции к ответу метода без изменений.
© Copyright 2025, Amazon Web Services. Created using Sphinx.