AWS Glue DataBrew

Represents one run of a DataBrew job.

See also: AWS API Documentation

Request Syntax

client.describe_job_run(
    Name='string',
    RunId='string'
)

type Name:

string

param Name:

[REQUIRED]

The name of the job being processed during this run.

type RunId:

string

param RunId:

[REQUIRED]

The unique identifier of the job run.

rtype:

dict

returns:

Response Syntax

{
    'Attempt': 123,
    'CompletedOn': datetime(2015, 1, 1),
    'DatasetName': 'string',
    'ErrorMessage': 'string',
    'ExecutionTime': 123,
    'JobName': 'string',
    'RunId': 'string',
    'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT',
    'LogSubscription': 'ENABLE'|'DISABLE',
    'LogGroupName': 'string',
    'Outputs': [
        {
            'CompressionFormat': 'GZIP'|'LZ4'|'SNAPPY'|'BZIP2'|'DEFLATE'|'LZO'|'BROTLI'|'ZSTD'|'ZLIB',
            'Format': 'CSV'|'JSON'|'PARQUET'|'GLUEPARQUET'|'AVRO'|'ORC'|'XML',
            'PartitionColumns': [
                'string',
            ],
            'Location': {
                'Bucket': 'string',
                'Key': 'string'
            },
            'Overwrite': True|False,
            'FormatOptions': {
                'Csv': {
                    'Delimiter': 'string'
                }
            }
        },
    ],
    'RecipeReference': {
        'Name': 'string',
        'RecipeVersion': 'string'
    },
    'StartedBy': 'string',
    'StartedOn': datetime(2015, 1, 1)
}

Response Structure

• (dict) --

  • Attempt (integer) --

    The number of times that DataBrew has attempted to run the job.

  • CompletedOn (datetime) --

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

    • (dict) --

      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 (dict) --

        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 (dict) --

        Options that define how DataBrew formats job output files.

        • Csv (dict) --

          Options that define how DataBrew writes Csv output.

          • Delimiter (string) --

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

  • RecipeReference (dict) --

    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 initiated the job run.

  • StartedOn (datetime) --

    The date and time when the job run began.