Spec-Zone.ru › AWS CLI v2

[ aws . apigateway ]

get-integration-response

Описание

Представляет ответ интеграции получения.

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

Синтаксис

  get-integration-response
--rest-api-id <value>
--resource-id <value>
--http-method <value>
--status-code <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.

--resource-id (строка)

Указывает идентификатор ресурса запроса ответа интеграции получения.

--http-method (строка)

Указывает HTTP-метод запроса ответа интеграции получения.

--status-code (строка)

Указывает код состояния запроса ответа интеграции получения.

--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.

Чтобы получить конфигурацию ответа интеграции для HTTP-метода, определенного в ресурсе REST API

Команда:

aws apigateway get-integration-response --rest-api-id 1234123412 --resource-id y9h6rt --http-method GET --status-code 200

Вывод:

{
    "statusCode": "200",
    "responseTemplates": {
        "application/json": null
    }
}

Вывод

statusCode -> (строка)

Указывает код состояния, используемый для сопоставления ответа интеграции с существующим MethodResponse.

selectionPattern -> (строка)

Указывает шаблон регулярного выражения (regex), используемый для выбора ответа интеграции на основе ответа из бэкенда. Например, если успешный ответ ничего не возвращает, а ответ об ошибке возвращает какую-то строку, вы можете использовать regex .+ для соответствия ответу об ошибке. Однако, убедитесь, что ответ об ошибке не содержит символа новой строки (\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.

Spec-Zone.ru

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