Spec-Zone.ru › AWS CLI v2

[ aws . opensearchserverless ]

create-lifecycle-policy

Описание

Создаёт политику жизненного цикла для применения к индексам OpenSearch Serverless. Политики жизненного цикла определяют количество дней или часов, в течение которых данные будут храниться в индексе OpenSearch Serverless. Более подробная информация доступна в разделе Создание политик жизненного цикла данных.

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

create-lifecycle-policy использует значения типа документа. Типы документов соответствуют модели JSON-данных, где допустимые значения: строки, числа, булевы значения, null, массивы и объекты. Для ввода команд, опций и вложенных параметров, помеченных типом document, необходимо предоставить JSON. Краткая синтаксическая запись не поддерживает типы документов.

Синтаксис

  create-lifecycle-policy
--type <value>
--name <value>
[--description <value>]
--policy <value>
[--client-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]

Опции

--type (строка)

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

Возможные значения:

  • retention

--name (строка)

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

--description (строка)

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

--policy (строка)

Документ политики JSON, используемый в качестве содержимого политики жизненного цикла.

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

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

--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 (строка)

Переопределяет адрес по умолчанию команды заданным адресом.

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, отображающего двоичный блок, 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.

Вывод

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

Подробная информация о созданной политике жизненного цикла.

type -> (строка)

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

name -> (строка)

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

policyVersion -> (строка)

Версия политики жизненного цикла.

description -> (строка)

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

policy -> (документ)

Документ политики JSON без пробелов.

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

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

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

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

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

Spec-Zone.ru

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