POST

/jobs

http://macie2.{region}.amazonaws.com/jobs

Creates and defines the settings for a classification job.

Access Token Required: API Key

Body Params

namestringrequired

A custom name for the job. The name can contain as many as 500 characters.

tagsobject

A string-to-string map of key-value pairs that specifies the tags (keys and values) for an Amazon Macie resource.

jobTypestringrequired

The schedule for running a classification job. Valid values are:

initialRunboolean

For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is created (true). To analyze only those objects that are created or changed after you create the job and before the job's first scheduled run, set this value to false. If you configure the job to run only once, don't specify a value for this property.

clientTokenstringrequired

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

descriptionstring

A custom description of the job. The description can contain as many as 200 characters.

allowListIdsarray

An array of unique identifiers, one for each allow list for the job to use when it analyzes data.

s3JobDefinitionobjectrequired

Specifies which S3 buckets contain the objects that a classification job analyzes, and the scope of that analysis. The bucket specification can be static (bucketDefinitions) or dynamic (bucketCriteria). If it's static, the job analyzes objects in the same predefined set of buckets each time the job runs. If it's dynamic, the job analyzes objects in any buckets that match the specified criteria each time the job starts to run.

scheduleFrequencyobject

Specifies the recurrence pattern for running a classification job.

samplingPercentageinteger

The sampling depth, as a percentage, for the job to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.

customDataIdentifierIdsarray

An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data. To use only managed data identifiers, don't specify a value for this property and specify a value other than NONE for the managedDataIdentifierSelector property.

managedDataIdentifierIdsarray

An array of unique identifiers, one for each managed data identifier for the job to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type that you specify for the job (managedDataIdentifierSelector). To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.

managedDataIdentifierSelectorstring

The selection type that determines which managed data identifiers a classification job uses to analyze data. Valid values are:

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://macie2.{region}.amazonaws.com/jobs' \
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}