Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1479429429.3 KB

Creates and defines the settings for a classification job.

post/jobs

Request body

allowListIdsString[]

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

clientTokenstring required

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

customDataIdentifierIdsString[]

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.

descriptionstring

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

initialRunboolean
<p>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.</p> <p>If you configure the job to run only once, don't specify a value for this property.</p>
jobType'ONE_TIME' | 'SCHEDULED' required

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

managedDataIdentifierIdsString[]
<p>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).</p> <p>To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.</p>
managedDataIdentifierSelector'ALL' | 'EXCLUDE' | 'INCLUDE' | 'NONE'

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

namestring required

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

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.

tagsobject

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

Response

Success

jobArnstring

The Amazon Resource Name (ARN) of the job.

jobIdstring

The unique identifier for the job.