Spec-Zone.ru › AWS CLI v2

[ aws . opensearch ]

описание-пакетов

Описание

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

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

Синтаксис

  describe-packages
[--filters <value>]
[--max-results <value>]
[--next-token <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]

Параметры

--filters (список)

Возвращает только пакеты, соответствующие значениям DescribePackagesFilterList.

(структура)

Фильтр для применения к ответу DescribePackage.

Имя -> (строка)

Любое поле из PackageDetails.

Значение -> (список)

Непустой список значений для указанного поля фильтра.

(строка)

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

Name=string,Value=string,string ...

Синтаксис JSON:

[
  {
    "Name": "PackageID"|"PackageName"|"PackageStatus"|"PackageType"|"EngineVersion"|"PackageOwner",
    "Value": ["string", ...]
  }
  ...
]

--max-results (целое число)

Необязательный параметр, определяющий максимальное количество результатов для возврата. Вы можете использовать nextToken, чтобы получить следующую страницу результатов.

--next-token (строка)

Если ваше начальное DescribePackageFilters действие возвращает nextToken, вы можете включить возвращенное nextToken в последующих операциях DescribePackageFilters, которые возвращают результаты на следующей странице.

--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-auto-prompt (булево)

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

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

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

Вывод

PackageDetailsList -> (список)

Основная информация о пакете.

(структура)

Основная информация о пакете.

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 -> (булево)

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

NextToken -> (строка)

Если возвращается nextToken, доступны дополнительные результаты. Значение nextToken — уникальный маркер постраничной навигации для каждой страницы. Отправьте запрос снова, используя возвращенный маркер, чтобы получить следующую страницу.

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

Spec-Zone.ru

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