get-integration

Описание

Получает интеграцию.

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

Синтаксис

  get-integration
--api-id <value>
--integration-id <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]

Параметры

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

Идентификатор API.

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

Идентификатор интеграции.

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

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросы параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. См. руководство по началу работы в Руководстве пользователя AWS CLI для получения дополнительной информации.

Если не указано иное, все примеры используют правила кавычек, подобные правилам Unix. Эти примеры потребуется адаптировать к правилам кавычек вашей терминальной среды. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Для получения информации об интеграции

Следующий get-integration пример отображает информацию об интеграции.

aws apigatewayv2 get-integration \
    --api-id a1b2c3d4 \
    --integration-id a1b2c3

Вывод:

{
    "ApiGatewayManaged": true,
    "ConnectionType": "INTERNET",
    "IntegrationId": "a1b2c3",
    "IntegrationMethod": "POST",
    "IntegrationType": "AWS_PROXY",
    "IntegrationUri": "arn:aws:lambda:us-west-2:12356789012:function:hello12",
    "PayloadFormatVersion": "2.0",
    "TimeoutInMillis": 30000
}

Для получения дополнительной информации см. Конфигурирование интеграций для HTTP API и Настройка интеграций API WebSocket в Руководстве разработчика Amazon API Gateway.

Вывод

ApiGatewayManaged -> (boolean)

Определяет, управляется ли интеграция API Gateway. Если вы создали API с помощью быстрого создания, полученная интеграция управляется API Gateway. Вы можете обновить управляемую интеграцию, но не можете её удалить.

ConnectionId -> (string)

Идентификатор VPC-линка для частной интеграции. Поддерживается только для HTTP API.

ConnectionType -> (string)

Тип сетевого подключения к точке входа интеграции. Укажите INTERNET для подключений через общедоступный маршрутизируемый интернет или VPC_LINK для частных подключений между API Gateway и ресурсами в VPC. Значение по умолчанию — INTERNET.

ContentHandlingStrategy -> (string)

Поддерживается только для WebSocket API. Определяет, как обрабатывать преобразования типов содержимого полезной нагрузки ответа. Поддерживаемые значения — CONVERT_TO_BINARY и CONVERT_TO_TEXT со следующими особенностями:

CONVERT_TO_BINARY: Преобразует полезную нагрузку ответа из Base64-кодированной строки в соответствующий двоичный блок.

CONVERT_TO_TEXT: Преобразует полезную нагрузку ответа из двоичного блока в Base64-кодированную строку.

Если этот параметр не определён, полезная нагрузка ответа будет передана из ответа интеграции в ответ маршрута или метод без изменений.

CredentialsArn -> (string)

