Spec-Zone.ru › AWS CLI v2

[ aws . rbin ]

list-rules

Описание

Отображает правила удержания в корзине переработки в регионе.

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

list-rules — это постраничная операция. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлекать данные из результатов следующих выражений запроса: Rules

Синтаксис

  list-rules
--resource-type <value>
[--resource-tags <value>]
[--lock-state <value>]
[--exclude-resource-tags <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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-type (строка)

Тип ресурса, сохраняемый правилом удержания. Отображаются только правила удержания, сохраняющие указанный тип ресурса. В настоящее время поддерживаются только снимки Amazon EBS и AMI на основе EBS. Чтобы отобразить правила удержания, сохраняющие снимки, укажите EBS_SNAPSHOT. Чтобы отобразить правила удержания, сохраняющие AMI на основе EBS, укажите EC2_IMAGE.

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

  • EBS_SNAPSHOT
  • EC2_IMAGE

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

[Только правила удержания на уровне тегов] Информация о тегах ресурсов, используемых для определения ресурсов, которые сохраняются правилом удержания.

(структура)

[Только правила удержания на уровне тегов] Информация о тегах ресурсов, используемых для определения ресурсов, которые сохраняются правилом удержания.

ResourceTagKey -> (строка)

Ключ тега.

ResourceTagValue -> (строка)

Значение тега.

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

ResourceTagKey=string,ResourceTagValue=string ...

Синтаксис JSON:

[
  {
    "ResourceTagKey": "string",
    "ResourceTagValue": "string"
  }
  ...
]

--lock-state (строка)

Состояние блокировки правил удержания для отображения. Возвращаются только правила удержания со значением состояния блокировки.

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

  • locked
  • pending_unlock
  • unlocked

--exclude-resource-tags (список)

[Только правила удержания на уровне региона] Информация о тегах исключений, используемых для определения ресурсов, которые должны быть исключены или проигнорированы правилом удержания.

(структура)

[Только правила удержания на уровне тегов] Информация о тегах ресурсов, используемых для определения ресурсов, которые сохраняются правилом удержания.

ResourceTagKey -> (строка)

Ключ тега.

ResourceTagValue -> (строка)

Значение тега.

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

ResourceTagKey=string,ResourceTagValue=string ...

Синтаксис JSON:

[
  {
    "ResourceTagKey": "string",
    "ResourceTagValue": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с использованием предоставленного значения JSON, поскольку строка будет интерпретирована буквально. Это не может быть указано вместе с --cli-input-yaml.

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

Маркер для указания точки начала постраничного просмотра. Это значение NextToken из ранее укороченного ответа.

Примеры использования см. в разделе Постраничный просмотр в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничный просмотр в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничного просмотра предоставьте значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken непосредственно вне AWS CLI.

Примеры использования см. в разделе Постраничный просмотр в Руководстве пользователя AWS Command Line Interface.

--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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

Rules -> (список)

Информация о правилах удержания.

(структура)

Информация о правиле удержания в корзине переработки.

Identifier -> (строка)

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

Description -> (строка)

Описание правила удержания.

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

Информация о периоде удержания, в течение которого правило удержания должно сохранять ресурсы.

RetentionPeriodValue -> (целое число)

Значение периода, в течение которого правило удержания должно сохранять ресурсы. Период измеряется с использованием единицы, указанной для RetentionPeriodUnit.

RetentionPeriodUnit -> (строка)

Единица измерения периода удержания. В настоящее время поддерживается только DAYS.

LockState -> (строка)

[Только правила удержания на уровне региона] Состояние блокировки для правила удержания.

  • locked — Правило удержания заблокировано и не может быть изменено или удалено.
  • pending_unlock — Правило удержания разблокировано, но все еще находится в периоде отсрочки разблокировки. Правило удержания может быть изменено или удалено только после истечения периода отсрочки разблокировки.
  • unlocked — Правило удержания разблокировано и может быть изменено или удалено любым пользователем с необходимыми разрешениями.
  • null — Правило удержания никогда не блокировалось. После того, как правило удержания заблокировано, оно может переходить только между состояниями locked и unlocked; оно никогда не может вернуться в состояние null.

RuleArn -> (строка)

Amazon Resource Name (ARN) правила удержания.

NextToken -> (строка)

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

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

Spec-Zone.ru

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