Spec-Zone.ru › AWS CLI v2

[ aws . apigateway ]

обновить-ресурс

Описание

Изменяет информацию о ресурсе Resource.

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

Синтаксис

  update-resource
--rest-api-id <value>
--resource-id <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 (строка)

Идентификатор ресурса Resource.

--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-Pointer, ссылающимся на расположение в целевом ресурсе, откуда нужно скопировать значение. Например, чтобы произвести продвижение развертывания canary, необходимо скопировать идентификатор развертывания canary в соответствующий идентификатор развертывания, выполнив запрос PATCH к ресурсу Stage с параметрами “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
  • текст
  • таблица
  • 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.

Переместить ресурс и поместить его под другой родительский ресурс в API

Команда:

aws apigateway update-resource --rest-api-id 1234123412 --resource-id 1a2b3c --patch-operations op=replace,path=/parentId,value='3c2b1a'

Вывод:

{
    "path": "/resource",
    "pathPart": "resource",
    "id": "1a2b3c",
    "parentId": "3c2b1a"
}

Переименовать ресурс (pathPart) в API

Команда:

aws apigateway update-resource --rest-api-id 1234123412 --resource-id 1a2b3c --patch-operations op=replace,path=/pathPart,value=newresourcename

Вывод:

{
    "path": "/newresourcename",
    "pathPart": "newresourcename",
    "id": "1a2b3c",
    "parentId": "3c2b1a"
}

Вывод

id -> (строка)

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

parentId -> (строка)

Идентификатор родительского ресурса.

pathPart -> (строка)

Последний сегмент пути для этого ресурса.

path -> (строка)

Полный путь для этого ресурса.

resourceMethods -> (карта)

Получает метод API-ресурса для заданного HTTP-глагола.

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

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

Представляет интерфейс, ориентированный на клиента, с помощью которого клиент вызывает API для доступа к ресурсам бэкенда. Ресурс метода интегрирован с ресурсом интеграции. Оба состоят из запроса и одного или нескольких ответов. Запрос метода принимает входные данные клиента, которые передаются в бэкенд через запрос интеграции. Ответ метода возвращает выходные данные из бэкенда клиенту через ответ интеграции. Запрос метода воплощен в ресурсе Метод, тогда как запрос интеграции воплощен в ресурсе Интеграция. С другой стороны, ответ метода представлен ресурсом MethodResponse, тогда как ответ интеграции представлен ресурсом IntegrationResponse.

httpMethod -> (строка)

HTTP-глагол метода.

authorizationType -> (строка)

Тип авторизации метода. Допустимые значения — NONE для открытого доступа, AWS_IAM для использования разрешений AWS IAM, CUSTOM для использования пользовательского авторизатора или COGNITO_USER_POOLS для использования пула пользователей Cognito.

authorizerId -> (строка)

Идентификатор авторизатора, который следует использовать для этого метода. authorizationType должен быть CUSTOM .

apiKeyRequired -> (булево)

Флаг булевого типа, указывающий, требуется ли действительный ApiKey для вызова этого метода.

requestValidatorId -> (строка)

Идентификатор RequestValidator для проверки запросов.

operationName -> (строка)

Человекопонятный идентификатор операции для метода. Например, вы можете назначить operationName значение ListPets для метода GET /pets в примере PetStore.

requestParameters -> (карта)

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

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

значение -> (булево)

requestModels -> (карта)

Карта ключ-значение, определяющая схемы данных, представленные ресурсами модели (как сопоставленное значение) полезных данных запроса для заданных типов содержимого (как ключ сопоставления).

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

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

methodResponses -> (карта)

Получает ответ метода, связанный с заданным кодом HTTP-статуса.

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

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

Представляет ответ метода для заданного кода HTTP-статуса, возвращаемый клиенту. Ответ метода передается из бэкенда через связанный ответ интеграции, который можно преобразовать с помощью шаблона сопоставления.

statusCode -> (строка)

Код HTTP-статуса ответа метода.

responseParameters -> (карта)

Карта ключ-значение, определяющая необходимые или необязательные параметры ответа, которые API Gateway может отправлять обратно вызывающему. Ключ определяет заголовок ответа метода, а значение указывает, требуется ли соответствующий заголовок ответа метода. Выражение ключа должно соответствовать шаблону method.response.header.{name}, где name — допустимое и уникальное имя заголовка. API Gateway передает определенные данные ответа интеграции в заголовки ответа метода, указанные здесь, в соответствии с сопоставлением, которое вы задаете в IntegrationResponse API. Данные ответа интеграции, которые можно сопоставить, включают заголовок ответа интеграции, выраженный в integration.response.header.{name}, статическое значение, заключенное в пару одинарных кавычек (например, 'application/json'), или выражение JSON из полезных данных ответа бэкенда в форме integration.response.body.{JSON-expression}, где JSON-expression — допустимое выражение JSON без префикса $.)

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

значение -> (булево)

responseModels -> (карта)

Определяет ресурсы модели, используемые для типа содержимого ответа. Модели ответов представлены как карта ключ/значение, где тип содержимого — ключ, а имя модели — значение.

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

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

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

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

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 должен быть полностью сформированным, закодированным URL-адресом HTTP(S) в соответствии со спецификацией 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 для быстрого поиска имени хоста. action может использоваться для API на основе действий Amazon Web Services, используя строку запроса Action={name}&{p1}={v1}&p2={v2}…. Результирующий {service_api} относится к поддерживаемому действию {name} плюс любые необходимые входные параметры. В качестве альтернативы можно использовать путь для 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 , вы увеличиваете риск атак «человек посередине».

authorizationScopes -> (список)

Список областей авторизации, настроенных для метода. Области используются с авторизатором COGNITO_USER_POOLS для авторизации вызова метода. Авторизация работает путем сопоставления областей метода с областями, извлеченными из маркера доступа в входящем запросе. Вызов метода авторизуется, если любая область метода соответствует заявленой области в маркере доступа. В противном случае вызов не авторизуется. Когда настраивается область метода, клиент должен предоставить маркер доступа вместо маркера удостоверения для целей авторизации.

(строка)

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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