Указывает необходимые учетные данные для интеграции, если таковые имеются. Для интеграций с AWS доступны три варианта. Для указания роли IAM, которую должен принять API Gateway, используйте Amazon Resource Name (ARN) роли. Для требования передачи идентификатора вызывающего лица из запроса укажите строку arn:aws:iam::*:user/*. Для использования основанных на ресурсах разрешений для поддерживаемых AWS-сервисов, укажите null.

Description -> (string)

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

IntegrationId -> (string)

Представляет идентификатор интеграции.

IntegrationMethod -> (string)

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

IntegrationResponseSelectionExpression -> (string)

Выражение выбора ответа интеграции для интеграции. Поддерживается только для WebSocket API. См. Выражения выбора ответа интеграции.

IntegrationSubtype -> (string)

Поддерживается только для HTTP API AWS_PROXY интеграций. Указывает действие AWS-сервиса для вызова. Подробнее см. Справочник по типам интеграции.

IntegrationType -> (string)

Тип интеграции. Один из следующих:

AWS: для интеграции запроса маршрута или метода с действием AWS-сервиса, включая действие вызова Lambda-функции. При использовании действия вызова Lambda-функции это называется Lambda-интеграцией с пользовательским кодом. При использовании любого другого действия AWS-сервиса, это называется AWS-интеграцией. Поддерживается только для WebSocket API.

AWS_PROXY: для интеграции запроса маршрута или метода с Lambda-функцией или другим действием AWS-сервиса. Эта интеграция также называется прокси-интеграцией Lambda.

HTTP: для интеграции запроса маршрута или метода с HTTP-точкой входа. Эта интеграция также называется пользовательской HTTP-интеграцией. Поддерживается только для WebSocket API.

HTTP_PROXY: для интеграции запроса маршрута или метода с HTTP-точкой входа, при котором запрос клиента передаётся в неизменённом виде. Это также называется прокси-интеграцией HTTP.

MOCK: для интеграции запроса маршрута или метода с API Gateway как «обратной» точкой входа без вызова любого бэкенда. Поддерживается только для WebSocket API.

IntegrationUri -> (string)

Для интеграции с Lambda укажите URI Lambda-функции.

Для HTTP-интеграции укажите полную URL-адрес.

Для частной интеграции HTTP API укажите ARN слушателя Application Load Balancer, Network Load Balancer или AWS Cloud Map-сервиса. Если вы укажете ARN AWS Cloud Map-сервиса, API Gateway использует DiscoverInstances для определения ресурсов. Вы можете использовать параметры запроса для выбора конкретных ресурсов. Подробнее см. DiscoverInstances. Для частных интеграций все ресурсы должны принадлежать одному и тому же AWS-аккаунту.

PassthroughBehavior -> (string)

Определяет поведение прохождения входящих запросов в зависимости от заголовка Content-Type в запросе и доступных шаблонов сопоставления, указанных как свойство requestTemplates ресурса Integration. Доступны три значения: WHEN_NO_MATCH, WHEN_NO_TEMPLATES и NEVER. Поддерживается только для WebSocket API.

WHEN_NO_MATCH пропускает тело запроса для несопоставленных типов содержимого к интеграционному бэкенду без преобразования.

NEVER отклоняет несопоставленные типы содержимого с ответом HTTP 415 Unsupported Media Type.

WHEN_NO_TEMPLATES позволяет прохождение, когда интеграция не имеет типов содержимого, сопоставленных с шаблонами. Однако, если определён хотя бы один тип содержимого, несопоставленные типы содержимого будут отклонены с тем же ответом HTTP 415 Unsupported Media Type.

PayloadFormatVersion -> (string)

Указывает формат полезной нагрузки, отправляемой в интеграцию. Требуется для HTTP API. Поддерживаемые значения для прокси-интеграций Lambda — 1.0 и 2.0. Для всех других интеграций поддерживается только значение 1.0. Подробнее см. Работа с прокси-интеграциями AWS Lambda для HTTP API.

RequestParameters -> (map)

Для WebSocket API — карта ключ-значение, определяющая параметры запроса, передаваемые от запроса метода к бэкенду. Ключ — имя параметра запроса интеграции, а связанное значение — значение параметра запроса метода или статическое значение, которое должно быть заключено в одинарные кавычки и предварительно закодировано, как требуется бэкендом. Значение параметра запроса метода должно соответствовать шаблону method.request.{location}.{name}, где {location} — querystring, path или header; а {name} — допустимое и уникальное имя параметра запроса метода.

Для HTTP API-интеграций со специфицированным integrationSubtype параметры запроса — карта ключ-значение, определяющая параметры, передаваемые интеграциям AWS_PROXY. Вы можете предоставить статические значения или сопоставить данные запроса, переменные стадии или переменные контекста, которые оцениваются во время выполнения. Подробнее см. Работа с интеграциями AWS-сервисов для HTTP API.

Для HTTP API-интеграций без указанного интеграционного типа параметры запроса — карта ключ-значение, определяющая, как преобразовать HTTP-запросы перед отправкой в бэкенд-интеграции. Ключ должен соответствовать шаблону <действие>:<заголовок|строка запроса|путь>.<местоположение>. Действие может быть append, overwrite или remove. Для значений можно предоставить статические значения или сопоставить данные запроса, переменные стадии или переменные контекста, которые оцениваются во время выполнения. Подробнее см. Преобразование API-запросов и ответов.

ключ -> (строка)

значение -> (строка)

Строка длиной от 1 до 512 символов.

RequestTemplates -> (map)

Представляет карту Velocity-шаблонов, которые применяются к полезной нагрузке запроса на основе значения заголовка Content-Type, отправленного клиентом. Значение типа содержимого является ключом в этой карте, а шаблон (в виде строки) — значением. Поддерживается только для WebSocket API.

ключ -> (строка)

значение -> (строка)

Строка длиной от 0 до 32768 символов.

ResponseParameters -> (map)

Поддерживается только для HTTP API. Параметры ответа используются для преобразования HTTP-ответа от бэкенд-интеграции перед возвращением ответа клиентам. Укажите карту ключ-значение из ключа выбора к параметрам ответа. Ключ выбора должен быть допустимым HTTP-кодом состояния в диапазоне 200-599. Параметры ответа — карта ключ-значение. Ключ должен соответствовать шаблону <действие>:<заголовок>.<местоположение> или overwrite.statuscode. Действие может быть append, overwrite или remove. Значение может быть статическим значением или сопоставлено с данными ответа, переменными стадии или переменными контекста, которые оцениваются во время выполнения. Подробнее см. Преобразование API-запросов и ответов.

ключ -> (строка)

значение -> (карта)

Для HTTP API-интеграций без указанного integrationSubtype параметры запроса — карта ключ-значение, определяющая, как преобразовать HTTP-запросы перед отправкой в бэкенд. Ключ должен соответствовать шаблону <действие>:<заголовок|строка запроса|путь>.<местоположение>, где действие может быть append, overwrite или remove. Для значений можно предоставить статические значения или сопоставить данные запроса, переменные стадии или переменные контекста, которые оцениваются во время выполнения. Подробнее см. Преобразование API-запросов и ответов.

ключ -> (строка)

значение -> (строка)

Строка длиной от 1 до 512 символов.

TemplateSelectionExpression -> (строка)

Выражение выбора шаблона для интеграции. Поддерживается только для WebSocket API.

TimeoutInMillis -> (целое число)

Пользовательский таймаут от 50 до 29 000 миллисекунд для WebSocket API и от 50 до 30 000 миллисекунд для HTTP API. Значение по умолчанию — 29 секунд для WebSocket API и 30 секунд для HTTP API.

TlsConfig -> (структура)

Настройка TLS для частной интеграции. Если вы указываете конфигурацию TLS, трафик частной интеграции использует протокол HTTPS. Поддерживается только для HTTP API.

ServerNameToVerify -> (строка)

Если вы указываете имя сервера, API Gateway использует его для проверки имени хоста в сертификате интеграции. Имя сервера также включается в TLS-рукопожатие для поддержки Server Name Indication (SNI) или виртуального хостинга.