обновить-интеграцию

Описание

Обновляет интеграцию.

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

Синопсис

  update-integration
--api-id <value>
[--connection-id <value>]
[--connection-type <value>]
[--content-handling-strategy <value>]
[--credentials-arn <value>]
[--description <value>]
--integration-id <value>
[--integration-method <value>]
[--integration-subtype <value>]
[--integration-type <value>]
[--integration-uri <value>]
[--passthrough-behavior <value>]
[--payload-format-version <value>]
[--request-parameters <value>]
[--request-templates <value>]
[--response-parameters <value>]
[--template-selection-expression <value>]
[--timeout-in-millis <value>]
[--tls-config <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.

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

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

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

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

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

INTERNET
VPC_LINK

--content-handling-strategy (строка)

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

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

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

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

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

CONVERT_TO_BINARY
CONVERT_TO_TEXT

--credentials-arn (строка)

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

--description (строка)

Описание интеграции

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

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

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

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

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

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

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

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

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

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

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

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

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

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

AWS
HTTP
MOCK
HTTP_PROXY
AWS_PROXY

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

Для интеграции 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-аккаунту.

--passthrough-behavior (строка)

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

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

WHEN_NO_MATCH
NEVER
WHEN_NO_TEMPLATES

--payload-format-version (строка)

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

--request-parameters (карта)

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

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

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

key -> (строка)

value -> (строка)

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

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--request-templates (карта)

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

key -> (строка)

value -> (строка)

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

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--response-parameters (карта)

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

key -> (строка)

value -> (карта)

key -> (строка)

value -> (строка)

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

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

KeyName1=KeyName1=string,KeyName2=string,KeyName2=KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": {"string": "string"
      ...}
  ...}

--template-selection-expression (строка)

Выражение выбора шаблона для интеграции.

--timeout-in-millis (целое число)

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

--tls-config (структура)

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

ServerNameToVerify -> (строка)

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

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

ServerNameToVerify=string

Синтаксис JSON:

{
  "ServerNameToVerify": "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 для вывода.

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

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

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

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

Примеры

Примечание

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

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

Для обновления интеграции Lambda

Следующий update-integration пример обновляет существующую интеграцию AWS Lambda для использования указанной функции Lambda.

aws apigatewayv2 update-integration \
    --api-id a1b2c3d4 \
    --integration-id a1b2c3 \
    --integration-uri arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:my-new-function/invocations

Вывод:

{
    "ConnectionType": "INTERNET",
    "IntegrationId": "a1b2c3",
    "IntegrationMethod": "POST",
    "IntegrationType": "AWS_PROXY",
    "IntegrationUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:my-new-function/invocations",
    "PayloadFormatVersion": "2.0",
    "TimeoutInMillis": 5000
}

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

Вывод

ApiGatewayManaged -> (boolean)

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

ConnectionId -> (string)

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

ConnectionType -> (string)

ContentHandlingStrategy -> (string)

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

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

CONVERT_TO_TEXT: Преобразует содержимое ответа payload из двоичного blob в Base64-строку.

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

CredentialsArn -> (string)

Указывает необходимые учетные данные для интеграции, если таковые имеются. Для интеграций с AWS доступны три варианта. Чтобы указать роль IAM для делегирования API Gateway, используйте 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 custom интеграцией. В случае любого другого действия AWS-службы это называется AWS интеграцией. Поддерживается только для WebSocket API.

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

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

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

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)

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

RequestParameters -> (map)

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

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

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

key -> (string)

value -> (string)

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

RequestTemplates -> (map)

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

key -> (string)

value -> (string)

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

ResponseParameters -> (map)

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

key -> (string)

value -> (map)

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

key -> (string)

value -> (string)

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

TemplateSelectionExpression -> (string)

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

TimeoutInMillis -> (integer)

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

TlsConfig -> (structure)

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

ServerNameToVerify -> (string)

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