Spec-Zone.ru › AWS CLI v2

[ aws . opensearch ]

получить-приложение

Описание

Извлекает конфигурацию и статус существующего приложения OpenSearch.

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

Синтаксис

  get-application
--id <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]

Параметры

--id (строка)

Уникальный идентификатор приложения OpenSearch для извлечения.

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

Вывод

id -> (строка)

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

arn -> (строка)

Amazon Resource Name (ARN) домена. Дополнительную информацию см. в разделе «Идентификаторы сущностей IAM» в документе «Использование управления идентичностью и доступом Amazon Web Services».

name -> (строка)

Название приложения OpenSearch.

endpoint -> (строка)

Адрес URL приложения OpenSearch.

status -> (строка)

Текущий статус приложения OpenSearch. Возможные значения: CREATING, UPDATING, DELETING, FAILED, ACTIVE и DELETED.

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

Настройки IAM Identity Center, настроенные для приложения OpenSearch.

enabled -> (булево)

Указывает, включен ли IAM Identity Center для приложения OpenSearch.

iamIdentityCenterInstanceArn -> (строка)

Amazon Resource Name (ARN) домена. Дополнительную информацию см. в разделе «Идентификаторы сущностей IAM» в документе «Использование управления идентичностью и доступом Amazon Web Services».

iamRoleForIdentityCenterApplicationArn -> (строка)

Amazon Resource Name (ARN) роли IAM, назначенной приложению IAM Identity Center для приложения OpenSearch.

iamIdentityCenterApplicationArn -> (строка)

Amazon Resource Name (ARN) домена. Дополнительную информацию см. в разделе «Идентификаторы сущностей IAM» в документе «Использование управления идентичностью и доступом Amazon Web Services».

dataSources -> (список)

Источники данных, связанные с приложением OpenSearch.

(структура)

Источники данных, связанные с приложением OpenSearch.

dataSourceArn -> (строка)

Amazon Resource Name (ARN) домена. Дополнительную информацию см. в разделе «Идентификаторы сущностей IAM» в документе «Использование управления идентичностью и доступом Amazon Web Services».

dataSourceDescription -> (строка)

Подробное описание источника данных.

appConfigs -> (список)

Настройки конфигурации приложения OpenSearch.

(структура)

Настройки конфигурации приложения OpenSearch. Дополнительную информацию см. в разделе Использование пользовательского интерфейса OpenSearch в Amazon OpenSearch Service.

key -> (строка)

Элемент конфигурации для установки, например, роль администратора для приложения OpenSearch.

value -> (строка)

Значение, назначенное ключу конфигурации, например, ARN пользователя IAM.

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

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

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

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

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

Spec-Zone.ru

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