Spec-Zone.ru › AWS CLI v2

[ aws . opensearch ]

обновить-пакет

Описание

Обновляет пакет для использования с облачными доменными именами Amazon OpenSearch Service. Дополнительную информацию см. в разделе Пользовательские пакеты для Amazon OpenSearch Service.

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

Синтаксис

  update-package
--package-id <value>
--package-source <value>
[--package-description <value>]
[--commit-message <value>]
[--package-configuration <value>]
[--package-encryption-options <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]

Параметры

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

Уникальный идентификатор пакета.

--package-source (структура)

Ведро и ключ Amazon S3 для пакета.

S3BucketName -> (строка)

Имя ведра Amazon S3, содержащего пакет.

S3Key -> (строка)

Ключ (имя файла) пакета.

Сокращённый синтаксис:

S3BucketName=string,S3Key=string

Синтаксис JSON:

{
  "S3BucketName": "string",
  "S3Key": "string"
}

--package-description (строка)

Новое описание пакета.

--commit-message (строка)

Сообщение об изменении для обновленного файла, которое отображается в качестве части GetPackageVersionHistoryResponse.

--package-configuration (структура)

Подробные данные обновлённой конфигурации пакета.

LicenseRequirement -> (строка)

Требования к лицензии для пакета.

LicenseFilepath -> (строка)

Относительный путь к файлу лицензии, связанному с пакетом.

ConfigurationRequirement -> (строка)

Требования к конфигурации для пакета.

RequiresRestartForConfigurationUpdate -> (булево)

Указывает, требуется ли развертывание B/G для обновления конфигурации, для которой плагин является предварительным условием.

Сокращённый синтаксис:

LicenseRequirement=string,LicenseFilepath=string,ConfigurationRequirement=string,RequiresRestartForConfigurationUpdate=boolean

Синтаксис JSON:

{
  "LicenseRequirement": "REQUIRED"|"OPTIONAL"|"NONE",
  "LicenseFilepath": "string",
  "ConfigurationRequirement": "REQUIRED"|"OPTIONAL"|"NONE",
  "RequiresRestartForConfigurationUpdate": true|false
}

--package-encryption-options (структура)

Параметры шифрования для пакета.

KmsKeyIdentifier -> (строка)

Идентификатор ключа KMS для шифрования пакета.

EncryptionEnabled -> (булево)

Включено ли шифрование для пакета.

Сокращённый синтаксис:

KmsKeyIdentifier=string,EncryptionEnabled=boolean

Синтаксис JSON:

{
  "KmsKeyIdentifier": "string",
  "EncryptionEnabled": true|false
}

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

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение null или значение 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.

Вывод

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

Информация о пакете.

PackageID -> (строка)

Уникальный идентификатор пакета.

PackageName -> (строка)

Указанное пользователем имя пакета.

PackageType -> (строка)

Тип пакета.

PackageDescription -> (строка)

Описание пакета, указанное пользователем.

PackageStatus -> (строка)

Текущий статус пакета. Доступные варианты: AVAILABLE , COPYING , COPY_FAILED , VALIDATNG , VALIDATION_FAILED , DELETING и DELETE_FAILED .

CreatedAt -> (метка времени)

Время создания пакета.

LastUpdatedAt -> (метка времени)

Дата и время последнего обновления пакета.

AvailablePackageVersion -> (строка)

Версия пакета.

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

Дополнительная информация, если пакет находится в состоянии ошибки. Иначе — null.

ErrorType -> (строка)

Тип ошибки.

ErrorMessage -> (строка)

Сообщение об ошибке.

EngineVersion -> (строка)

Версия OpenSearch или Elasticsearch в формате Elasticsearch_X.Y или OpenSearch_X.Y. По умолчанию используется последняя версия OpenSearch.

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

Если пакет является пакетом ZIP-PLUGIN, дополнительная информация о свойствах плагина.

Name -> (строка)

Имя плагина.

Description -> (строка)

Описание плагина.

Version -> (строка)

Версия плагина.

ClassName -> (строка)

Имя класса для загрузки.

UncompressedSizeInBytes -> (длинное целое число)

Размер плагина без сжатия.

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

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

LicenseRequirement -> (строка)

Требования к лицензии для пакета.

LicenseFilepath -> (строка)

Относительный путь к файлу лицензии, связанному с пакетом.

ConfigurationRequirement -> (строка)

Требования к конфигурации для пакета.

RequiresRestartForConfigurationUpdate -> (булево)

Указывает, требуется ли развертывание B/G для обновления конфигурации, для которой плагин является предварительным условием.

AllowListedUserList -> (список)

Список пользователей, которым разрешено просматривать и связывать пакет. Это поле видно только владельцу пакета.

(строка)

PackageOwner -> (строка)

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

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

Параметры продажи пакета.

VendingEnabled -> (булево)

Указывает, включена ли функция продажи пакета, что позволяет другим пользователям использовать пакет.

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

Параметры шифрования для пакета.

KmsKeyIdentifier -> (строка)

Идентификатор ключа KMS для шифрования пакета.

EncryptionEnabled -> (булево)

Включено ли шифрование для пакета.

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

Spec-Zone.ru

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