Spec-Zone.ru › AWS CLI v2

[ aws . databrew ]

list-recipes

Описание

Выводит список всех определённых рецептов DataBrew.

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

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

Синтаксис

  list-recipes
[--recipe-version <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]

Параметры

--recipe-version (строка)

Возвращает только те рецепты, у которых идентификатор версии равен LATEST_WORKING или LATEST_PUBLISHED. Если RecipeVersion опущен, ListRecipes возвращает все версии рецептов LATEST_PUBLISHED.

Допустимые значения: LATEST_WORKING | LATEST_PUBLISHED

--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.

Вывод

Recipes -> (список)

Список определённых рецептов.

(структура)

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

CreatedBy -> (строка)

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

CreateDate -> (дата и время)

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

LastModifiedBy -> (строка)

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

LastModifiedDate -> (дата и время)

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

ProjectName -> (строка)

Имя проекта, к которому относится рецепт.

PublishedBy -> (строка)

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

PublishedDate -> (дата и время)

Дата и время публикации рецепта.

Description -> (строка)

Описание рецепта.

Name -> (строка)

Уникальное имя рецепта.

ResourceArn -> (строка)

Amazon Resource Name (ARN) для рецепта.

Steps -> (список)

Список шагов, определённых рецептом.

(структура)

Представляет собой отдельный шаг из рецепта DataBrew, который должен быть выполнен.

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

Конкретное действие, которое должно быть выполнено в шаге рецепта.

Operation -> (строка)

Название допустимой трансформации DataBrew, которая должна быть выполнена над данными.

Parameters -> (карта)

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

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

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

ConditionExpressions -> (список)

Один или несколько условий, которые должны быть выполнены для успешного выполнения шага рецепта.

Примечание

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

(структура)

Представляет собой отдельное условие, которое оценивается как истинное или ложное.

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

Если рецепт требует более одного условия, то рецепт должен указать несколько элементов ConditionExpression. Каждое условие применяется к строкам в наборе данных перед выполнением действия рецепта.

Condition -> (строка)

Конкретное условие, которое следует применить к действию рецепта. Для получения дополнительной информации см. Структура рецепта в Руководстве разработчика Glue DataBrew.

Value -> (строка)

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

TargetColumn -> (строка)

Столбец, к которому следует применить данное условие.

Tags -> (карта)

Метки метаданных, применённые к рецепту.

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

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

RecipeVersion -> (строка)

Идентификатор версии рецепта. Должен быть одним из следующих:

  • Версия с числовым значением (X.Y ) — X и Y представляют собой номера основной и дополнительной версии. Максимальная длина каждого из них — 6 цифр, и ни одно из них не может быть отрицательным значением. И X, и Y обязательны, и «0.0» не является допустимой версией.
  • LATEST_WORKING — самая последняя допустимая версия, разрабатываемая в проекте DataBrew.
  • LATEST_PUBLISHED — самая последняя опубликованная версия.

NextToken -> (строка)

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

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

Spec-Zone.ru

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