Spec-Zone.ru › AWS CLI v2

[ aws . datazone ]

list-rules

Описание

Выводит список существующих правил. В Amazon DataZone правило — это формальное соглашение, которое накладывает определённые требования на рабочие процессы пользователей (например, публикацию активов в каталог, запросы подписок, создание проектов) в портале данных Amazon DataZone. Эти правила помогают поддерживать согласованность, обеспечивают соответствие требованиям и соблюдение стандартов управления данными в процессах управления данными. Например, правило принудительного применения метаданных может определять необходимую информацию для создания запроса на подписку или публикации актива данных в каталог, обеспечивая соответствие организационным стандартам.

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

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

Синтаксис

  list-rules
[--action <value>]
[--asset-types <value>]
[--data-product | --no-data-product]
--domain-identifier <value>
[--include-cascaded | --no-include-cascaded]
[--project-ids <value>]
[--rule-type <value>]
--target-identifier <value>
--target-type <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]

Параметры

--action (строка)

Действие правила.

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

  • CREATE_LISTING_CHANGE_SET
  • CREATE_SUBSCRIPTION_REQUEST

--asset-types (список)

Типы активов правила.

(строка)

Синтаксис:

"string" "string" ...

--data-product | --no-data-product (булево)

Продукт данных правила.

--domain-identifier (строка)

Идентификатор домена, в котором необходимо перечислить правила.

--include-cascaded | --no-include-cascaded (булево)

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

--project-ids (список)

Идентификаторы проектов, в которых необходимо перечислить правила.

(строка)

Синтаксис:

"string" "string" ...

--rule-type (строка)

Тип правила.

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

  • METADATA_FORM_ENFORCEMENT

--target-identifier (строка)

Идентификатор целевого объекта правила.

--target-type (строка)

Тип целевого объекта правила.

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

  • DOMAIN_UNIT

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

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

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

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

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

Вывод

items -> (список)

Результаты действия ListRules.

(структура)

Сводка правила.

action -> (строка)

Действие правила.

identifier -> (строка)

Идентификатор правила.

lastUpdatedBy -> (строка)

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

name -> (строка)

Название правила.

revision -> (строка)

Ревизия правила.

ruleType -> (строка)

Тип правила.

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

Область действия правила.

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

Тип актива, включённый в область действия правила.

selectionMode -> (строка)

Режим выбора для правила.

specificAssetTypes -> (список)

Конкретные типы активов, которые включены в правило.

(строка)

dataProduct -> (булево)

Продукт данных, включённый в область действия правила.

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

Проект, включённый в область действия правила.

selectionMode -> (строка)

Режим выбора правила.

specificProjects -> (список)

Конкретные проекты, в которых создано правило.

(строка)

target -> (структура сортированного объединения)

Целевой объект правила.

Примечание

Это структура сортированного объединения. Только один из следующих ключевых элементов верхнего уровня может быть установлен: domainUnitTarget.

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

Идентификатор единицы домена.

domainUnitId -> (строка)

Идентификатор единицы домена.

includeChildDomainUnits -> (булево)

Указывает, применяется ли правило к дочерним единицам домена.

targetType -> (строка)

Тип целевого объекта правила.

updatedAt -> (отметка времени)

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

nextToken -> (строка)

Если количество правил больше значения по умолчанию для параметра MaxResults или если вы явно задали значение для MaxResults, которое меньше количества правил, ответ включает токен постраничной загрузки, называемый NextToken. Вы можете указать это значение NextToken в последующем вызове ListRules для перечисления следующего набора правил.

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

Spec-Zone.ru

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