DescribeJobCommand

Suggest an Edit

Returns the definition of a specific DataBrew job.

Example Syntax

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

import { DataBrewClient, DescribeJobCommand } from "@aws-sdk/client-databrew"; // ES Modules import
// const { DataBrewClient, DescribeJobCommand } = require("@aws-sdk/client-databrew"); // CommonJS import
const client = new DataBrewClient(config);
const input = { // DescribeJobRequest
  Name: "STRING_VALUE", // required
};
const command = new DescribeJobCommand(input);
const response = await client.send(command);
// { // DescribeJobResponse
//   CreateDate: new Date("TIMESTAMP"),
//   CreatedBy: "STRING_VALUE",
//   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",
//   ProfileConfiguration: { // ProfileConfiguration
//     DatasetStatisticsConfiguration: { // StatisticsConfiguration
//       IncludedStatistics: [ // StatisticList
//         "STRING_VALUE",
//       ],
//       Overrides: [ // StatisticOverrideList
//         { // StatisticOverride
//           Statistic: "STRING_VALUE", // required
//           Parameters: { // ParameterMap // required
//             "<keys>": "STRING_VALUE",
//           },
//         },
//       ],
//     },
//     ProfileColumns: [ // ColumnSelectorList
//       { // ColumnSelector
//         Regex: "STRING_VALUE",
//         Name: "STRING_VALUE",
//       },
//     ],
//     ColumnStatisticsConfigurations: [ // ColumnStatisticsConfigurationList
//       { // ColumnStatisticsConfiguration
//         Selectors: [
//           {
//             Regex: "STRING_VALUE",
//             Name: "STRING_VALUE",
//           },
//         ],
//         Statistics: {
//           IncludedStatistics: [
//             "STRING_VALUE",
//           ],
//           Overrides: [
//             {
//               Statistic: "STRING_VALUE", // required
//               Parameters: { // required
//                 "<keys>": "STRING_VALUE",
//               },
//             },
//           ],
//         },
//       },
//     ],
//     EntityDetectorConfiguration: { // EntityDetectorConfiguration
//       EntityTypes: [ // EntityTypeList // required
//         "STRING_VALUE",
//       ],
//       AllowedStatistics: [ // AllowedStatisticList
//         { // AllowedStatistics
//           Statistics: [ // required
//             "STRING_VALUE",
//           ],
//         },
//       ],
//     },
//   },
//   ValidationConfigurations: [ // ValidationConfigurationList
//     { // ValidationConfiguration
//       RulesetArn: "STRING_VALUE", // required
//       ValidationMode: "CHECK_ALL",
//     },
//   ],
//   RecipeReference: { // RecipeReference
//     Name: "STRING_VALUE", // required
//     RecipeVersion: "STRING_VALUE",
//   },
//   ResourceArn: "STRING_VALUE",
//   RoleArn: "STRING_VALUE",
//   Tags: { // TagMap
//     "<keys>": "STRING_VALUE",
//   },
//   Timeout: Number("int"),
//   JobSample: { // JobSample
//     Mode: "FULL_DATASET" || "CUSTOM_ROWS",
//     Size: Number("long"),
//   },
// };

DescribeJobCommand Input

See DescribeJobCommandInput for more details

Parameter
Type
Description
Name
Required
string | undefined

The name of the job to be described.

DescribeJobCommand Output

See DescribeJobCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Name
Required
string | undefined

The name of the job.

CreateDate
Date | undefined

The date and time that the job was created.

CreatedBy
string | undefined

The identifier (user name) of the user associated with the creation of the job.

DataCatalogOutputs
DataCatalogOutput[] | undefined

One or more artifacts that represent the Glue Data Catalog output from running the job.

DatabaseOutputs
DatabaseOutput[] | undefined

Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.

DatasetName
string | undefined

The dataset that the job acts upon.

EncryptionKeyArn
string | undefined

The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.

EncryptionMode
EncryptionMode | undefined

The encryption mode for the job, which can be one of the following:

  • SSE-KMS - Server-side encryption with keys managed by KMS.

  • SSE-S3 - Server-side encryption with keys managed by Amazon S3.

JobSample
JobSample | undefined

Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed.

LastModifiedBy
string | undefined

The identifier (user name) of the user who last modified the job.

LastModifiedDate
Date | undefined

The date and time that the job was last modified.

LogSubscription
LogSubscription | undefined

Indicates whether Amazon CloudWatch logging is enabled for this job.

MaxCapacity
number | undefined

The maximum number of compute nodes that DataBrew can consume when the job processes data.

MaxRetries
number | undefined

The maximum number of times to retry the job after a job run fails.

Outputs
Output[] | undefined

One or more artifacts that represent the output from running the job.

ProfileConfiguration
ProfileConfiguration | undefined

Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.

ProjectName
string | undefined

The DataBrew project associated with this job.

RecipeReference
RecipeReference | undefined

Represents the name and version of a DataBrew recipe.

ResourceArn
string | undefined

The Amazon Resource Name (ARN) of the job.

RoleArn
string | undefined

The ARN of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

Tags
Record<string, string> | undefined

Metadata tags associated with this job.

Timeout
number | undefined

The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

Type
JobType | undefined

The job type, which must be one of the following:

  • PROFILE - The job analyzes the dataset to determine its size, data types, data distribution, and more.

  • RECIPE - The job applies one or more transformations to a dataset.

ValidationConfigurations
ValidationConfiguration[] | undefined

List of validation configurations that are applied to the profile job.

Throws

Name
Fault
Details
ResourceNotFoundException
client

One or more resources can't be found.

ValidationException
client

The input parameters for this request failed validation.

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