get-integrations

Описание

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

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

get-integrations — это страничная операция. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить страничное отображение, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответной страничной форме, аргумент --query должен извлекать данные из результатов следующих выражений запроса: Items

Синтаксис

  get-integrations
--api-id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставляемому --generate-cli-skeleton. Если другие аргументы предоставляются в командной строке, эти значения перепишут значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен для указания места начала страничной обработки. Это NextToken из ранее урезанного ответа.

Примеры использования см. в разделе «Страничное отображение» в Руководстве пользователя AWS Command Line Interface.

--page-size (строка)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить таймаут вызовов AWS-сервиса.

Примеры использования см. в разделе «Страничное отображение» в Руководстве пользователя AWS Command Line Interface.

--max-items (строка)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления страничной обработки укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе «Страничное отображение» в Руководстве пользователя AWS Command Line Interface.

--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-auto-prompt (логическое значение)

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

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

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

Примеры

Примечание

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

За исключением случаев, когда указано иное, все примеры имеют правила цитирования, похожие на правила UNIX. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. раздел «Использование кавычек со строками» в Руководстве пользователя AWS CLI.

Получение списка интеграций

Следующий get-integrations пример отображает список всех интеграций API.

aws apigatewayv2 get-integrations \
    --api-id a1b2c3d4

Вывод:

{
    "Items": [
        {
            "ApiGatewayManaged": true,
            "ConnectionType": "INTERNET",
            "IntegrationId": "a1b2c3",
            "IntegrationMethod": "POST",
            "IntegrationType": "AWS_PROXY",
            "IntegrationUri": "arn:aws:lambda:us-west-2:123456789012:function:my-function",
            "PayloadFormatVersion": "2.0",
            "TimeoutInMillis": 30000
        },
        {
            "ConnectionType": "INTERNET",
            "IntegrationId": "a1b2c4",
            "IntegrationMethod": "ANY",
            "IntegrationType": "HTTP_PROXY",
            "IntegrationUri": "https://www.example.com",
            "PayloadFormatVersion": "1.0",
            "TimeoutInMillis": 30000
        }
    ]
}

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

Вывод

Элементы -> (список)

Элементы из этого набора.

(структура)

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

ApiGatewayManaged -> (boolean)

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

ConnectionId -> (строка)

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

ConnectionType -> (строка)

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

ContentHandlingStrategy -> (строка)

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

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

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

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

CredentialsArn -> (строка)

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

Description -> (строка)

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

IntegrationId -> (строка)

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

IntegrationMethod -> (строка)

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

IntegrationResponseSelectionExpression -> (строка)

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

IntegrationSubtype -> (строка)

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

IntegrationType -> (строка)

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

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 -> (строка)

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

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

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

PassthroughBehavior -> (строка)

Указывает поведение прохождения для входящих запросов на основе заголовка 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 -> (строка)

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

RequestParameters -> (карта)

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

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

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

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

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

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

RequestTemplates -> (карта)

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

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

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

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

ResponseParameters -> (карта)

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

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

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

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

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

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

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

TemplateSelectionExpression -> (строка)

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

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

Настраиваемый таймаут от 50 до 29000 миллисекунд для WebSocket API и от 50 до 30000 миллисекунд для HTTP API. По умолчанию таймаут составляет 29 секунд для WebSocket API и 30 секунд для HTTP API.

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

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

ServerNameToVerify -> (строка)

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

NextToken -> (строка)

Следующая страница элементов из этого набора. Недействительно для последнего элемента набора.