POST

/recipeJobs

http://databrew.{region}.amazonaws.com/recipeJobs

Creates a new job to transform input data, using steps defined in an existing Glue DataBrew recipe

Access Token Required: API Key

Body Params

Namestringrequired

A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

Tagsobject

Metadata tags to apply to this job.

Outputsarray

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

RoleArnstringrequired

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

Timeoutinteger

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

MaxRetriesinteger

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

DatasetNamestring

The name of the dataset that this job processes.

MaxCapacityinteger

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

ProjectNamestring

Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.

EncryptionModestring

The encryption mode for the job, which can be one of the following: <ul> <li> <code>SSE-KMS</code> - Server-side encryption with keys managed by KMS. </li> <li> <code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3. </li> </ul>

DatabaseOutputsarray

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

LogSubscriptionstring

Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.

RecipeReferenceobject

Represents the name and version of a DataBrew recipe.

EncryptionKeyArnstring

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

DataCatalogOutputsarray

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

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://databrew.{region}.amazonaws.com/recipeJobs' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}