Spec-Zone.ru › AWS CLI v2

[ aws . opensearch ]

associate-package

Описание

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

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

Синтаксис

  associate-package
--package-id <value>
--domain-name <value>
[--prerequisite-package-id-list <value>]
[--association-configuration <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 (строка)

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

--domain-name (строка)

Имя домена, с которым нужно связать пакет.

--prerequisite-package-id-list (список)

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

(строка)

Синтаксис:

"string" "string" ...

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

Настройка для связывания пакета с облачным доменным именем Amazon OpenSearch Service.

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

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

KeyAccessRoleArn -> (строка)

Идентификатор роли для доступа к ключу хранилища ключей

KeyStoreAccessEnabled -> (логическое)

Указывает, включен ли доступ к хранилищу ключей

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

KeyStoreAccessOption={KeyAccessRoleArn=string,KeyStoreAccessEnabled=boolean}

Синтаксис JSON:

{
  "KeyStoreAccessOption": {
    "KeyAccessRoleArn": "string",
    "KeyStoreAccessEnabled": 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
  • таблица
  • 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.

Вывод

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

Информация о пакете, связанном с доменом.

PackageID -> (строка)

Внутренний идентификатор пакета.

PackageName -> (строка)

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

PackageType -> (строка)

Тип пакета.

LastUpdated -> (временная метка)

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

DomainName -> (строка)

Имя домена, с которым связан пакет.

DomainPackageStatus -> (строка)

Состояние связи.

PackageVersion -> (строка)

Текущая версия пакета.

PrerequisitePackageIDList -> (список)

Список идентификаторов пакетов, которые должны быть связаны с доменом перед или вместе с пакетом, который можно связать.

(строка)

ReferencePath -> (строка)

Относительный путь пакета на узлах кластера OpenSearch Service. Это synonym_path, когда пакет предназначен для файлов синонимов.

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

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

ErrorType -> (строка)

Тип ошибки, которая произошла.

ErrorMessage -> (строка)

Сообщение, описывающее ошибку.

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

Настройка для связывания пакета с облачным доменным именем Amazon OpenSearch Service.

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

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

KeyAccessRoleArn -> (строка)

Идентификатор роли для доступа к ключу хранилища ключей

KeyStoreAccessEnabled -> (логическое)

Указывает, включен ли доступ к хранилищу ключей

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

Spec-Zone.ru

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