PUT

/profileJobs/{name}

http://databrew.{region}.amazonaws.com/profileJobs/{name}

Modifies the definition of an existing profile job.

Access Token Required: API Key

Path Parameters

namestringrequired

The name of the job to be updated.

Body Params

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

JobSampleobject

A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a <code>JobSample</code> value isn't provided, the default is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.

MaxRetriesinteger

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

MaxCapacityinteger

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

Configurationobject

Configuration for profile jobs. Configuration can be used to select columns, do evaluations, and override default parameters of evaluations. When configuration is undefined, the profile job will apply default settings to all supported columns.

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>

OutputLocationobjectrequired

Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.

LogSubscriptionstring

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

EncryptionKeyArnstring

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

ValidationConfigurationsarray

List of validation configurations that are applied to the profile 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 PUT \
2     --url 'http://databrew.{region}.amazonaws.com/profileJobs/{name}' \
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}

PUT