[ aws . apigateway ]
put-gateway-response
Описание
Создаёт настройку GatewayResponse заданного типа ответа и кода состояния на заданном RestApi.
См. также: AWS API документацию
Синтаксис
put-gateway-response
--rest-api-id <value>
--response-type <value>
[--status-code <value>]
[--response-parameters <value>]
[--response-templates <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 (строка)
--response-type (строка)
Тип ответа связанного GatewayResponse
Возможные значения:
DEFAULT_4XXDEFAULT_5XXRESOURCE_NOT_FOUNDUNAUTHORIZEDINVALID_API_KEYACCESS_DENIEDAUTHORIZER_FAILUREAUTHORIZER_CONFIGURATION_ERRORINVALID_SIGNATUREEXPIRED_TOKENMISSING_AUTHENTICATION_TOKENINTEGRATION_FAILUREINTEGRATION_TIMEOUTAPI_CONFIGURATION_ERRORUNSUPPORTED_MEDIA_TYPEBAD_REQUEST_PARAMETERSBAD_REQUEST_BODYREQUEST_TOO_LARGETHROTTLEDQUOTA_EXCEEDEDWAF_FILTERED
--status-code (строка)
--response-parameters (словарь)
Параметры ответа (пути, строки запроса и заголовки) GatewayResponse как словарь пар ключ-значение со строковыми значениями.
ключ -> (строка)
значение -> (строка)
Сокращённый синтаксис:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "string"
...}
--response-templates (словарь)
Шаблоны ответа GatewayResponse как словарь пар ключ-значение со строковыми значениями.
ключ -> (строка)
значение -> (строка)
Сокращённый синтаксис:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "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
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использование определённого профиля из файла аутентификации.
--region (строка)
Используемый регион. Переопределяет настройки конфигурации/среды.
--version (строка)
Отображение версии этого инструмента.
--color (строка)
Включение/выключение цветного вывода.
- on
- off
- auto
--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-auto-prompt (логическое значение)
Автоматически запрашивать параметры входных данных CLI.
--no-cli-auto-prompt (логическое значение)
Отключение автоматического запроса параметров входных данных CLI.
Вывод
responseType -> (строка)
statusCode -> (строка)
responseParameters -> (словарь)
Параметры ответа (пути, строки запроса и заголовки) GatewayResponse как словарь пар ключ-значение со строковыми значениями.
ключ -> (строка)
значение -> (строка)
responseTemplates -> (словарь)
Шаблоны ответа GatewayResponse как словарь пар ключ-значение со строковыми значениями.
ключ -> (строка)
значение -> (строка)
defaultResponse -> (логическое значение)
true ) или нет (false ). Стандартный ответ шлюза — это ответ, сгенерированный API Gateway без каких-либо настроек разработчиком API.
© Copyright 2025, Amazon Web Services. Created using Sphinx.