Spec-Zone.ru › AWS CLI v2

[ aws . databrew ]

list-jobs

Описание

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

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

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

Синтаксис

  list-jobs
[--dataset-name <value>]
[--project-name <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]

Параметры

--dataset-name (строка)

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

--project-name (строка)

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

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

Выходные данные

Задачи -> (список)

Список определённых задач.

(структура)

Представляет все атрибуты задачи DataBrew.

AccountId -> (строка)

Идентификатор учётной записи Amazon Web Services, владеющей задачей.

CreatedBy -> (строка)

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

CreateDate -> (временная метка)

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

DatasetName -> (строка)

Набор данных, который должна обработать задача.

EncryptionKeyArn -> (строка)

Amazon Resource Name (ARN) ключа шифрования, используемого для защиты выходных данных задачи. Для получения дополнительной информации см. Шифрование данных, записываемых задачами DataBrew.

EncryptionMode -> (строка)

Режим шифрования для задачи, который может быть одним из следующих:

  • SSE-KMS - Шифрование на стороне сервера с ключами, управляемыми KMS.
  • SSE-S3 - Шифрование на стороне сервера с ключами, управляемыми Amazon S3.

Name -> (строка)

Уникальное имя задачи.

Type -> (строка)

Тип задачи, который должен быть одним из следующих:

  • PROFILE - Задача анализа набора данных для определения его размера, типов данных, распределения данных и т. д.
  • RECIPE - Задача применения одного или нескольких преобразований к набору данных.

LastModifiedBy -> (строка)

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

LastModifiedDate -> (временная метка)

Дата и время изменения задачи.

LogSubscription -> (строка)

Текущий статус ведения журналов Amazon CloudWatch для задачи.

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

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

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

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

Outputs -> (список)

Один или несколько артефактов, представляющих выходные данные после выполнения задачи.

(структура)

Представляет параметры, определяющие, как и где DataBrew в Amazon S3 записывает выходные данные, сгенерированные задачами рецептов или профилей.

CompressionFormat -> (строка)

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

Format -> (строка)

Формат данных выходных данных задачи.

PartitionColumns -> (список)

Имена одного или нескольких столбцов разбиения для выходных данных задачи.

(строка)

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

Местоположение в Amazon S3, куда задача записывает свои выходные данные.

Bucket -> (строка)

Имя ведра Amazon S3.

Key -> (строка)

Уникальное имя объекта в ведре.

BucketOwner -> (строка)

Идентификатор учётной записи Amazon Web Services владельца ведра.

Overwrite -> (логическое значение)

Значение, которое, если истинно, означает, что любые данные в указанном для вывода местоположении перезаписываются новыми выходными данными.

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

Представляет параметры, определяющие, как DataBrew форматирует выходные файлы задач.

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

Представляет набор параметров, определяющих структуру выходных данных задачи в формате CSV.

Delimiter -> (строка)

Один символ, определяющий разделитель, используемый для создания выходных данных задачи в формате CSV.

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

Максимальное количество файлов, генерируемых задачей и записываемых в папку вывода. Для вывода, разграниченного столбцом(ами), значение MaxOutputFiles является максимальным числом файлов на раздел.

DataCatalogOutputs -> (список)

Один или несколько артефактов, представляющих выходные данные каталога данных Glue после выполнения задачи.

(структура)

Представляет параметры, определяющие, как и куда в Glue Data Catalog DataBrew записывает выходные данные, сгенерированные задачами рецептов.

CatalogId -> (строка)

Уникальный идентификатор учётной записи Amazon Web Services, которая владеет каталогом данных, хранящим данные.

DatabaseName -> (строка)

Имя базы данных в каталоге данных.

TableName -> (строка)

Имя таблицы в каталоге данных.

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

Представляет параметры, определяющие, как и куда DataBrew записывает выходные данные Amazon S3, сгенерированные задачами рецептов.

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

Представляет местоположение в Amazon S3 (имя ведра и ключ объекта), куда DataBrew может записывать выходные данные задачи.

Bucket -> (строка)

