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

ListJobs

Lists all of the DataBrew jobs that are defined.

Request Syntax


GET /jobs?datasetName=DatasetName&maxResults=MaxResults&nextToken=NextToken&projectName=ProjectName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

DatasetName

The name of a dataset. Using this parameter indicates to return only those jobs that act on the specified dataset.

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

MaxResults

The maximum number of results to return in this request.

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

NextToken

A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call.

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

ProjectName

The name of a project. Using this parameter indicates to return only those jobs that are associated with the specified project.

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Jobs": [ 
      { 
         "AccountId": "string",
         "CreateDate": number,
         "CreatedBy": "string",
         "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",
         "EncryptionKeyArn": "string",
         "EncryptionMode": "string",
         "JobSample": { 
            "Mode": "string",
            "Size": number
         },
         "LastModifiedBy": "string",
         "LastModifiedDate": number,
         "LogSubscription": "string",
         "MaxCapacity": number,
         "MaxRetries": number,
         "Name": "string",
         "Outputs": [ 
            { 
               "CompressionFormat": "string",
               "Format": "string",
               "FormatOptions": { 
                  "Csv": { 
                     "Delimiter": "string"
                  }
               },
               "Location": { 
                  "Bucket": "string",
                  "BucketOwner": "string",
                  "Key": "string"
               },
               "MaxOutputFiles": number,
               "Overwrite": boolean,
               "PartitionColumns": [ "string" ]
            }
         ],
         "ProjectName": "string",
         "RecipeReference": { 
            "Name": "string",
            "RecipeVersion": "string"
         },
         "ResourceArn": "string",
         "RoleArn": "string",
         "Tags": { 
            "string" : "string" 
         },
         "Timeout": number,
         "Type": "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.

Jobs

A list of jobs that are defined.

Type: Array of Job 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.

ValidationException

The input parameters for this request failed validation.

HTTP Status Code: 400