[ aws . apigateway ]
обновить-ответ-интеграции
Описание
Представляет обновление ответа интеграции.
См. также: Документация API AWS
Синопсис
update-integration-response
--rest-api-id <value>
--resource-id <value>
--http-method <value>
--status-code <value>
[--patch-operations <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 (строка)
--patch-operations (список)
Дополнительную информацию о поддерживаемых операциях исправления см. в разделе Операции исправления.
(структура)
Дополнительную информацию о поддерживаемых операциях исправления см. в разделе Операции исправления.
op -> (строка)
path -> (строка)
value -> (строка)
from -> (строка)
Упрощенная синтаксическая конструкция:
op=string,path=string,value=string,from=string ...
Синтаксис JSON:
[
{
"op": "add"|"remove"|"replace"|"move"|"copy"|"test",
"path": "string",
"value": "string",
"from": "string"
}
...
]
--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 для вывода.
--cli-auto-prompt (логическое значение)
Автоматический запрос параметров ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключение автоматического запроса параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве «Начало работы» в руководстве пользователя AWS CLI.
Если не указано иное, во всех примерах используются правила кавычек Unix-подобных систем. Эти примеры потребуют адаптации к правилам кавычек вашей терминальной оболочки. См. раздел «Использование кавычек со строками» в руководстве пользователя AWS CLI.
Для изменения заголовка ответа интеграции на статическое отображение «*»
Команда:
aws apigateway update-integration-response --rest-api-id 1234123412 --resource-id 3gapai --http-method GET --status-code 200 --patch-operations op='replace',path='/responseParameters/method.response.header.Access-Control-Allow-Origin',value='"'"'*'"'"'
Вывод:
{
"statusCode": "200",
"responseParameters": {
"method.response.header.Access-Control-Allow-Origin": "'*'"
}
}
Для удаления заголовка ответа интеграции
Команда:
aws apigateway update-integration-response --rest-api-id 1234123412 --resource-id 3gapai --http-method GET --status-code 200 --patch-operations op='remove',path='/responseParameters/method.response.header.Access-Control-Allow-Origin'
Вывод
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-выражение без префикса $.
key -> (строка)
value -> (строка)
responseTemplates -> (карта)
Определяет шаблоны, используемые для преобразования тела ответа интеграции. Шаблоны ответов представлены как карта ключ/значение, где ключ – тип содержимого, а значение – шаблон.
key -> (строка)
value -> (строка)
contentHandling -> (строка)
Определяет, как обрабатывать преобразования типов содержимого полезной нагрузки ответа. Поддерживаемые значения – CONVERT_TO_BINARY и CONVERT_TO_TEXT, с соответствующим поведением:
Если этот параметр не определен, полезная нагрузка ответа будет передаваться от ответа интеграции к ответу метода без изменений.
© Copyright 2025, Amazon Web Services. Created using Sphinx.