# DescribeJob
<a name="API_DescribeJob"></a>

Returns the definition of a specific DataBrew job.

## Request Syntax
<a name="API_DescribeJob_RequestSyntax"></a>

```
GET /jobs/name HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [name](#API_DescribeJob_RequestSyntax) **   <a name="databrew-DescribeJob-request-uri-Name"></a>
The name of the job to be described.  
Length Constraints: Minimum length of 1. Maximum length of 240.  
Required: Yes

## Request Body
<a name="API_DescribeJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "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" ]
      }
   ],
   "ProfileConfiguration": { 
      "ColumnStatisticsConfigurations": [ 
         { 
            "Selectors": [ 
               { 
                  "Name": "string",
                  "Regex": "string"
               }
            ],
            "Statistics": { 
               "IncludedStatistics": [ "string" ],
               "Overrides": [ 
                  { 
                     "Parameters": { 
                        "string" : "string" 
                     },
                     "Statistic": "string"
                  }
               ]
            }
         }
      ],
      "DatasetStatisticsConfiguration": { 
         "IncludedStatistics": [ "string" ],
         "Overrides": [ 
            { 
               "Parameters": { 
                  "string" : "string" 
               },
               "Statistic": "string"
            }
         ]
      },
      "EntityDetectorConfiguration": { 
         "AllowedStatistics": [ 
            { 
               "Statistics": [ "string" ]
            }
         ],
         "EntityTypes": [ "string" ]
      },
      "ProfileColumns": [ 
         { 
            "Name": "string",
            "Regex": "string"
         }
      ]
   },
   "ProjectName": "string",
   "RecipeReference": { 
      "Name": "string",
      "RecipeVersion": "string"
   },
   "ResourceArn": "string",
   "RoleArn": "string",
   "Tags": { 
      "string" : "string" 
   },
   "Timeout": number,
   "Type": "string",
   "ValidationConfigurations": [ 
      { 
         "RulesetArn": "string",
         "ValidationMode": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeJob_ResponseElements"></a>

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

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

 ** [Name](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-Name"></a>
The name of the job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 240.

 ** [CreateDate](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-CreateDate"></a>
The date and time that the job was created.  
Type: Timestamp

 ** [CreatedBy](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-CreatedBy"></a>
The identifier (user name) of the user associated with the creation of the job.  
Type: String

 ** [DatabaseOutputs](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-DatabaseOutputs"></a>
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.  
Type: Array of [DatabaseOutput](API_DatabaseOutput.md) objects  
Array Members: Minimum number of 1 item.

 ** [DataCatalogOutputs](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-DataCatalogOutputs"></a>
One or more artifacts that represent the AWS Glue Data Catalog output from running the job.  
Type: Array of [DataCatalogOutput](API_DataCatalogOutput.md) objects  
Array Members: Minimum number of 1 item.

 ** [DatasetName](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-DatasetName"></a>
The dataset that the job acts upon.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [EncryptionKeyArn](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-EncryptionKeyArn"></a>
The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.

 ** [EncryptionMode](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-EncryptionMode"></a>
The encryption mode for the job, which can be one of the following:  
+  `SSE-KMS` - Server-side encryption with keys managed by AWS KMS.
+  `SSE-S3` - Server-side encryption with keys managed by Amazon S3.
Type: String  
Valid Values: `SSE-KMS | SSE-S3` 

 ** [JobSample](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-JobSample"></a>
Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed.  
Type: [JobSample](API_JobSample.md) object

 ** [LastModifiedBy](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-LastModifiedBy"></a>
The identifier (user name) of the user who last modified the job.  
Type: String

 ** [LastModifiedDate](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-LastModifiedDate"></a>
The date and time that the job was last modified.  
Type: Timestamp

 ** [LogSubscription](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-LogSubscription"></a>
Indicates whether Amazon CloudWatch logging is enabled for this job.  
Type: String  
Valid Values: `ENABLE | DISABLE` 

 ** [MaxCapacity](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-MaxCapacity"></a>
The maximum number of compute nodes that DataBrew can consume when the job processes data.  
Type: Integer

 ** [MaxRetries](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-MaxRetries"></a>
The maximum number of times to retry the job after a job run fails.  
Type: Integer  
Valid Range: Minimum value of 0.

 ** [Outputs](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-Outputs"></a>
One or more artifacts that represent the output from running the job.  
Type: Array of [Output](API_Output.md) objects  
Array Members: Minimum number of 1 item.

 ** [ProfileConfiguration](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-ProfileConfiguration"></a>
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.  
Type: [ProfileConfiguration](API_ProfileConfiguration.md) object

 ** [ProjectName](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-ProjectName"></a>
The DataBrew project associated with this job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [RecipeReference](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-RecipeReference"></a>
Represents the name and version of a DataBrew recipe.  
Type: [RecipeReference](API_RecipeReference.md) object

 ** [ResourceArn](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-ResourceArn"></a>
The Amazon Resource Name (ARN) of the job.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.

 ** [RoleArn](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-RoleArn"></a>
The ARN of the AWS Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.

 ** [Tags](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-Tags"></a>
Metadata tags associated with this job.  
Type: String to string map  
Map Entries: Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Maximum length of 256.

 ** [Timeout](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-Timeout"></a>
The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of `TIMEOUT`.  
Type: Integer  
Valid Range: Minimum value of 0.

 ** [Type](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-Type"></a>
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.
Type: String  
Valid Values: `PROFILE | RECIPE` 

 ** [ValidationConfigurations](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-ValidationConfigurations"></a>
List of validation configurations that are applied to the profile job.  
Type: Array of [ValidationConfiguration](API_ValidationConfiguration.md) objects  
Array Members: Minimum number of 1 item.

## Errors
<a name="API_DescribeJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_DescribeJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DescribeJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DescribeJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DescribeJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DescribeJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DescribeJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DescribeJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DescribeJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DescribeJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DescribeJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DescribeJob)