[ aws . databrew ]

describe-job

Description

Returns the definition of a specific DataBrew job.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-job
--name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the job to be described.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

CreateDate -> (timestamp)

The date and time that the job was created.

CreatedBy -> (string)

The identifier (user name) of the user associated with the creation of the job.

DatasetName -> (string)

The dataset that the job acts upon.

EncryptionKeyArn -> (string)

The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.

EncryptionMode -> (string)

The encryption mode for the job, which can be one of the following:

• SSE-KMS - Server-side encryption with keys managed by AWS KMS.

• SSE-S3 - Server-side encryption with keys managed by Amazon S3.

Name -> (string)

The name of the job.

Type -> (string)

The job type, which must be one of the following:

• PROFILE - The job analyzes the dataset to determine its size, data types, data distribution, and more.

• RECIPE - The job applies one or more transformations to a dataset.

LastModifiedBy -> (string)

The identifier (user name) of the user who last modified the job.

LastModifiedDate -> (timestamp)

The date and time that the job was last modified.

LogSubscription -> (string)

Indicates whether Amazon CloudWatch logging is enabled for this job.

MaxCapacity -> (integer)

The maximum number of compute nodes that DataBrew can consume when the job processes data.

MaxRetries -> (integer)

The maximum number of times to retry the job after a job run fails.

Outputs -> (list)

One or more artifacts that represent the output from running the job.

(structure)

Parameters that specify how and where DataBrew will write the output generated by recipe jobs or profile jobs.

CompressionFormat -> (string)

The compression algorithm used to compress the output text of the job.

Format -> (string)

The data format of the output of the job.

PartitionColumns -> (list)

The names of one or more partition columns for the output of the job.

(string)

Location -> (structure)

The location in Amazon S3 where the job writes its output.

Bucket -> (string)

The S3 bucket name.

Key -> (string)

The unique name of the object in the bucket.

Overwrite -> (boolean)

A value that, if true, means that any data in the location specified for output is overwritten with new output.

FormatOptions -> (structure)

Options that define how DataBrew formats job output files.

Csv -> (structure)

Options that define how DataBrew writes Csv output.

Delimiter -> (string)

A single character that specifies the delimiter used to create Csv job output.

ProjectName -> (string)

The DataBrew project associated with this job.

RecipeReference -> (structure)

Represents the name and version of a DataBrew recipe.

Name -> (string)

The name of the recipe.

RecipeVersion -> (string)

The identifier for the version for the recipe.

ResourceArn -> (string)

The Amazon Resource Name (ARN) of the job.

RoleArn -> (string)

The ARN of the AWS Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

Tags -> (map)

Metadata tags associated with this job.

key -> (string)

value -> (string)

Timeout -> (integer)

The job’s timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT .

JobSample -> (structure)

Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed.

Mode -> (string)

Determines whether the profile job will be executed on the entire dataset or on a specified number of rows. Must be one of the following:

• FULL_DATASET: Profile job will be executed on the entire dataset.

• CUSTOM_ROWS: Profile job will be executed on the number of rows specified in the Size parameter.

Size -> (long)

Size parameter is only required when the mode is CUSTOM_ROWS. Profile job will be executed on the the specified number of rows. The maximum value for size is Long.MAX_VALUE.

Long.MAX_VALUE = 9223372036854775807