Spec-Zone.ru › AWS CLI v2

[ aws . apigateway ]

обновить-ответ-шлюза

Описание

Обновляет GatewayResponse заданного типа ответа для указанного RestApi.

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

Синтаксис

  update-gateway-response
--rest-api-id <value>
--response-type <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 (строка)

Строковый идентификатор связанного RestApi.

--response-type (строка)

Тип ответа связанного GatewayResponse.

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

  • DEFAULT_4XX
  • DEFAULT_5XX
  • RESOURCE_NOT_FOUND
  • UNAUTHORIZED
  • INVALID_API_KEY
  • ACCESS_DENIED
  • AUTHORIZER_FAILURE
  • AUTHORIZER_CONFIGURATION_ERROR
  • INVALID_SIGNATURE
  • EXPIRED_TOKEN
  • MISSING_AUTHENTICATION_TOKEN
  • INTEGRATION_FAILURE
  • INTEGRATION_TIMEOUT
  • API_CONFIGURATION_ERROR
  • UNSUPPORTED_MEDIA_TYPE
  • BAD_REQUEST_PARAMETERS
  • BAD_REQUEST_BODY
  • REQUEST_TOO_LARGE
  • THROTTLED
  • QUOTA_EXCEEDED
  • WAF_FILTERED

--patch-operations (список)

Дополнительная информация о поддерживаемых операциях исправления доступна в разделе Операции исправления.

(структура)

Дополнительная информация о поддерживаемых операциях исправления доступна в разделе Операции исправления.

op -> (строка)

Операция обновления, которая будет выполнена с этим запросом PATCH. Допустимые значения: add, remove, replace или copy. Не все допустимые операции поддерживаются для данного ресурса. Поддержка операций зависит от конкретных контекстов операций. Попытки применить неподдерживаемую операцию к ресурсу приведут к возврату сообщения об ошибке.

path -> (строка)

Целевой объект операции op, определяемый значением указателя JSON, которое ссылается на местоположение в целевом ресурсе. Например, если целевой ресурс имеет обновляемое свойство {“name”:”value”}, путь к этому свойству — /name. Если значение свойства name является JSON-объектом (например, {“name”: {“child/name”: “child-value”}}), путь к свойству child/name будет /name/child~1name. Любой символ косой черты («/») в именах путей должен быть экранирован с помощью «~1», как показано в примере выше. Каждая операция op может иметь только один связанный с ней путь.

value -> (строка)

Новое целевое значение операции обновления. Применимо для операций add или replace. При использовании AWS CLI для обновления свойства JSON-значения заключите JSON-объект в пару одинарных кавычек в оболочке Linux, например, ‘{“a”: …}’.

from -> (строка)

Источник операции копирования обновления, определяемый значением указателя JSON, которое ссылается на расположение в целевом ресурсе, из которого следует скопировать значение. Например, для продвижения развертывания canary, скопируйте идентификатор canary deployment в соответствующий идентификатор развертывания, вызвав запрос PATCH на ресурсе Stage с «op»:"copy", «from»:"/canarySettings/deploymentId" и «path»:"/deploymentId".

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

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
  • текст
  • таблица
  • 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.

Вывод

responseType -> (строка)

Тип ответа связанного GatewayResponse.

statusCode -> (строка)

Код HTTP статуса для этого GatewayResponse.

responseParameters -> (массив)

Параметры ответа (пути, строки запроса и заголовки) GatewayResponse в виде массива пар ключ-значение.

key -> (строка)

value -> (строка)

responseTemplates -> (массив)

Шаблоны ответа GatewayResponse в виде массива пар ключ-значение.

key -> (строка)

value -> (строка)

defaultResponse -> (булево)

Флаг Boolean, указывающий, является ли этот GatewayResponse ответ по умолчанию (true ) или нет (false). Ответ по умолчанию — это ответ, сгенерированный API Gateway без каких-либо настроек со стороны разработчика API.

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

Spec-Zone.ru

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