Spec-Zone.ru › AWS CLI v2

[ aws . opensearch ]

создать-пакет

Описание

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

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

Синтаксис

  create-package
--package-name <value>
--package-type <value>
[--package-description <value>]
--package-source <value>
[--package-configuration <value>]
[--engine-version <value>]
[--package-vending-options <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-name (строка)

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

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

Тип пакета.

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

  • TXT-DICTIONARY
  • ZIP-PLUGIN
  • PACKAGE-LICENSE
  • PACKAGE-CONFIG

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

Описание пакета.

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

Расположение пакета в Amazon S3, откуда следует импортировать пакет.

S3BucketName -> (строка)

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

S3Key -> (строка)

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

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

S3BucketName=string,S3Key=string

Синтаксис JSON:

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

--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
}

--engine-version (строка)

Версия движка Amazon OpenSearch Service, совместимого с пакетом. Это можно указать только для типа пакета ZIP-PLUGIN

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

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

VendingEnabled -> (булево)

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

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

VendingEnabled=boolean

Синтаксис JSON:

{
  "VendingEnabled": 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. Если предоставлено без значения или со значением 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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

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

Базовая информация о пакете OpenSearch Service.

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