Spec-Zone.ru › AWS CLI v2

[ aws . opensearchserverless ]

batch-get-collection

Описание

Возвращает атрибуты одной или нескольких коллекций, включая конечную точку коллекции и конечную точку OpenSearch Dashboards. Дополнительная информация доступна в разделе Создание и управление коллекциями Amazon OpenSearch Serverless.

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

Синтаксис

  batch-get-collection
[--ids <value>]
[--names <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]

Параметры

--ids (список)

Список идентификаторов коллекций. Вы не можете указать имена и идентификаторы в одном запросе. Идентификатор является частью конечной точки коллекции. Вы также можете получить его, используя API ListCollections.

(строка)

Синтаксис:

"string" "string" ...

--names (список)

Список имён коллекций. Вы не можете указать имена и идентификаторы в одном запросе.

(строка)

Синтаксис:

"string" "string" ...

--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 для вывода.

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

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

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

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

Вывод

collectionDetails -> (список)

Детали каждой коллекции.

(структура)

Информация о каждой коллекции OpenSearch Serverless, включая конечную точку коллекции и конечную точку OpenSearch Dashboards.

id -> (строка)

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

name -> (строка)

Имя коллекции.

status -> (строка)

Текущий статус коллекции.

type -> (строка)

Тип коллекции.

description -> (строка)

Описание коллекции.

arn -> (строка)

Amazon Resource Name (ARN) коллекции.

kmsKeyArn -> (строка)

ARN ключа Amazon Web Services KMS, используемого для шифрования коллекции.

standbyReplicas -> (строка)

Детали коллекции OpenSearch Serverless.

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

Время эпохи, когда была создана коллекция.

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

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

collectionEndpoint -> (строка)

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

dashboardEndpoint -> (строка)

Конечная точка, специфичная для коллекции, используемая для доступа к OpenSearch Dashboards.

failureCode -> (строка)

Код ошибки, связанный с запросом.

failureMessage -> (строка)

Сообщение, связанное с кодом ошибки.

collectionErrorDetails -> (список)

Информация об ошибках запроса.

(структура)

Информация об ошибках запроса OpenSearch Serverless.

id -> (строка)

Если запрос содержит идентификаторы коллекций, ответ включает предоставленные в запросе идентификаторы.

name -> (строка)

Если запрос содержит имена коллекций, ответ включает предоставленные в запросе имена.

errorMessage -> (строка)

Описание ошибки. Например, The specified Collection is not found.

errorCode -> (строка)

Код ошибки запроса. Например, NOT_FOUND .

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

Spec-Zone.ru

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