describe-job-run¶
Description¶
Represents one run of a DataBrew job.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
describe-job-run
--name <value>
--run-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--name (string)
The name of the job being processed during this run.
--run-id (string)
The unique identifier of the job run.
--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¶
Attempt -> (integer)
The number of times that DataBrew has attempted to run the job.
CompletedOn -> (timestamp)
The date and time when the job completed processing.
DatasetName -> (string)
The name of the dataset for the job to process.
ErrorMessage -> (string)
A message indicating an error (if any) that was encountered when the job ran.
ExecutionTime -> (integer)
The amount of time, in seconds, during which the job run consumed resources.
JobName -> (string)
The name of the job being processed during this run.
RunId -> (string)
The unique identifier of the job run.
State -> (string)
The current state of the job run entity itself.
LogSubscription -> (string)
The current status of Amazon CloudWatch logging for the job run.
LogGroupName -> (string)
The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs.
Outputs -> (list)
One or more output artifacts from a job run.
(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.
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.
StartedBy -> (string)
The Amazon Resource Name (ARN) of the user who started the job run.
StartedOn -> (timestamp)
The date and time when the job run began.
JobSample -> (structure)
Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.
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