[ aws . apigateway ]
обновить-ответ-метода
Описание
Обновляет существующий ресурс MethodResponse.
См. также: Документация API AWS
Синтаксис
update-method-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 (boolean)
Включить отладку протоколирования.
--endpoint-url (string)
Переопределить URL по умолчанию команды указанным URL.
--no-verify-ssl (boolean)
По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение по умолчанию по проверке SSL-сертификатов.
--no-paginate (boolean)
Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (string)
Стиль форматирования вывода команды.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
Запрос JMESPath для фильтрации данных ответа.
--profile (string)
Использовать определённый профиль из файла аутентификации.
--region (string)
Регион для использования. Переопределяет настройки конфигурации/окружения.
--version (string)
Отобразить версию этого инструмента.
--color (string)
Включить/выключить цветной вывод.
- on
- off
- auto
--no-sign-request (boolean)
Не подписывать запросы. Кредиты не будут загружены, если этот аргумент предоставлен.
--ca-bundle (string)
Файл с сертификатом CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/окружения.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.
--cli-binary-format (string)
Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — 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 (boolean)
Отключить кли-пейджер для вывода.
--cli-auto-prompt (boolean)
Автоматически запросить параметры ввода CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматическое запросы параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительная информация содержится в руководстве «Начало работы» в «Руководстве пользователя AWS CLI».
Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. Дополнительная информация содержится в разделе «Использование кавычек со строками» в «Руководстве пользователя AWS CLI».
Для создания нового заголовка ответа метода для ответа 200 в методе и определения его как необязательного (по умолчанию)
Команда:
aws apigateway update-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --patch-operations op="add",path="/responseParameters/method.response.header.custom-header",value="false"
Для удаления модели ответа для ответа 200 в методе
Команда:
aws apigateway update-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --patch-operations op="remove",path="/responseModels/application~1json"
Вывод
statusCode -> (string)
responseParameters -> (map)
Ключево-знаковое отображение, определяющее обязательные или необязательные параметры ответа, которые API Gateway может отправить обратно вызывающей стороне. Ключ определяет заголовок ответа метода, а значение определяет, является ли связанный заголовок ответа метода обязательным или нет. Выражение ключа должно соответствовать шаблону method.response.header.{name}, где name — допустимое и уникальное имя заголовка. API Gateway передает определенные данные ответа интеграции в заголовки ответа метода, указанные здесь, в соответствии с сопоставлением, которое вы задаёте в IntegrationResponse API. Данные ответа интеграции, которые можно сопоставить, включают заголовок ответа интеграции, выраженный в integration.response.header.{name}, статическое значение, заключённое в пару одинарных кавычек (например, 'application/json'), или выражение JSON из полезной нагрузки ответа от сервера в форме integration.response.body.{JSON-expression}, где JSON-expression — допустимое выражение JSON без префикса $).
key -> (string)
value -> (boolean)
responseModels -> (map)
Указывает ресурсы модели, используемые для типа содержимого ответа. Модели ответов представлены в виде пары «ключ/значение», где тип содержимого является ключом, а имя модели — значением.
key -> (string)
value -> (string)
© Copyright 2025, Amazon Web Services. Created using Sphinx.