Spec-Zone.ru › AWS CLI v2

[ aws . opensearchserverless ]

batch-get-effective-lifecycle-policy

Описание

Возвращает список успешных и неудачных извлечений для индексов OpenSearch Serverless. Дополнительную информацию см. в разделе Просмотр политик жизненного цикла данных .

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

Синтаксис

  batch-get-effective-lifecycle-policy
--resource-identifiers <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]

Параметры

--resource-identifiers (список)

Уникальные идентификаторы типов политик и имен ресурсов.

(структура)

Уникальные идентификаторы типов политик и имен ресурсов.

type -> (строка)

Тип политики жизненного цикла.

resource -> (строка)

Имя ресурса индекса OpenSearch Serverless.

Сокращенная запись:

type=string,resource=string ...

Синтаксис JSON:

[
  {
    "type": "retention",
    "resource": "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
  • таблица
  • 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.

Вывод

effectiveLifecyclePolicyDetails -> (список)

Список политик жизненного цикла, примененных к индексам OpenSearch Serverless.

(структура)

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

type -> (строка)

Тип политики жизненного цикла.

resource -> (строка)

Имя ресурса индекса OpenSearch Serverless.

policyName -> (строка)

Имя политики жизненного цикла.

resourceType -> (строка)

Тип ресурса OpenSearch Serverless. В настоящее время поддерживается только ресурс index.

retentionPeriod -> (строка)

Минимальное количество дней или часов хранения индексов. Это необязательный параметр, который будет возвращен только в случае его установки.

noMinRetentionPeriod -> (логическое значение)

Установленное минимальное количество дней хранения индексов. Это необязательный параметр, который будет возвращен как true, если минимальное количество дней или часов не установлено для ресурса индекса.

effectiveLifecyclePolicyErrorDetails -> (список)

Список ресурсов, для которых извлечение не удалось.

(структура)

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

type -> (строка)

Тип политики жизненного цикла.

resource -> (строка)

Имя ресурса индекса OpenSearch Serverless.

errorMessage -> (строка)

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

errorCode -> (строка)

Код ошибки запроса.

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

Spec-Zone.ru

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