ListJobsCommand

Suggest an Edit

Lists all of the DataBrew jobs that are defined.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataBrewClient, ListJobsCommand } from "@aws-sdk/client-databrew"; // ES Modules import
// const { DataBrewClient, ListJobsCommand } = require("@aws-sdk/client-databrew"); // CommonJS import
const client = new DataBrewClient(config);
const input = { // ListJobsRequest
  DatasetName: "STRING_VALUE",
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
  ProjectName: "STRING_VALUE",
};
const command = new ListJobsCommand(input);
const response = await client.send(command);
// { // ListJobsResponse
//   Jobs: [ // JobList // required
//     { // Job
//       AccountId: "STRING_VALUE",
//       CreatedBy: "STRING_VALUE",
//       CreateDate: new Date("TIMESTAMP"),
//       DatasetName: "STRING_VALUE",
//       EncryptionKeyArn: "STRING_VALUE",
//       EncryptionMode: "SSE-KMS" || "SSE-S3",
//       Name: "STRING_VALUE", // required
//       Type: "PROFILE" || "RECIPE",
//       LastModifiedBy: "STRING_VALUE",
//       LastModifiedDate: new Date("TIMESTAMP"),
//       LogSubscription: "ENABLE" || "DISABLE",
//       MaxCapacity: Number("int"),
//       MaxRetries: Number("int"),
//       Outputs: [ // OutputList
//         { // Output
//           CompressionFormat: "GZIP" || "LZ4" || "SNAPPY" || "BZIP2" || "DEFLATE" || "LZO" || "BROTLI" || "ZSTD" || "ZLIB",
//           Format: "CSV" || "JSON" || "PARQUET" || "GLUEPARQUET" || "AVRO" || "ORC" || "XML" || "TABLEAUHYPER",
//           PartitionColumns: [ // ColumnNameList
//             "STRING_VALUE",
//           ],
//           Location: { // S3Location
//             Bucket: "STRING_VALUE", // required
//             Key: "STRING_VALUE",
//             BucketOwner: "STRING_VALUE",
//           },
//           Overwrite: true || false,
//           FormatOptions: { // OutputFormatOptions
//             Csv: { // CsvOutputOptions
//               Delimiter: "STRING_VALUE",
//             },
//           },
//           MaxOutputFiles: Number("int"),
//         },
//       ],
//       DataCatalogOutputs: [ // DataCatalogOutputList
//         { // DataCatalogOutput
//           CatalogId: "STRING_VALUE",
//           DatabaseName: "STRING_VALUE", // required
//           TableName: "STRING_VALUE", // required
//           S3Options: { // S3TableOutputOptions
//             Location: {
//               Bucket: "STRING_VALUE", // required
//               Key: "STRING_VALUE",
//               BucketOwner: "STRING_VALUE",
//             },
//           },
//           DatabaseOptions: { // DatabaseTableOutputOptions
//             TempDirectory: {
//               Bucket: "STRING_VALUE", // required
//               Key: "STRING_VALUE",
//               BucketOwner: "STRING_VALUE",
//             },
//             TableName: "STRING_VALUE", // required
//           },
//           Overwrite: true || false,
//         },
//       ],
//       DatabaseOutputs: [ // DatabaseOutputList
//         { // DatabaseOutput
//           GlueConnectionName: "STRING_VALUE", // required
//           DatabaseOptions: {
//             TempDirectory: {
//               Bucket: "STRING_VALUE", // required
//               Key: "STRING_VALUE",
//               BucketOwner: "STRING_VALUE",
//             },
//             TableName: "STRING_VALUE", // required
//           },
//           DatabaseOutputMode: "NEW_TABLE",
//         },
//       ],
//       ProjectName: "STRING_VALUE",
//       RecipeReference: { // RecipeReference
//         Name: "STRING_VALUE", // required
//         RecipeVersion: "STRING_VALUE",
//       },
//       ResourceArn: "STRING_VALUE",
//       RoleArn: "STRING_VALUE",
//       Timeout: Number("int"),
//       Tags: { // TagMap
//         "<keys>": "STRING_VALUE",
//       },
//       JobSample: { // JobSample
//         Mode: "FULL_DATASET" || "CUSTOM_ROWS",
//         Size: Number("long"),
//       },
//       ValidationConfigurations: [ // ValidationConfigurationList
//         { // ValidationConfiguration
//           RulesetArn: "STRING_VALUE", // required
//           ValidationMode: "CHECK_ALL",
//         },
//       ],
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListJobsCommand Input

See ListJobsCommandInput for more details

Parameter
Type
Description
DatasetName
string | undefined

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

MaxResults
number | undefined

The maximum number of results to return in this request.

NextToken
string | undefined

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.

ProjectName
string | undefined

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

ListJobsCommand Output

See ListJobsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Jobs
Required
Job[] | undefined

A list of jobs that are defined.

NextToken
string | undefined

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

Throws

Name
Fault
Details
ValidationException
client

The input parameters for this request failed validation.

DataBrewServiceException
Base exception class for all service exceptions from DataBrew service.