CreateClassificationJobRequest

import type { CreateClassificationJobRequest } from "https://aws-api.deno.dev/v0.4/services/macie2.ts?docs=full";

interface CreateClassificationJobRequest {

allowListIds?: string[] | null;

clientToken: string;

customDataIdentifierIds?: string[] | null;

description?: string | null;

initialRun?: boolean | null;

jobType: JobType;

managedDataIdentifierIds?: string[] | null;

managedDataIdentifierSelector?: ManagedDataIdentifierSelector | null;

name: string;

s3JobDefinition: S3JobDefinition;

samplingPercentage?: number | null;

scheduleFrequency?: JobScheduleFrequency | null;

tags?: {

[key: string]: string | null | undefined;

} | null;

}

§Properties

allowListIds?: string[] | null

[src]

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

clientToken: string

[src]

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

customDataIdentifierIds?: string[] | null

[src]

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.

description?: string | null

[src]

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

initialRun?: boolean | null

[src]

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.

jobType: JobType

[src]

The schedule for running the job. Valid values are:

ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.
SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to define the recurrence pattern for the job.

managedDataIdentifierIds?: string[] | null

[src]

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.

managedDataIdentifierSelector?: ManagedDataIdentifierSelector | null

[src]

The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:

ALL - Use all the managed data identifiers that Amazon Macie provides. If you specify this value, don't specify any values for the managedDataIdentifierIds property.
EXCLUDE - Use all the managed data identifiers that Macie provides except the managed data identifiers specified by the managedDataIdentifierIds property.
INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.
NONE - Don't use any managed data identifiers. If you specify this value, specify at least one custom data identifier for the job (customDataIdentifierIds) and don't specify any values for the managedDataIdentifierIds property.

If you don't specify a value for this property, the job uses all managed data identifiers. If you don't specify a value for this property or you specify ALL or EXCLUDE for a recurring job, the job also uses new managed data identifiers as they are released.

name: string

[src]

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

s3JobDefinition: S3JobDefinition

[src]

The S3 buckets that contain the objects to analyze, and the scope of that analysis.

samplingPercentage?: number | null

[src]

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.

scheduleFrequency?: JobScheduleFrequency | null

[src]

The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value for the jobType property to ONE_TIME.

tags?: {

[key: string]: string | null | undefined;

} | null

[src]

A map of key-value pairs that specifies the tags to associate with the job.

A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.