Имя ведра Amazon S3.

Key -> (строка)

Уникальное имя объекта в ведре.

BucketOwner -> (строка)

Идентификатор учётной записи Amazon Web Services владельца ведра.

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

Представляет параметры, определяющие, как и куда DataBrew записывает выходные данные базы данных, сгенерированные задачами рецептов.

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

Представляет местоположение в Amazon S3 (имя ведра и ключ объекта), где DataBrew может хранить промежуточные результаты.

Bucket -> (строка)

Имя ведра Amazon S3.

Key -> (строка)

Уникальное имя объекта в ведре.

BucketOwner -> (строка)

Идентификатор учётной записи Amazon Web Services владельца ведра.

TableName -> (строка)

Префикс имени таблицы, которую DataBrew создаст в базе данных.

Overwrite -> (логическое значение)

Значение, которое, если истинно, означает, что любые данные в указанном для вывода местоположении перезаписываются новыми выходными данными. Не поддерживается с DatabaseOptions.

DatabaseOutputs -> (список)

Представляет список объектов вывода JDBC-базы данных, которые определяют место назначения вывода для задачи DataBrew рецепта для записи.

(структура)

Представляет объект вывода JDBC-базы данных, который определяет место назначения вывода для задачи DataBrew рецепта для записи.

GlueConnectionName -> (строка)

Подключение Glue, хранящее информацию о подключении к целевой базе данных.

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

Представляет параметры, определяющие, как и куда DataBrew записывает выходные данные базы данных, сгенерированные задачами рецептов.

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

Представляет местоположение в Amazon S3 (имя ведра и ключ объекта), где DataBrew может хранить промежуточные результаты.

Bucket -> (строка)

Имя ведра Amazon S3.

Key -> (строка)

Уникальное имя объекта в ведре.

BucketOwner -> (строка)

Идентификатор учётной записи Amazon Web Services владельца ведра.

TableName -> (строка)

Префикс имени таблицы, которую DataBrew создаст в базе данных.

DatabaseOutputMode -> (строка)

Режим вывода для записи в базу данных. В настоящее время поддерживается опция: NEW_TABLE.

ProjectName -> (строка)

Имя проекта, с которым связана задача.

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

Набор шагов, которые выполняет задача.

Name -> (строка)

Имя рецепта.

RecipeVersion -> (строка)

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

ResourceArn -> (строка)

Уникальный Amazon Resource Name (ARN) задачи.

RoleArn -> (строка)

Amazon Resource Name (ARN) роли, которая должна быть принята для этой задачи.

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

Таймаут задачи в минутах. Задача, которая пытается работать дольше этого таймаута, завершается со статусом TIMEOUT .

Tags -> (карта)

Теги метаданных, которые были применены к задаче.

key -> (строка)

value -> (строка)

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

Настройка образца только для задач профилирования, которая определяет количество строк, на которых выполняется задача профилирования. Если значение JobSample не указано, используется значение по умолчанию. Значение по умолчанию — CUSTOM_ROWS для параметра mode и 20 000 для параметра size.

Mode -> (строка)

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

  • FULL_DATASET — Задача профилирования выполняется на всём наборе данных.
  • CUSTOM_ROWS — Задача профилирования выполняется на количестве строк, указанном в параметре Size.

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

Параметр Size требуется только в случае, если mode равен CUSTOM_ROWS. Задача профилирования выполняется на указанном количестве строк. Максимальное значение для size равно Long.MAX_VALUE.

Long.MAX_VALUE = 9223372036854775807

ValidationConfigurations -> (список)

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

(структура)

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

RulesetArn -> (строка)

Amazon Resource Name (ARN) для набора правил, который должен проверяться в задаче профилирования. TargetArn выбранного набора правил должен совпадать с Amazon Resource Name (ARN) набора данных, который связан с задачей профилирования.

ValidationMode -> (строка)

Режим проверки качества данных. По умолчанию режим «CHECK_ALL», который проверяет все правила, определённые в выбранном наборе правил.

NextToken -> (строка)

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

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

Spec-Zone.ru

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