Spec-Zone.ru › AWS CLI v2

[ aws . databrew ]

describe-job-run

Описание

Представляет одну запуск задачи DataBrew.

См. также: AWS API Documentation

Синтаксис

  describe-job-run
--name <value>
--run-id <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 (строка)

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

--run-id (строка)

Уникальный идентификатор запуска задачи.

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

Вывод

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

Количество попыток выполнения задания DataBrew.

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

Дата и время завершения обработки задания.

DatasetName -> (строка)

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

ErrorMessage -> (строка)

Сообщение об ошибке (если она произошла) при выполнении задания.

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

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

JobName -> (строка)

Имя обрабатываемого задания в ходе этого выполнения.

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

Настройка для заданий профилирования. Используется для выбора столбцов, проведения оценок и переопределения параметров по умолчанию для оценок. Если настройка равна null, задание профилирования будет выполнено с настройками по умолчанию.

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

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

IncludedStatistics -> (список)

Список включенных оценок. Если список не определен, будут включены все поддерживаемые оценки.

(строка)

Overrides -> (список)

Список переопределений для оценок.

(структура)

Переопределение конкретной оценки для задания профилирования.

Statistic -> (строка)

Имя оценки

Parameters -> (карта)

Карта, содержащая переопределения параметров оценки.

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

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

ProfileColumns -> (список)

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

(структура)

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

Regex -> (строка)

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

Name -> (строка)

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

ColumnStatisticsConfigurations -> (список)

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

(структура)

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

Selectors -> (список)

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

(структура)

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

Regex -> (строка)

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

Name -> (строка)

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

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

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

IncludedStatistics -> (список)

Список включенных оценок. Если список не определен, будут включены все поддерживаемые оценки.

(строка)

Overrides -> (список)

Список переопределений для оценок.

(структура)

Переопределение конкретной оценки для задания профилирования.

Statistic -> (строка)

Имя оценки

Parameters -> (карта)

Карта, содержащая переопределения параметров оценки.

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

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

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

Настройка обнаружения сущностей для задания профилирования. Если не определено, обнаружение сущностей отключено.

EntityTypes -> (список)

Типы сущностей для обнаружения. Могут быть любыми из следующих:

  • USA_SSN
  • EMAIL
  • USA_ITIN
  • USA_PASSPORT_NUMBER
  • PHONE_NUMBER
  • USA_DRIVING_LICENSE
  • BANK_ACCOUNT
  • CREDIT_CARD
  • IP_ADDRESS
  • MAC_ADDRESS
  • USA_DEA_NUMBER
  • USA_HCPCS_CODE
  • USA_NATIONAL_PROVIDER_IDENTIFIER
  • USA_NATIONAL_DRUG_CODE
  • USA_HEALTH_INSURANCE_CLAIM_NUMBER
  • USA_MEDICARE_BENEFICIARY_IDENTIFIER
  • USA_CPT_CODE
  • PERSON_NAME
  • DATE

Также поддерживается группа типов сущностей USA_ALL, которая включает все вышеперечисленные типы, кроме PERSON_NAME и DATE.

(строка)

AllowedStatistics -> (список)

Настройка статистических данных, которые разрешено вычислять для столбцов, содержащих обнаруженные сущности. Если не определено, никакие статистические данные не будут вычисляться для столбцов, содержащих обнаруженные сущности.

(структура)

Настройка статистических данных, которые разрешено вычислять для столбцов, содержащих обнаруженные сущности. Если не определено, никакие статистические данные не будут вычисляться для столбцов, содержащих обнаруженные сущности.

Statistics -> (список)

Один или несколько статистических данных столбцов для разрешения столбцов, содержащих обнаруженные сущности.

(строка)

ValidationConfigurations -> (список)

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

(структура)

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

RulesetArn -> (строка)

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

ValidationMode -> (строка)

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

RunId -> (строка)

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

State -> (строка)

Текущее состояние сущности выполнения задания.

LogSubscription -> (строка)

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

LogGroupName -> (строка)

Имя группы журнала Amazon CloudWatch, куда задание записывает диагностические сообщения во время выполнения.

Outputs -> (список)

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

(структура)

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

CompressionFormat -> (строка)

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

Format -> (строка)

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

PartitionColumns -> (список)

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

(строка)

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

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

Bucket -> (строка)

Имя Amazon S3-хранилища.

Key -> (строка)

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

BucketOwner -> (строка)

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

Overwrite -> (булево)

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

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

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

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

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

Delimiter -> (строка)

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

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

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

DataCatalogOutputs -> (список)

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

(структура)

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

CatalogId -> (строка)

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

DatabaseName -> (строка)

Имя базы данных в Data Catalog.

TableName -> (строка)

Имя таблицы в Data Catalog.

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 -> (булево)

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

DatabaseOutputs -> (список)

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

(структура)

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

GlueConnectionName -> (строка)

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

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

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

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

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

Bucket -> (строка)

Имя ведра Amazon S3.

Key -> (строка)

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

BucketOwner -> (строка)

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

TableName -> (строка)

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

DatabaseOutputMode -> (строка)

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

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

Представляет имя и версию рецепта DataBrew.

Name -> (строка)

Имя рецепта.

RecipeVersion -> (строка)

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

StartedBy -> (строка)

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

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

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

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

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

Mode -> (строка)

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

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

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

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

Long.MAX_VALUE = 9223372036854775807

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

Spec-Zone.ru

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