Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListJobRuns

Lists all of the previous runs of a particular DataBrew job.

Request Syntax


GET /jobs/name/jobRuns?maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum number of results to return in this request.

Valid Range: Minimum value of 1. Maximum value of 100.

name

The name of the job.

Length Constraints: Minimum length of 1. Maximum length of 240.

Required: Yes

NextToken

The token returned by a previous call to retrieve the next set of results.

Length Constraints: Minimum length of 1. Maximum length of 2000.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "JobRuns": [ 
      { 
         "Attempt": number,
         "CompletedOn": number,
         "DatabaseOutputs": [ 
            { 
               "DatabaseOptions": { 
                  "TableName": "string",
                  "TempDirectory": { 
                     "Bucket": "string",
                     "BucketOwner": "string",
                     "Key": "string"
                  }
               },
               "DatabaseOutputMode": "string",
               "GlueConnectionName": "string"
            }
         ],
         "DataCatalogOutputs": [ 
            { 
               "CatalogId": "string",
               "DatabaseName": "string",
               "DatabaseOptions": { 
                  "TableName": "string",
                  "TempDirectory": { 
                     "Bucket": "string",
                     "BucketOwner": "string",
                     "Key": "string"
                  }
               },
               "Overwrite": boolean,
               "S3Options": { 
                  "Location": { 
                     "Bucket": "string",
                     "BucketOwner": "string",
                     "Key": "string"
                  }
               },
               "TableName": "string"
            }
         ],
         "DatasetName": "string",
         "ErrorMessage": "string",
         "ExecutionTime": number,
         "JobName": "string",
         "JobSample": { 
            "Mode": "string",
            "Size": number
         },
         "LogGroupName": "string",
         "LogSubscription": "string",
         "Outputs": [ 
            { 
               "CompressionFormat": "string",
               "Format": "string",
               "FormatOptions": { 
                  "Csv": { 
                     "Delimiter": "string"
                  }
               },
               "Location": { 
                  "Bucket": "string",
                  "BucketOwner": "string",
                  "Key": "string"
               },
               "MaxOutputFiles": number,
               "Overwrite": boolean,
               "PartitionColumns": [ "string" ]
            }
         ],
         "RecipeReference": { 
            "Name": "string",
            "RecipeVersion": "string"
         },
         "RunId": "string",
         "StartedBy": "string",
         "StartedOn": number,
         "State": "string",
         "ValidationConfigurations": [ 
            { 
               "RulesetArn": "string",
               "ValidationMode": "string"
            }
         ]
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

JobRuns

A list of job runs that have occurred for the specified job.

Type: Array of JobRun objects

NextToken

A token that you can use in a subsequent call to retrieve the next set of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2000.

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ValidationException

The input parameters for this request failed validation.

HTTP Status Code: 400