Spec-Zone.ru › AWS CLI v2

[ aws . apigateway ]

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

Описание

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

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

Синтаксис

  update-integration
--rest-api-id <value>
--resource-id <value>
--http-method <value>
[--patch-operations <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-метод запроса на обновление интеграции.

--patch-operations (список)

Дополнительную информацию о поддерживаемых операциях исправления см. в разделе Операции исправления.

(структура)

Дополнительную информацию о поддерживаемых операциях исправления см. в разделе Операции исправления.

op -> (строка)

Операция обновления, которая должна быть выполнена с помощью этого запроса PATCH. Допустимые значения: add, remove, replace или copy. Не все допустимые операции поддерживаются для данного ресурса. Поддержка операций зависит от конкретных контекстов операций. Попытки применить неподдерживаемую операцию к ресурсу приведут к сообщению об ошибке.

path -> (строка)

Целевой объект операции op, определенный значением JSON Pointer, которое ссылается на расположение в целевом ресурсе. Например, если целевой ресурс имеет обновляемое свойство {“name”:”value”}, путь к этому свойству — /name. Если значение свойства name — JSON-объект (например, {“name”: {“child/name”: “child-value”}}), путь к свойству child/name будет /name/child~1name. Любой символ косой черты («/») в именах путей должен быть экранирован с помощью «~1», как показано в примере выше. Каждая операция op может иметь только один связанный путь.

value -> (строка)

Новое целевое значение операции обновления. Применимо для операции add или replace. При использовании AWS CLI для обновления свойства JSON-значения заключите JSON-объект в пару одинарных кавычек в оболочке Linux, например, ‘{“a”: …}’.

from -> (строка)

Источник операции копирования обновления, определенный как значение JSON-указателя, ссылающегося на местоположение в целевом ресурсе, откуда нужно скопировать значение. Например, для продвижения канонического развертывания скопируйте идентификатор канонического развертывания в идентификатор связанного развертывания, выполнив запрос PATCH к ресурсу стадии с «op»:«copy», «from»:«/canarySettings/deploymentId» и «path»:«/deploymentId».

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

op=string,path=string,value=string,from=string ...

JSON-синтаксис:

[
  {
    "op": "add"|"remove"|"replace"|"move"|"copy"|"test",
    "path": "string",
    "value": "string",
    "from": "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
  • таблица
  • 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.

Для добавления отображения «Content-Type: application/json» с настроенным шаблоном Input Passthrough

Команда:

aws apigateway update-integration \
    --rest-api-id a1b2c3d4e5 \
    --resource-id a1b2c3 \
    --http-method POST \
    --patch-operations "op='add',path='/requestTemplates/application~1json'"

Для обновления (замены) шаблона отображения «Content-Type: application/json» настраиваемым шаблоном

Команда:

aws apigateway update-integration \
    --rest-api-id a1b2c3d4e5 \
    --resource-id a1b2c3 \
    --http-method POST \
    --patch-operations "op='replace',path='/requestTemplates/application~1json',value='{"example": "json"}'"

Для обновления (замены) настраиваемого шаблона, связанного с «Content-Type: application/json», на Input Passthrough

Команда:

aws apigateway update-integration \
    --rest-api-id a1b2c3d4e5 \
    --resource-id a1b2c3 \
    --http-method POST \
    --patch-operations "op='replace',path='requestTemplates/application~1json'"

Для удаления шаблона отображения «Content-Type: application/json»

Команда:

aws apigateway update-integration \
    --rest-api-id a1b2c3d4e5 \
    --resource-id a1b2c3 \
    --http-method POST \
    --patch-operations "op='remove',path='/requestTemplates/application~1json'"

Вывод

type -> (строка)

Указывает тип интеграции метода API. Допустимое значение — одно из следующих:

Для интеграций HTTP и прокси HTTP каждый тип интеграции может указать протокол (http/https ), порт и путь. Поддерживаются стандартные порты 80 и 443, а также пользовательские порты выше 1024. Интеграция HTTP или прокси HTTP с connectionType типа VPC_LINK называется частной интеграцией и использует VpcLink для подключения API Gateway к балансировщику нагрузки сети VPC.

httpMethod -> (строка)

Указывает тип HTTP-метода интеграции. Для свойства Type, если вы укажете MOCK , это свойство необязательно. Для интеграций Lambda вы должны установить метод интеграции на POST . Для всех других типов вы должны указать это свойство.

uri -> (строка)

Указывает универсальный идентификатор ресурса (URI) конечной точки интеграции.

Для интеграций HTTP или HTTP_PROXY URI должен быть полностью сформированным, закодированным HTTP(S)-URL в соответствии со спецификацией RFC-3986 для стандартных интеграций. Если connectionType является VPC_LINK, укажите имя DNS балансировщика сети. Для интеграций AWS или AWS_PROXY URI имеет вид arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api} . Здесь {Region} — регион API Gateway (например, us-east-1); {service} — имя интегрированной службы Amazon Web Services (например, s3); а {subdomain} — назначенный домен, поддерживаемый определёнными службами Amazon Web Services для быстрого поиска имени хоста. Для API на основе действий сервиса Amazon Web Services можно использовать action, используя строку запроса Action={name}&{p1}={v1}&p2={v2}…. Полученный {service_api} относится к поддерживаемому действию {name} плюс любые необходимые входные параметры. В качестве альтернативы можно использовать path для API на основе путей сервиса Amazon Web Services. Полученный service_api относится к пути к ресурсу службы Amazon Web Services, включая регион интегрированной службы Amazon Web Services, если применимо. Например, для интеграции с API S3 GetObject URI может быть либо arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}, либо arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}.

connectionType -> (строка)

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

connectionId -> (строка)

Идентификатор VpcLink, используемый для интеграции, когда connectionType=VPC_LINK и неопределён, в противном случае.

credentials -> (строка)

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

requestParameters -> (словарь)

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

key -> (строка)

value -> (строка)

requestTemplates -> (словарь)

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

key -> (строка)

value -> (строка)

passthroughBehavior -> (строка)

Указывает, как тело запроса метода с типом содержимого, не прошедшим сопоставление, будет передаваться в запрос интеграции обратному концу без преобразования. Тип содержимого не сопоставляется, если в интеграции не определен шаблон сопоставления или тип содержимого не соответствует ни одному из сопоставленных типов содержимого, как указано в requestTemplates . Допустимое значение — одно из следующих: WHEN_NO_MATCH : пропускает тело запроса метода через запрос интеграции к обратному концу без преобразования, когда тип содержимого запроса метода не соответствует ни одному из типов содержимого, связанных с шаблонами сопоставления, определёнными в запросе интеграции. WHEN_NO_TEMPLATES : пропускает тело запроса метода через запрос интеграции к обратному концу без преобразования, когда в запросе интеграции не определен ни один шаблон. Если шаблон определён, когда выбран этот параметр, запрос метода с типом содержимого, не прошедшим сопоставление, будет отклонен с ответом HTTP 415 Unsupported Media Type. NEVER : отклоняет запрос метода с ответом HTTP 415 Unsupported Media Type, когда тип содержимого запроса метода не соответствует ни одному из типов содержимого, связанных с шаблонами сопоставления, определёнными в запросе интеграции, или в запросе интеграции не определён ни один шаблон.

contentHandling -> (строка)

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

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

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

Настраиваемый тайм-аут от 50 до 29 000 миллисекунд. Значение по умолчанию — 29 000 миллисекунд или 29 секунд.

cacheNamespace -> (строка)

Указывает группу связанных кэшированных параметров. По умолчанию API Gateway использует идентификатор ресурса в качестве cacheNamespace . Вы можете указать тот же cacheNamespace для различных ресурсов, чтобы получить те же кэшированные данные для запросов к различным ресурсам.

cacheKeyParameters -> (список)

Список параметров запроса, значения которых кешируются API Gateway. Чтобы быть допустимыми значениями для cacheKeyParameters, эти параметры также должны быть указаны для метода requestParameters.

(строка)

integrationResponses -> (словарь)

Указывает ответы интеграции.

key -> (строка)

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

Представляет ответ интеграции. Код состояния должен соответствовать существующему MethodResponse, а параметры и шаблоны могут использоваться для преобразования ответа от обратного конца.

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 без префикса $.

key -> (строка)

value -> (строка)

responseTemplates -> (словарь)

Указывает шаблоны, используемые для преобразования тела ответа интеграции. Шаблоны ответа представлены как словарь пар ключ/значение, где тип контента — ключ, а шаблон — значение.

key -> (строка)

value -> (строка)

contentHandling -> (строка)

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

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

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

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

insecureSkipVerification -> (булево)

Указывает, пропускает ли API Gateway проверку того, выдан ли сертификат для конечной точки интеграции авторитетным центром сертификации. Это не рекомендуется, но оно позволяет использовать сертификаты, подписанные частными центрами сертификации, или самозаверенные сертификаты. Если включено, API Gateway по-прежнему выполняет базовую проверку сертификата, которая включает проверку срока действия сертификата, имени хоста и наличия корневого сертификата авторитета. Поддерживается только для интеграций HTTP и HTTP_PROXY.

Предупреждение

Включение insecureSkipVerification не рекомендуется, особенно для интеграций с общедоступными HTTPS-конечными точками. Если вы включите insecureSkipVerification, вы увеличиваете риск атак «человек посередине».

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

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