Spec-Zone.ru › AWS CLI v2

[ aws . apigateway ]

Обновление части документации

Описание

Обновляет часть документации.

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

Синтаксис

  update-documentation-part
--rest-api-id <value>
--documentation-part-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.

--documentation-part-id (строка)

Идентификатор части документации, подлежащей обновлению.

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

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

(структура)

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

op -> (строка)

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

path -> (строка)

Цель операции op, определенная значением JSON-указателя, ссылающимся на местоположение в целевом ресурсе. Например, если целевой ресурс имеет обновляемое свойство {“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 на ресурс 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.

Вывод

id -> (строка)

Идентификатор DocumentationPart, сгенерированный API Gateway при создании DocumentationPart.

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

Местоположение API-сущности, к которой относится документация. Допустимые поля зависят от типа целевой API-сущности. Все допустимые поля location не являются обязательными. Если не указано явно, допустимое поле location рассматривается как универсальное и связанное содержимое документации может быть унаследовано соответствующими сущностями, если не переопределено.

type -> (строка)

Тип API-сущности, к которой относится содержимое документации. Допустимые значения: API , AUTHORIZER , MODEL , RESOURCE , METHOD , PATH_PARAMETER , QUERY_PARAMETER , REQUEST_HEADER , REQUEST_BODY , RESPONSE , RESPONSE_HEADER , и RESPONSE_BODY . Наследование содержимого не применяется к любой сущности типа API , AUTHORIZER , METHOD , MODEL , REQUEST_BODY , или RESOURCE.

path -> (строка)

Путь URL целевого объекта. Это допустимое поле для типов API-сущностей RESOURCE , METHOD , PATH_PARAMETER , QUERY_PARAMETER , REQUEST_HEADER , REQUEST_BODY , RESPONSE , RESPONSE_HEADER , и RESPONSE_BODY . Значение по умолчанию — / для корневого ресурса. Когда применимая дочерняя сущность наследует содержимое другой сущности того же типа с более общими спецификациями других атрибутов location, атрибут дочерней сущности path должен соответствовать атрибуту родительской сущности как префиксу.

method -> (строка)

HTTP-глагол метода. Это допустимое поле для типов API-сущностей METHOD , PATH_PARAMETER , QUERY_PARAMETER , REQUEST_HEADER , REQUEST_BODY , RESPONSE , RESPONSE_HEADER , и RESPONSE_BODY . Значение по умолчанию — * для любого метода. Когда применимая дочерняя сущность наследует содержимое сущности того же типа с более общими спецификациями других атрибутов location, атрибут дочерней сущности method должен точно соответствовать атрибуту родительской сущности.

statusCode -> (строка)

HTTP-код состояния ответа. Это допустимое поле для типов API-сущностей RESPONSE , RESPONSE_HEADER , и RESPONSE_BODY . Значение по умолчанию — * для любого кода состояния. Когда применимая дочерняя сущность наследует содержимое сущности того же типа с более общими спецификациями других атрибутов location, атрибут дочерней сущности statusCode должен точно соответствовать атрибуту родительской сущности.

name -> (строка)

Имя целевой API-сущности. Это допустимое и обязательное поле для типов API-сущностей AUTHORIZER , MODEL , PATH_PARAMETER , QUERY_PARAMETER , REQUEST_HEADER , REQUEST_BODY и RESPONSE_HEADER . Это недопустимое поле для любого другого типа сущности.

properties -> (строка)

Словарь API-специфичных пар «ключ-значение», описывающих целевую API-сущность. Карта должна быть закодирована как JSON-строка, например, "{ \"description\": \"The API does ...\" }" . Только соответствующие OpenAPI-документации поля из словаря properties экспортируются и, следовательно, публикуются как часть определений API-сущностей, а исходные части документации экспортируются в расширении OpenAPI от x-amazon-apigateway-documentation.

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

Spec-Zone.ru

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