CreateRecipeJob
Creates a new job to transform input data, using steps defined in an existing Amazon Glue DataBrew recipe
Request Syntax
POST /recipeJobs HTTP/1.1
Content-type: application/json
{
"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
",
"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
"
},
"RoleArn": "string
",
"Tags": {
"string
" : "string
"
},
"Timeout": number
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- Name
-
A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 240.
Required: Yes
- RoleArn
-
The Amazon Resource Name (ARN) of the Amazon 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.
Required: Yes
- DatabaseOutputs
-
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write to.
Type: Array of DatabaseOutput objects
Array Members: Minimum number of 1 item.
Required: No
- DataCatalogOutputs
-
One or more artifacts that represent the Amazon Glue Data Catalog output from running the job.
Type: Array of DataCatalogOutput objects
Array Members: Minimum number of 1 item.
Required: No
- DatasetName
-
The name of the dataset that this job processes.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No
- EncryptionKeyArn
-
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.
Required: No
- EncryptionMode
-
The encryption mode for the job, which can be one of the following:
-
SSE-KMS
- Server-side encryption with keys managed by Amazon KMS. -
SSE-S3
- Server-side encryption with keys managed by Amazon S3.
Type: String
Valid Values:
SSE-KMS | SSE-S3
Required: No
-
- LogSubscription
-
Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.
Type: String
Valid Values:
ENABLE | DISABLE
Required: No
- MaxCapacity
-
The maximum number of nodes that DataBrew can consume when the job processes data.
Type: Integer
Required: No
- MaxRetries
-
The maximum number of times to retry the job after a job run fails.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
- Outputs
-
One or more artifacts that represent the output from running the job.
Type: Array of Output objects
Array Members: Minimum number of 1 item.
Required: No
- ProjectName
-
Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No
- RecipeReference
-
Represents the name and version of a DataBrew recipe.
Type: RecipeReference object
Required: No
- Tags
-
Metadata tags to apply to 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.
Required: No
- Timeout
-
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.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Name": "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.
- Name
-
The name of the job that you created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 240.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Access to the specified resource was denied.
HTTP Status Code: 403
- ConflictException
-
Updating or deleting a resource can cause an inconsistent state.
HTTP Status Code: 409
- ResourceNotFoundException
-
One or more resources can't be found.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
A service quota is exceeded.
HTTP Status Code: 402
- ValidationException
-
The input parameters for this request failed validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: