Spec-Zone.ru › AWS CLI v2

[ aws . databrew ]

describe-ruleset

Описание

Получает подробную информацию о наборе правил.

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

Синтаксис

  describe-ruleset
--name <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]

Параметры

--name (строка)

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

--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
  • текст
  • таблица
  • 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.

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

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

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

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

Вывод

Имя -> (строка)

Имя набора правил.

Описание -> (строка)

Описание набора правил.

TargetArn -> (строка)

Amazon Resource Name (ARN) ресурса (набора данных), с которым связан набор правил.

Правила -> (список)

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

(структура)

Представляет собой одно требование качества данных, которое должно быть проверено в рамках этого набора данных.

Имя -> (строка)

Имя правила.

Отключено -> (булево)

Значение, указывающее, отключено ли правило. После отключения правила профиль-задание не будет проверять его во время выполнения задания. Значение по умолчанию — ложь.

Выражение проверки -> (строка)

Выражение, которое включает ссылки на столбцы, имена условий, за которыми следуют ссылки на переменные, возможно, сгруппированные и объединённые с другими условиями. Например, (:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2). Ссылки на столбцы и значения являются переменными подстановки, которые должны начинаться с символа ':'. В зависимости от контекста, значения переменных подстановки могут быть либо фактическим значением, либо именем столбца. Эти значения определены в SubstitutionMap. Если CheckExpression начинается со ссылки на столбец, то ColumnSelectors в правиле должны быть null. Если ColumnSelectors определены, то не должно быть ссылки на столбец в левой части условия, например, is_between :val1 and :val2.

Дополнительную информацию можно найти в разделе Доступные проверки

SubstitutionMap -> (карта)

Карта имён переменных подстановки и их значений, используемых в выражении проверки. Имена переменных должны начинаться с символа ':' (двоеточие). Значения переменных могут быть либо фактическими значениями, либо именами столбцов. Чтобы отличить их, имена столбцов должны быть заключены в обратные кавычки, например, ":col1": "`Column A`".

ключ -> (строка)

значение -> (строка)

Порог -> (структура)

Порог, используемый с выражением проверки, не являющимся агрегированным. Выражения проверки, не являющиеся агрегированными, будут применяться к каждой строке в определённом столбце, и порог будет использоваться для определения того, пройдена ли проверка.

Значение -> (двойное число)

Значение порога.

Тип -> (строка)

Тип порога. Используется для сравнения фактического количества строк, удовлетворяющих правилу, со значением порога.

Единица -> (строка)

Единица значения порога. Может быть либо COUNT, либо PERCENTAGE от полного размера выборки, используемой для проверки.

ColumnSelectors -> (список)

Список селекторов столбцов. Селекторы могут быть использованы для выбора столбцов по имени или регулярному выражению из набора данных. Правило будет применено к выбранным столбцам.

(структура)

Селектор столбца из набора данных для конфигурации задания профилирования. Один селектор содержит либо имя столбца, либо регулярное выражение.

Regex -> (строка)

Регулярное выражение для выбора столбца из набора данных.

Имя -> (строка)

Имя столбца из набора данных.

Дата создания -> (временная метка)

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

Создано -> (строка)

Amazon Resource Name (ARN) пользователя, создавшего набор правил.

Изменено пользователем -> (строка)

Amazon Resource Name (ARN) пользователя, который последний раз изменял набор правил.

Дата последнего изменения -> (временная метка)

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

ResourceArn -> (строка)

Amazon Resource Name (ARN) для набора правил.

Теги -> (карта)

Теги метаданных, применённые к набору правил.

ключ -> (строка)

значение -> (строка)

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

Spec-Zone.ru

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