describe-job
Описание
Возвращает определение конкретной задачи DataBrew.
См. также: Документацию API AWS
Синтаксис
describe-job
--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
- text
- таблица
- 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.
Вывод
CreateDate -> (метка времени)
CreatedBy -> (строка)
DatasetName -> (строка)
EncryptionKeyArn -> (строка)
EncryptionMode -> (строка)
Режим шифрования для задачи, который может быть одним из следующих:
-
SSE-KMS- Шифрование на стороне сервера с ключами, управляемыми KMS. -
SSE-S3- Шифрование на стороне сервера с ключами, управляемыми Amazon S3.
Name -> (строка)
Type -> (строка)
Тип задачи, который должен быть одним из следующих:
-
PROFILE- Задача анализирует набор данных, чтобы определить его размер, типы данных, распределение данных и многое другое. -
RECIPE- Задача применяет один или несколько преобразований к набору данных.
LastModifiedBy -> (строка)
LastModifiedDate -> (метка времени)
LogSubscription -> (строка)
MaxCapacity -> (целое число)
MaxRetries -> (целое число)
Outputs -> (список)
Один или несколько артефактов, представляющих выходные данные от запуска задачи.
(структура)
Представляет параметры, определяющие, как и куда DataBrew в Amazon S3 записывает выходные данные, созданные задачами рецептов или профилей.
CompressionFormat -> (строка)
Format -> (строка)
PartitionColumns -> (список)
Имена одного или нескольких столбцов разбиения для выходных данных задачи.
(строка)
Location -> (структура)
Расположение в Amazon S3, куда задача записывает свои выходные данные.
Bucket -> (строка)
Key -> (строка)
BucketOwner -> (строка)
Overwrite -> (булево)
FormatOptions -> (структура)
Представляет параметры, определяющие, как DataBrew форматирует выходные файлы задач.
Csv -> (структура)
Представляет набор параметров, определяющих структуру выходных данных задачи в формате CSV.
Delimiter -> (строка)
MaxOutputFiles -> (целое число)
DataCatalogOutputs -> (список)
Один или несколько артефактов, представляющих выходные данные Glue Data Catalog от запуска задачи.
(структура)
Представляет параметры, определяющие, как и куда DataBrew записывает выходные данные задачи рецептов в Glue Data Catalog.
CatalogId -> (строка)
DatabaseName -> (строка)
TableName -> (строка)
S3Options -> (структура)
Представляет параметры, определяющие, как и куда DataBrew записывает выходные данные Amazon S3, сгенерированные задачами рецептов.
Location -> (структура)
Представляет расположение Amazon S3 (имя ведра и имя ключа объекта), куда DataBrew может записать выходные данные задачи.
Bucket -> (строка)
Key -> (строка)
BucketOwner -> (строка)
DatabaseOptions -> (структура)
Представляет параметры, определяющие, как и куда DataBrew записывает выходные данные базы данных, созданные задачами рецептов.
TempDirectory -> (структура)
Представляет расположение Amazon S3 (имя ведра и имя ключа объекта), где DataBrew может хранить промежуточные результаты.
Bucket -> (строка)
Key -> (строка)
BucketOwner -> (строка)
TableName -> (строка)
Overwrite -> (булево)
DatabaseOutputs -> (список)
Представляет список объектов вывода JDBC базы данных, определяющий место назначения вывода для задачи DataBrew рецепта для записи.
(структура)
Представляет объект вывода JDBC базы данных, определяющий место назначения вывода для задачи DataBrew рецепта для записи.
GlueConnectionName -> (строка)
DatabaseOptions -> (структура)
Представляет параметры, определяющие, как и куда DataBrew записывает выходные данные базы данных, созданные задачами рецептов.
TempDirectory -> (структура)
Представляет расположение Amazon S3 (имя ведра и имя ключа объекта), где DataBrew может хранить промежуточные результаты.
Bucket -> (строка)
Key -> (строка)
BucketOwner -> (строка)
TableName -> (строка)
DatabaseOutputMode -> (строка)
ProjectName -> (строка)
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
- 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 -> (строка)
ValidationMode -> (строка)
RecipeReference -> (структура)
Представляет имя и версию рецепта DataBrew.
Name -> (строка)
RecipeVersion -> (строка)
ResourceArn -> (строка)
RoleArn -> (строка)
Tags -> (карта)
Метаданные теги, связанные с этой задачей.
ключ -> (строка)
значение -> (строка)
Timeout -> (целое число)
TIMEOUT.JobSample -> (структура)
Конфигурация выборки только для задач профилирования. Определяет количество строк, на которых будет выполнена задача профилирования.
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.