Docs Packages
  1. Pulumi Registry
  2. AWS Classic
  3. API Docs
  4. macie2
  5. ClassificationJob
aws logo
AWS Classic v5.41.0, May 15 23

aws.macie2.ClassificationJob

Explore with Pulumi AI

Provides a resource to manage an AWS Macie Classification Job.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var testAccount = new Aws.Macie2.Account("testAccount");

    var testClassificationJob = new Aws.Macie2.ClassificationJob("testClassificationJob", new()
    {
        JobType = "ONE_TIME",
        S3JobDefinition = new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionArgs
        {
            BucketDefinitions = new[]
            {
                new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionBucketDefinitionArgs
                {
                    AccountId = "ACCOUNT ID",
                    Buckets = new[]
                    {
                        "S3 BUCKET NAME",
                    },
                },
            },
        },
    }, new CustomResourceOptions
    {
        DependsOn = new[]
        {
            testAccount,
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/macie2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		testAccount, err := macie2.NewAccount(ctx, "testAccount", nil)
		if err != nil {
			return err
		}
		_, err = macie2.NewClassificationJob(ctx, "testClassificationJob", &macie2.ClassificationJobArgs{
			JobType: pulumi.String("ONE_TIME"),
			S3JobDefinition: &macie2.ClassificationJobS3JobDefinitionArgs{
				BucketDefinitions: macie2.ClassificationJobS3JobDefinitionBucketDefinitionArray{
					&macie2.ClassificationJobS3JobDefinitionBucketDefinitionArgs{
						AccountId: pulumi.String("ACCOUNT ID"),
						Buckets: pulumi.StringArray{
							pulumi.String("S3 BUCKET NAME"),
						},
					},
				},
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			testAccount,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.macie2.Account;
import com.pulumi.aws.macie2.ClassificationJob;
import com.pulumi.aws.macie2.ClassificationJobArgs;
import com.pulumi.aws.macie2.inputs.ClassificationJobS3JobDefinitionArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testAccount = new Account("testAccount");

        var testClassificationJob = new ClassificationJob("testClassificationJob", ClassificationJobArgs.builder()        
            .jobType("ONE_TIME")
            .s3JobDefinition(ClassificationJobS3JobDefinitionArgs.builder()
                .bucketDefinitions(ClassificationJobS3JobDefinitionBucketDefinitionArgs.builder()
                    .accountId("ACCOUNT ID")
                    .buckets("S3 BUCKET NAME")
                    .build())
                .build())
            .build(), CustomResourceOptions.builder()
                .dependsOn(testAccount)
                .build());

    }
}

import pulumi
import pulumi_aws as aws

test_account = aws.macie2.Account("testAccount")
test_classification_job = aws.macie2.ClassificationJob("testClassificationJob",
    job_type="ONE_TIME",
    s3_job_definition=aws.macie2.ClassificationJobS3JobDefinitionArgs(
        bucket_definitions=[aws.macie2.ClassificationJobS3JobDefinitionBucketDefinitionArgs(
            account_id="ACCOUNT ID",
            buckets=["S3 BUCKET NAME"],
        )],
    ),
    opts=pulumi.ResourceOptions(depends_on=[test_account]))

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const testAccount = new aws.macie2.Account("testAccount", {});
const testClassificationJob = new aws.macie2.ClassificationJob("testClassificationJob", {
    jobType: "ONE_TIME",
    s3JobDefinition: {
        bucketDefinitions: [{
            accountId: "ACCOUNT ID",
            buckets: ["S3 BUCKET NAME"],
        }],
    },
}, {
    dependsOn: [testAccount],
});

resources:
  testAccount:
    type: aws:macie2:Account
  testClassificationJob:
    type: aws:macie2:ClassificationJob
    properties:
      jobType: ONE_TIME
      s3JobDefinition:
        bucketDefinitions:
          - accountId: ACCOUNT ID
            buckets:
              - S3 BUCKET NAME
    options:
      dependson:
        - ${testAccount}

Create ClassificationJob Resource

new ClassificationJob(name: string, args: ClassificationJobArgs, opts?: CustomResourceOptions);
@overload
def ClassificationJob(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      custom_data_identifier_ids: Optional[Sequence[str]] = None,
                      description: Optional[str] = None,
                      initial_run: Optional[bool] = None,
                      job_status: Optional[str] = None,
                      job_type: Optional[str] = None,
                      name: Optional[str] = None,
                      name_prefix: Optional[str] = None,
                      s3_job_definition: Optional[ClassificationJobS3JobDefinitionArgs] = None,
                      sampling_percentage: Optional[int] = None,
                      schedule_frequency: Optional[ClassificationJobScheduleFrequencyArgs] = None,
                      tags: Optional[Mapping[str, str]] = None)
@overload
def ClassificationJob(resource_name: str,
                      args: ClassificationJobArgs,
                      opts: Optional[ResourceOptions] = None)
func NewClassificationJob(ctx *Context, name string, args ClassificationJobArgs, opts ...ResourceOption) (*ClassificationJob, error)
public ClassificationJob(string name, ClassificationJobArgs args, CustomResourceOptions? opts = null)
public ClassificationJob(String name, ClassificationJobArgs args)
public ClassificationJob(String name, ClassificationJobArgs args, CustomResourceOptions options)

type: aws:macie2:ClassificationJob
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ClassificationJobArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args ClassificationJobArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ClassificationJobArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ClassificationJobArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ClassificationJobArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

ClassificationJob Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The ClassificationJob resource accepts the following input properties:

JobType string

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 schedule_frequency property. SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the schedule_frequency property to define the recurrence pattern for the job.

S3JobDefinition ClassificationJobS3JobDefinitionArgs

The S3 buckets that contain the objects to analyze, and the scope of that analysis. (documented below)

CustomDataIdentifierIds List<string>

The custom data identifiers to use for data analysis and classification.

Description string

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

InitialRun bool

Specifies whether to analyze all existing, eligible objects immediately after the job is created.

JobStatus string

The status for the job. Valid values are: CANCELLED, RUNNING and USER_PAUSED

Name string

A custom name for the job. The name can contain as many as 500 characters. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.

NamePrefix string

Creates a unique name beginning with the specified prefix. Conflicts with name.

SamplingPercentage int

The sampling depth, as a percentage, 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 ClassificationJobScheduleFrequencyArgs

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 job_type property to ONE_TIME. (documented below)

Tags Dictionary<string, string>

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.

JobType string

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 schedule_frequency property. SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the schedule_frequency property to define the recurrence pattern for the job.

S3JobDefinition ClassificationJobS3JobDefinitionArgs

The S3 buckets that contain the objects to analyze, and the scope of that analysis. (documented below)

CustomDataIdentifierIds []string

The custom data identifiers to use for data analysis and classification.

Description string

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

InitialRun bool

Specifies whether to analyze all existing, eligible objects immediately after the job is created.

JobStatus string

The status for the job. Valid values are: CANCELLED, RUNNING and USER_PAUSED

Name string

A custom name for the job. The name can contain as many as 500 characters. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.

NamePrefix string

Creates a unique name beginning with the specified prefix. Conflicts with name.

SamplingPercentage int

The sampling depth, as a percentage, 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 ClassificationJobScheduleFrequencyArgs

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 job_type property to ONE_TIME. (documented below)

Tags map[string]string

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.

jobType String

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 schedule_frequency property. SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the schedule_frequency property to define the recurrence pattern for the job.

s3JobDefinition ClassificationJobS3JobDefinitionArgs

The S3 buckets that contain the objects to analyze, and the scope of that analysis. (documented below)

customDataIdentifierIds List<String>

The custom data identifiers to use for data analysis and classification.

description String

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

initialRun Boolean

Specifies whether to analyze all existing, eligible objects immediately after the job is created.

jobStatus String

The status for the job. Valid values are: CANCELLED, RUNNING and USER_PAUSED

name String

A custom name for the job. The name can contain as many as 500 characters. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.

namePrefix String

Creates a unique name beginning with the specified prefix. Conflicts with name.

samplingPercentage Integer

The sampling depth, as a percentage, 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 ClassificationJobScheduleFrequencyArgs

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 job_type property to ONE_TIME. (documented below)

tags Map<String,String>

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.

jobType string

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 schedule_frequency property. SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the schedule_frequency property to define the recurrence pattern for the job.

s3JobDefinition ClassificationJobS3JobDefinitionArgs

The S3 buckets that contain the objects to analyze, and the scope of that analysis. (documented below)

customDataIdentifierIds string[]

The custom data identifiers to use for data analysis and classification.

description string

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

initialRun boolean

Specifies whether to analyze all existing, eligible objects immediately after the job is created.

jobStatus string

The status for the job. Valid values are: CANCELLED, RUNNING and USER_PAUSED

name string

A custom name for the job. The name can contain as many as 500 characters. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.

namePrefix string

Creates a unique name beginning with the specified prefix. Conflicts with name.

samplingPercentage number

The sampling depth, as a percentage, 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 ClassificationJobScheduleFrequencyArgs

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 job_type property to ONE_TIME. (documented below)

tags {[key: string]: string}

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.

job_type str

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 schedule_frequency property. SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the schedule_frequency property to define the recurrence pattern for the job.

s3_job_definition ClassificationJobS3JobDefinitionArgs

The S3 buckets that contain the objects to analyze, and the scope of that analysis. (documented below)

custom_data_identifier_ids Sequence[str]

The custom data identifiers to use for data analysis and classification.

description str

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

initial_run bool

Specifies whether to analyze all existing, eligible objects immediately after the job is created.

job_status str

The status for the job. Valid values are: CANCELLED, RUNNING and USER_PAUSED

name str

A custom name for the job. The name can contain as many as 500 characters. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.

name_prefix str

Creates a unique name beginning with the specified prefix. Conflicts with name.

sampling_percentage int

The sampling depth, as a percentage, 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.

schedule_frequency ClassificationJobScheduleFrequencyArgs

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 job_type property to ONE_TIME. (documented below)

tags Mapping[str, str]

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.

jobType String

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 schedule_frequency property. SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the schedule_frequency property to define the recurrence pattern for the job.

s3JobDefinition Property Map

The S3 buckets that contain the objects to analyze, and the scope of that analysis. (documented below)

customDataIdentifierIds List<String>

The custom data identifiers to use for data analysis and classification.

description String

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

initialRun Boolean

Specifies whether to analyze all existing, eligible objects immediately after the job is created.

jobStatus String

The status for the job. Valid values are: CANCELLED, RUNNING and USER_PAUSED

name String

A custom name for the job. The name can contain as many as 500 characters. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.

namePrefix String

Creates a unique name beginning with the specified prefix. Conflicts with name.

samplingPercentage Number

The sampling depth, as a percentage, 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 Property Map

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 job_type property to ONE_TIME. (documented below)

tags Map<String>

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.

Outputs

All input properties are implicitly available as output properties. Additionally, the ClassificationJob resource produces the following output properties:

CreatedAt string

The date and time, in UTC and extended RFC 3339 format, when the job was created.

Id string

The provider-assigned unique ID for this managed resource.

JobArn string
JobId string
TagsAll Dictionary<string, string>
UserPausedDetails List<ClassificationJobUserPausedDetail>

If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for job-status is USER_PAUSED.

CreatedAt string

The date and time, in UTC and extended RFC 3339 format, when the job was created.

Id string

The provider-assigned unique ID for this managed resource.

JobArn string
JobId string
TagsAll map[string]string
UserPausedDetails []ClassificationJobUserPausedDetail

If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for job-status is USER_PAUSED.

createdAt String

The date and time, in UTC and extended RFC 3339 format, when the job was created.

id String

The provider-assigned unique ID for this managed resource.

jobArn String
jobId String
tagsAll Map<String,String>
userPausedDetails List<ClassificationJobUserPausedDetail>

If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for job-status is USER_PAUSED.

createdAt string

The date and time, in UTC and extended RFC 3339 format, when the job was created.

id string

The provider-assigned unique ID for this managed resource.

jobArn string
jobId string
tagsAll {[key: string]: string}
userPausedDetails ClassificationJobUserPausedDetail[]

If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for job-status is USER_PAUSED.

created_at str

The date and time, in UTC and extended RFC 3339 format, when the job was created.

id str

The provider-assigned unique ID for this managed resource.

job_arn str
job_id str
tags_all Mapping[str, str]
user_paused_details Sequence[ClassificationJobUserPausedDetail]

If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for job-status is USER_PAUSED.

createdAt String

The date and time, in UTC and extended RFC 3339 format, when the job was created.

id String

The provider-assigned unique ID for this managed resource.

jobArn String
jobId String
tagsAll Map<String>
userPausedDetails List<Property Map>

If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for job-status is USER_PAUSED.

Look up Existing ClassificationJob Resource

Get an existing ClassificationJob resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ClassificationJobState, opts?: CustomResourceOptions): ClassificationJob
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        custom_data_identifier_ids: Optional[Sequence[str]] = None,
        description: Optional[str] = None,
        initial_run: Optional[bool] = None,
        job_arn: Optional[str] = None,
        job_id: Optional[str] = None,
        job_status: Optional[str] = None,
        job_type: Optional[str] = None,
        name: Optional[str] = None,
        name_prefix: Optional[str] = None,
        s3_job_definition: Optional[ClassificationJobS3JobDefinitionArgs] = None,
        sampling_percentage: Optional[int] = None,
        schedule_frequency: Optional[ClassificationJobScheduleFrequencyArgs] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        user_paused_details: Optional[Sequence[ClassificationJobUserPausedDetailArgs]] = None) -> ClassificationJob
func GetClassificationJob(ctx *Context, name string, id IDInput, state *ClassificationJobState, opts ...ResourceOption) (*ClassificationJob, error)
public static ClassificationJob Get(string name, Input<string> id, ClassificationJobState? state, CustomResourceOptions? opts = null)
public static ClassificationJob get(String name, Output<String> id, ClassificationJobState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CreatedAt string

The date and time, in UTC and extended RFC 3339 format, when the job was created.

CustomDataIdentifierIds List<string>

The custom data identifiers to use for data analysis and classification.

Description string

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

InitialRun bool

Specifies whether to analyze all existing, eligible objects immediately after the job is created.

JobArn string
JobId string
JobStatus string

The status for the job. Valid values are: CANCELLED, RUNNING and USER_PAUSED

JobType string

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 schedule_frequency property. SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the schedule_frequency property to define the recurrence pattern for the job.

Name string

A custom name for the job. The name can contain as many as 500 characters. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.

NamePrefix string

Creates a unique name beginning with the specified prefix. Conflicts with name.

S3JobDefinition ClassificationJobS3JobDefinitionArgs

The S3 buckets that contain the objects to analyze, and the scope of that analysis. (documented below)

SamplingPercentage int

The sampling depth, as a percentage, 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 ClassificationJobScheduleFrequencyArgs

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 job_type property to ONE_TIME. (documented below)

Tags Dictionary<string, string>

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.

TagsAll Dictionary<string, string>
UserPausedDetails List<ClassificationJobUserPausedDetailArgs>

If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for job-status is USER_PAUSED.

CreatedAt string

The date and time, in UTC and extended RFC 3339 format, when the job was created.

CustomDataIdentifierIds []string

The custom data identifiers to use for data analysis and classification.

Description string

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

InitialRun bool

Specifies whether to analyze all existing, eligible objects immediately after the job is created.

JobArn string
JobId string
JobStatus string

The status for the job. Valid values are: CANCELLED, RUNNING and USER_PAUSED

JobType string

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 schedule_frequency property. SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the schedule_frequency property to define the recurrence pattern for the job.

Name string

A custom name for the job. The name can contain as many as 500 characters. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.

NamePrefix string

Creates a unique name beginning with the specified prefix. Conflicts with name.

S3JobDefinition ClassificationJobS3JobDefinitionArgs

The S3 buckets that contain the objects to analyze, and the scope of that analysis. (documented below)

SamplingPercentage int

The sampling depth, as a percentage, 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 ClassificationJobScheduleFrequencyArgs

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 job_type property to ONE_TIME. (documented below)

Tags map[string]string

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.

TagsAll map[string]string
UserPausedDetails []ClassificationJobUserPausedDetailArgs

If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for job-status is USER_PAUSED.

createdAt String

The date and time, in UTC and extended RFC 3339 format, when the job was created.

customDataIdentifierIds List<String>

The custom data identifiers to use for data analysis and classification.

description String

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

initialRun Boolean

Specifies whether to analyze all existing, eligible objects immediately after the job is created.

jobArn String
jobId String
jobStatus String

The status for the job. Valid values are: CANCELLED, RUNNING and USER_PAUSED

jobType String

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 schedule_frequency property. SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the schedule_frequency property to define the recurrence pattern for the job.

name String

A custom name for the job. The name can contain as many as 500 characters. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.

namePrefix String

Creates a unique name beginning with the specified prefix. Conflicts with name.

s3JobDefinition ClassificationJobS3JobDefinitionArgs

The S3 buckets that contain the objects to analyze, and the scope of that analysis. (documented below)

samplingPercentage Integer

The sampling depth, as a percentage, 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 ClassificationJobScheduleFrequencyArgs

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 job_type property to ONE_TIME. (documented below)

tags Map<String,String>

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.

tagsAll Map<String,String>
userPausedDetails List<ClassificationJobUserPausedDetailArgs>

If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for job-status is USER_PAUSED.

createdAt string

The date and time, in UTC and extended RFC 3339 format, when the job was created.

customDataIdentifierIds string[]

The custom data identifiers to use for data analysis and classification.

description string

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

initialRun boolean

Specifies whether to analyze all existing, eligible objects immediately after the job is created.

jobArn string
jobId string
jobStatus string

The status for the job. Valid values are: CANCELLED, RUNNING and USER_PAUSED

jobType string

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 schedule_frequency property. SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the schedule_frequency property to define the recurrence pattern for the job.

name string

A custom name for the job. The name can contain as many as 500 characters. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.

namePrefix string

Creates a unique name beginning with the specified prefix. Conflicts with name.

s3JobDefinition ClassificationJobS3JobDefinitionArgs

The S3 buckets that contain the objects to analyze, and the scope of that analysis. (documented below)

samplingPercentage number

The sampling depth, as a percentage, 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 ClassificationJobScheduleFrequencyArgs

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 job_type property to ONE_TIME. (documented below)

tags {[key: string]: string}

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.

tagsAll {[key: string]: string}
userPausedDetails ClassificationJobUserPausedDetailArgs[]

If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for job-status is USER_PAUSED.

created_at str

The date and time, in UTC and extended RFC 3339 format, when the job was created.

custom_data_identifier_ids Sequence[str]

The custom data identifiers to use for data analysis and classification.

description str

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

initial_run bool

Specifies whether to analyze all existing, eligible objects immediately after the job is created.

job_arn str
job_id str
job_status str

The status for the job. Valid values are: CANCELLED, RUNNING and USER_PAUSED

job_type str

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 schedule_frequency property. SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the schedule_frequency property to define the recurrence pattern for the job.

name str

A custom name for the job. The name can contain as many as 500 characters. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.

name_prefix str

Creates a unique name beginning with the specified prefix. Conflicts with name.

s3_job_definition ClassificationJobS3JobDefinitionArgs

The S3 buckets that contain the objects to analyze, and the scope of that analysis. (documented below)

sampling_percentage int

The sampling depth, as a percentage, 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.

schedule_frequency ClassificationJobScheduleFrequencyArgs

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 job_type property to ONE_TIME. (documented below)

tags Mapping[str, str]

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.

tags_all Mapping[str, str]
user_paused_details Sequence[ClassificationJobUserPausedDetailArgs]

If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for job-status is USER_PAUSED.

createdAt String

The date and time, in UTC and extended RFC 3339 format, when the job was created.

customDataIdentifierIds List<String>

The custom data identifiers to use for data analysis and classification.

description String

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

initialRun Boolean

Specifies whether to analyze all existing, eligible objects immediately after the job is created.

jobArn String
jobId String
jobStatus String

The status for the job. Valid values are: CANCELLED, RUNNING and USER_PAUSED

jobType String

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 schedule_frequency property. SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the schedule_frequency property to define the recurrence pattern for the job.

name String

A custom name for the job. The name can contain as many as 500 characters. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.

namePrefix String

Creates a unique name beginning with the specified prefix. Conflicts with name.

s3JobDefinition Property Map

The S3 buckets that contain the objects to analyze, and the scope of that analysis. (documented below)

samplingPercentage Number

The sampling depth, as a percentage, 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 Property Map

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 job_type property to ONE_TIME. (documented below)

tags Map<String>

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.

tagsAll Map<String>
userPausedDetails List<Property Map>

If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for job-status is USER_PAUSED.

Supporting Types

ClassificationJobS3JobDefinition

BucketCriteria ClassificationJobS3JobDefinitionBucketCriteria

The property- and tag-based conditions that determine which S3 buckets to include or exclude from the analysis. Conflicts with bucket_definitions. (documented below)

BucketDefinitions List<ClassificationJobS3JobDefinitionBucketDefinition>

An array of objects, one for each AWS account that owns buckets to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for the account. Conflicts with bucket_criteria. (documented below)

Scoping ClassificationJobS3JobDefinitionScoping

The property- and tag-based conditions that determine which objects to include or exclude from the analysis. (documented below)

BucketCriteria ClassificationJobS3JobDefinitionBucketCriteria

The property- and tag-based conditions that determine which S3 buckets to include or exclude from the analysis. Conflicts with bucket_definitions. (documented below)

BucketDefinitions []ClassificationJobS3JobDefinitionBucketDefinition

An array of objects, one for each AWS account that owns buckets to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for the account. Conflicts with bucket_criteria. (documented below)

Scoping ClassificationJobS3JobDefinitionScoping

The property- and tag-based conditions that determine which objects to include or exclude from the analysis. (documented below)

bucketCriteria ClassificationJobS3JobDefinitionBucketCriteria

The property- and tag-based conditions that determine which S3 buckets to include or exclude from the analysis. Conflicts with bucket_definitions. (documented below)

bucketDefinitions List<ClassificationJobS3JobDefinitionBucketDefinition>

An array of objects, one for each AWS account that owns buckets to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for the account. Conflicts with bucket_criteria. (documented below)

scoping ClassificationJobS3JobDefinitionScoping

The property- and tag-based conditions that determine which objects to include or exclude from the analysis. (documented below)

bucketCriteria ClassificationJobS3JobDefinitionBucketCriteria

The property- and tag-based conditions that determine which S3 buckets to include or exclude from the analysis. Conflicts with bucket_definitions. (documented below)

bucketDefinitions ClassificationJobS3JobDefinitionBucketDefinition[]

An array of objects, one for each AWS account that owns buckets to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for the account. Conflicts with bucket_criteria. (documented below)

scoping ClassificationJobS3JobDefinitionScoping

The property- and tag-based conditions that determine which objects to include or exclude from the analysis. (documented below)

bucket_criteria ClassificationJobS3JobDefinitionBucketCriteria

The property- and tag-based conditions that determine which S3 buckets to include or exclude from the analysis. Conflicts with bucket_definitions. (documented below)

bucket_definitions Sequence[ClassificationJobS3JobDefinitionBucketDefinition]

An array of objects, one for each AWS account that owns buckets to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for the account. Conflicts with bucket_criteria. (documented below)

scoping ClassificationJobS3JobDefinitionScoping

The property- and tag-based conditions that determine which objects to include or exclude from the analysis. (documented below)

bucketCriteria Property Map

The property- and tag-based conditions that determine which S3 buckets to include or exclude from the analysis. Conflicts with bucket_definitions. (documented below)

bucketDefinitions List<Property Map>

An array of objects, one for each AWS account that owns buckets to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for the account. Conflicts with bucket_criteria. (documented below)

scoping Property Map

The property- and tag-based conditions that determine which objects to include or exclude from the analysis. (documented below)

ClassificationJobS3JobDefinitionBucketCriteria

Excludes ClassificationJobS3JobDefinitionBucketCriteriaExcludes

The property- or tag-based conditions that determine which S3 buckets to exclude from the analysis. (documented below)

Includes ClassificationJobS3JobDefinitionBucketCriteriaIncludes

The property- or tag-based conditions that determine which S3 buckets to include in the analysis. (documented below)

Excludes ClassificationJobS3JobDefinitionBucketCriteriaExcludes

The property- or tag-based conditions that determine which S3 buckets to exclude from the analysis. (documented below)

Includes ClassificationJobS3JobDefinitionBucketCriteriaIncludes

The property- or tag-based conditions that determine which S3 buckets to include in the analysis. (documented below)

excludes ClassificationJobS3JobDefinitionBucketCriteriaExcludes

The property- or tag-based conditions that determine which S3 buckets to exclude from the analysis. (documented below)

includes ClassificationJobS3JobDefinitionBucketCriteriaIncludes

The property- or tag-based conditions that determine which S3 buckets to include in the analysis. (documented below)

excludes ClassificationJobS3JobDefinitionBucketCriteriaExcludes

The property- or tag-based conditions that determine which S3 buckets to exclude from the analysis. (documented below)

includes ClassificationJobS3JobDefinitionBucketCriteriaIncludes

The property- or tag-based conditions that determine which S3 buckets to include in the analysis. (documented below)

excludes ClassificationJobS3JobDefinitionBucketCriteriaExcludes

The property- or tag-based conditions that determine which S3 buckets to exclude from the analysis. (documented below)

includes ClassificationJobS3JobDefinitionBucketCriteriaIncludes

The property- or tag-based conditions that determine which S3 buckets to include in the analysis. (documented below)

excludes Property Map

The property- or tag-based conditions that determine which S3 buckets to exclude from the analysis. (documented below)

includes Property Map

The property- or tag-based conditions that determine which S3 buckets to include in the analysis. (documented below)

ClassificationJobS3JobDefinitionBucketCriteriaExcludes

Ands List<ClassificationJobS3JobDefinitionBucketCriteriaExcludesAnd>

An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)

Ands []ClassificationJobS3JobDefinitionBucketCriteriaExcludesAnd

An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)

ands List<ClassificationJobS3JobDefinitionBucketCriteriaExcludesAnd>

An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)

ands ClassificationJobS3JobDefinitionBucketCriteriaExcludesAnd[]

An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)

ands Sequence[ClassificationJobS3JobDefinitionBucketCriteriaExcludesAnd]

An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)

ands List<Property Map>

An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)

ClassificationJobS3JobDefinitionBucketCriteriaExcludesAnd

SimpleCriterion ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndSimpleCriterion

A property-based condition that defines a property, operator, and one or more values for including or excluding an S3 buckets from the job. (documented below)

TagCriterion ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndTagCriterion

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an S3 buckets from the job. (documented below)

SimpleCriterion ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndSimpleCriterion

A property-based condition that defines a property, operator, and one or more values for including or excluding an S3 buckets from the job. (documented below)

TagCriterion ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndTagCriterion

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an S3 buckets from the job. (documented below)

simpleCriterion ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndSimpleCriterion

A property-based condition that defines a property, operator, and one or more values for including or excluding an S3 buckets from the job. (documented below)

tagCriterion ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndTagCriterion

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an S3 buckets from the job. (documented below)

simpleCriterion ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndSimpleCriterion

A property-based condition that defines a property, operator, and one or more values for including or excluding an S3 buckets from the job. (documented below)

tagCriterion ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndTagCriterion

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an S3 buckets from the job. (documented below)

simple_criterion ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndSimpleCriterion

A property-based condition that defines a property, operator, and one or more values for including or excluding an S3 buckets from the job. (documented below)

tag_criterion ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndTagCriterion

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an S3 buckets from the job. (documented below)

simpleCriterion Property Map

A property-based condition that defines a property, operator, and one or more values for including or excluding an S3 buckets from the job. (documented below)

tagCriterion Property Map

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an S3 buckets from the job. (documented below)

ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndSimpleCriterion

Comparator string

The operator to use in a condition. Valid combination of values are available in the AWS Documentation

Key string

The object property to use in the condition. Valid combination of values are available in the AWS Documentation

Values List<string>

An array that lists the values to use in the condition. Valid combination of values are available in the AWS Documentation

Comparator string

The operator to use in a condition. Valid combination of values are available in the AWS Documentation

Key string

The object property to use in the condition. Valid combination of values are available in the AWS Documentation

Values []string

An array that lists the values to use in the condition. Valid combination of values are available in the AWS Documentation

comparator String

The operator to use in a condition. Valid combination of values are available in the AWS Documentation

key String

The object property to use in the condition. Valid combination of values are available in the AWS Documentation

values List<String>

An array that lists the values to use in the condition. Valid combination of values are available in the AWS Documentation

comparator string

The operator to use in a condition. Valid combination of values are available in the AWS Documentation

key string

The object property to use in the condition. Valid combination of values are available in the AWS Documentation

values string[]

An array that lists the values to use in the condition. Valid combination of values are available in the AWS Documentation

comparator str

The operator to use in a condition. Valid combination of values are available in the AWS Documentation

key str

The object property to use in the condition. Valid combination of values are available in the AWS Documentation

values Sequence[str]

An array that lists the values to use in the condition. Valid combination of values are available in the AWS Documentation

comparator String

The operator to use in a condition. Valid combination of values are available in the AWS Documentation

key String

The object property to use in the condition. Valid combination of values are available in the AWS Documentation

values List<String>

An array that lists the values to use in the condition. Valid combination of values are available in the AWS Documentation

ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndTagCriterion

Comparator string

The operator to use in the condition. Valid combination and values are available in the AWS Documentation

TagValues List<ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndTagCriterionTagValue>

The tag key and value pairs to use in the condition. One or more blocks are allowed. (documented below)

Comparator string

The operator to use in the condition. Valid combination and values are available in the AWS Documentation

TagValues []ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndTagCriterionTagValue

The tag key and value pairs to use in the condition. One or more blocks are allowed. (documented below)

comparator String

The operator to use in the condition. Valid combination and values are available in the AWS Documentation

tagValues List<ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndTagCriterionTagValue>

The tag key and value pairs to use in the condition. One or more blocks are allowed. (documented below)

comparator string

The operator to use in the condition. Valid combination and values are available in the AWS Documentation

tagValues ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndTagCriterionTagValue[]

The tag key and value pairs to use in the condition. One or more blocks are allowed. (documented below)

comparator str

The operator to use in the condition. Valid combination and values are available in the AWS Documentation

tag_values Sequence[ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndTagCriterionTagValue]

The tag key and value pairs to use in the condition. One or more blocks are allowed. (documented below)

comparator String

The operator to use in the condition. Valid combination and values are available in the AWS Documentation

tagValues List<Property Map>

The tag key and value pairs to use in the condition. One or more blocks are allowed. (documented below)

ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndTagCriterionTagValue

Key string

The tag key.

Value string

The tag value.

Key string

The tag key.

Value string

The tag value.

key String

The tag key.

value String

The tag value.

key string

The tag key.

value string

The tag value.

key str

The tag key.

value str

The tag value.

key String

The tag key.

value String

The tag value.

ClassificationJobS3JobDefinitionBucketCriteriaIncludes

Ands List<ClassificationJobS3JobDefinitionBucketCriteriaIncludesAnd>

An array of conditions, one for each condition that determines which S3 buckets to include or exclude from the job. (documented below)

Ands []ClassificationJobS3JobDefinitionBucketCriteriaIncludesAnd

An array of conditions, one for each condition that determines which S3 buckets to include or exclude from the job. (documented below)

ands List<ClassificationJobS3JobDefinitionBucketCriteriaIncludesAnd>

An array of conditions, one for each condition that determines which S3 buckets to include or exclude from the job. (documented below)

ands ClassificationJobS3JobDefinitionBucketCriteriaIncludesAnd[]

An array of conditions, one for each condition that determines which S3 buckets to include or exclude from the job. (documented below)

ands Sequence[ClassificationJobS3JobDefinitionBucketCriteriaIncludesAnd]

An array of conditions, one for each condition that determines which S3 buckets to include or exclude from the job. (documented below)

ands List<Property Map>

An array of conditions, one for each condition that determines which S3 buckets to include or exclude from the job. (documented below)

ClassificationJobS3JobDefinitionBucketCriteriaIncludesAnd

SimpleCriterion ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndSimpleCriterion

A property-based condition that defines a property, operator, and one or more values for including or excluding an S3 buckets from the job. (documented below)

TagCriterion ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndTagCriterion

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an S3 buckets from the job. (documented below)

SimpleCriterion ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndSimpleCriterion

A property-based condition that defines a property, operator, and one or more values for including or excluding an S3 buckets from the job. (documented below)

TagCriterion ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndTagCriterion

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an S3 buckets from the job. (documented below)

simpleCriterion ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndSimpleCriterion

A property-based condition that defines a property, operator, and one or more values for including or excluding an S3 buckets from the job. (documented below)

tagCriterion ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndTagCriterion

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an S3 buckets from the job. (documented below)

simpleCriterion ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndSimpleCriterion

A property-based condition that defines a property, operator, and one or more values for including or excluding an S3 buckets from the job. (documented below)

tagCriterion ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndTagCriterion

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an S3 buckets from the job. (documented below)

simple_criterion ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndSimpleCriterion

A property-based condition that defines a property, operator, and one or more values for including or excluding an S3 buckets from the job. (documented below)

tag_criterion ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndTagCriterion

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an S3 buckets from the job. (documented below)

simpleCriterion Property Map

A property-based condition that defines a property, operator, and one or more values for including or excluding an S3 buckets from the job. (documented below)

tagCriterion Property Map

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an S3 buckets from the job. (documented below)

ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndSimpleCriterion

Comparator string

The operator to use in a condition. Valid combination of values are available in the AWS Documentation

Key string

The object property to use in the condition. Valid combination of values are available in the AWS Documentation

Values List<string>

An array that lists the values to use in the condition. Valid combination of values are available in the AWS Documentation

Comparator string

The operator to use in a condition. Valid combination of values are available in the AWS Documentation

Key string

The object property to use in the condition. Valid combination of values are available in the AWS Documentation

Values []string

An array that lists the values to use in the condition. Valid combination of values are available in the AWS Documentation

comparator String

The operator to use in a condition. Valid combination of values are available in the AWS Documentation

key String

The object property to use in the condition. Valid combination of values are available in the AWS Documentation

values List<String>

An array that lists the values to use in the condition. Valid combination of values are available in the AWS Documentation

comparator string

The operator to use in a condition. Valid combination of values are available in the AWS Documentation

key string

The object property to use in the condition. Valid combination of values are available in the AWS Documentation

values string[]

An array that lists the values to use in the condition. Valid combination of values are available in the AWS Documentation

comparator str

The operator to use in a condition. Valid combination of values are available in the AWS Documentation

key str

The object property to use in the condition. Valid combination of values are available in the AWS Documentation

values Sequence[str]

An array that lists the values to use in the condition. Valid combination of values are available in the AWS Documentation

comparator String

The operator to use in a condition. Valid combination of values are available in the AWS Documentation

key String

The object property to use in the condition. Valid combination of values are available in the AWS Documentation

values List<String>

An array that lists the values to use in the condition. Valid combination of values are available in the AWS Documentation

ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndTagCriterion

Comparator string

The operator to use in the condition. Valid combination and values are available in the AWS Documentation

TagValues List<ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndTagCriterionTagValue>

The tag key and value pairs to use in the condition. One or more blocks are allowed. (documented below)

Comparator string

The operator to use in the condition. Valid combination and values are available in the AWS Documentation

TagValues []ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndTagCriterionTagValue

The tag key and value pairs to use in the condition. One or more blocks are allowed. (documented below)

comparator String

The operator to use in the condition. Valid combination and values are available in the AWS Documentation

tagValues List<ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndTagCriterionTagValue>

The tag key and value pairs to use in the condition. One or more blocks are allowed. (documented below)

comparator string

The operator to use in the condition. Valid combination and values are available in the AWS Documentation

tagValues ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndTagCriterionTagValue[]

The tag key and value pairs to use in the condition. One or more blocks are allowed. (documented below)

comparator str

The operator to use in the condition. Valid combination and values are available in the AWS Documentation

tag_values Sequence[ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndTagCriterionTagValue]

The tag key and value pairs to use in the condition. One or more blocks are allowed. (documented below)

comparator String

The operator to use in the condition. Valid combination and values are available in the AWS Documentation

tagValues List<Property Map>

The tag key and value pairs to use in the condition. One or more blocks are allowed. (documented below)

ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndTagCriterionTagValue

Key string

The tag key.

Value string

The tag value.

Key string

The tag key.

Value string

The tag value.

key String

The tag key.

value String

The tag value.

key string

The tag key.

value string

The tag value.

key str

The tag key.

value str

The tag value.

key String

The tag key.

value String

The tag value.

ClassificationJobS3JobDefinitionBucketDefinition

AccountId string

The unique identifier for the AWS account that owns the buckets.

Buckets List<string>

An array that lists the names of the buckets.

AccountId string

The unique identifier for the AWS account that owns the buckets.

Buckets []string

An array that lists the names of the buckets.

accountId String

The unique identifier for the AWS account that owns the buckets.

buckets List<String>

An array that lists the names of the buckets.

accountId string

The unique identifier for the AWS account that owns the buckets.

buckets string[]

An array that lists the names of the buckets.

account_id str

The unique identifier for the AWS account that owns the buckets.

buckets Sequence[str]

An array that lists the names of the buckets.

accountId String

The unique identifier for the AWS account that owns the buckets.

buckets List<String>

An array that lists the names of the buckets.

ClassificationJobS3JobDefinitionScoping

Excludes ClassificationJobS3JobDefinitionScopingExcludes

The property- or tag-based conditions that determine which objects to exclude from the analysis. (documented below)

Includes ClassificationJobS3JobDefinitionScopingIncludes

The property- or tag-based conditions that determine which objects to include in the analysis. (documented below)

Excludes ClassificationJobS3JobDefinitionScopingExcludes

The property- or tag-based conditions that determine which objects to exclude from the analysis. (documented below)

Includes ClassificationJobS3JobDefinitionScopingIncludes

The property- or tag-based conditions that determine which objects to include in the analysis. (documented below)

excludes ClassificationJobS3JobDefinitionScopingExcludes

The property- or tag-based conditions that determine which objects to exclude from the analysis. (documented below)

includes ClassificationJobS3JobDefinitionScopingIncludes

The property- or tag-based conditions that determine which objects to include in the analysis. (documented below)

excludes ClassificationJobS3JobDefinitionScopingExcludes

The property- or tag-based conditions that determine which objects to exclude from the analysis. (documented below)

includes ClassificationJobS3JobDefinitionScopingIncludes

The property- or tag-based conditions that determine which objects to include in the analysis. (documented below)

excludes ClassificationJobS3JobDefinitionScopingExcludes

The property- or tag-based conditions that determine which objects to exclude from the analysis. (documented below)

includes ClassificationJobS3JobDefinitionScopingIncludes

The property- or tag-based conditions that determine which objects to include in the analysis. (documented below)

excludes Property Map

The property- or tag-based conditions that determine which objects to exclude from the analysis. (documented below)

includes Property Map

The property- or tag-based conditions that determine which objects to include in the analysis. (documented below)

ClassificationJobS3JobDefinitionScopingExcludes

Ands List<ClassificationJobS3JobDefinitionScopingExcludesAnd>

An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)

Ands []ClassificationJobS3JobDefinitionScopingExcludesAnd

An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)

ands List<ClassificationJobS3JobDefinitionScopingExcludesAnd>

An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)

ands ClassificationJobS3JobDefinitionScopingExcludesAnd[]

An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)

ands Sequence[ClassificationJobS3JobDefinitionScopingExcludesAnd]

An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)

ands List<Property Map>

An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)

ClassificationJobS3JobDefinitionScopingExcludesAnd

SimpleScopeTerm ClassificationJobS3JobDefinitionScopingExcludesAndSimpleScopeTerm

A property-based condition that defines a property, operator, and one or more values for including or excluding an object from the job. (documented below)

TagScopeTerm ClassificationJobS3JobDefinitionScopingExcludesAndTagScopeTerm

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an object from the job. (documented below)

SimpleScopeTerm ClassificationJobS3JobDefinitionScopingExcludesAndSimpleScopeTerm

A property-based condition that defines a property, operator, and one or more values for including or excluding an object from the job. (documented below)

TagScopeTerm ClassificationJobS3JobDefinitionScopingExcludesAndTagScopeTerm

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an object from the job. (documented below)

simpleScopeTerm ClassificationJobS3JobDefinitionScopingExcludesAndSimpleScopeTerm

A property-based condition that defines a property, operator, and one or more values for including or excluding an object from the job. (documented below)

tagScopeTerm ClassificationJobS3JobDefinitionScopingExcludesAndTagScopeTerm

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an object from the job. (documented below)

simpleScopeTerm ClassificationJobS3JobDefinitionScopingExcludesAndSimpleScopeTerm

A property-based condition that defines a property, operator, and one or more values for including or excluding an object from the job. (documented below)

tagScopeTerm ClassificationJobS3JobDefinitionScopingExcludesAndTagScopeTerm

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an object from the job. (documented below)

simple_scope_term ClassificationJobS3JobDefinitionScopingExcludesAndSimpleScopeTerm

A property-based condition that defines a property, operator, and one or more values for including or excluding an object from the job. (documented below)

tag_scope_term ClassificationJobS3JobDefinitionScopingExcludesAndTagScopeTerm

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an object from the job. (documented below)

simpleScopeTerm Property Map

A property-based condition that defines a property, operator, and one or more values for including or excluding an object from the job. (documented below)

tagScopeTerm Property Map

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an object from the job. (documented below)

ClassificationJobS3JobDefinitionScopingExcludesAndSimpleScopeTerm

Comparator string

The operator to use in a condition. Valid values are: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH

Key string

The object property to use in the condition.

Values List<string>

An array that lists the values to use in the condition.

Comparator string

The operator to use in a condition. Valid values are: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH

Key string

The object property to use in the condition.

Values []string

An array that lists the values to use in the condition.

comparator String

The operator to use in a condition. Valid values are: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH

key String

The object property to use in the condition.

values List<String>

An array that lists the values to use in the condition.

comparator string

The operator to use in a condition. Valid values are: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH

key string

The object property to use in the condition.

values string[]

An array that lists the values to use in the condition.

comparator str

The operator to use in a condition. Valid values are: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH

key str

The object property to use in the condition.

values Sequence[str]

An array that lists the values to use in the condition.

comparator String

The operator to use in a condition. Valid values are: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH

key String

The object property to use in the condition.

values List<String>

An array that lists the values to use in the condition.

ClassificationJobS3JobDefinitionScopingExcludesAndTagScopeTerm

Comparator string

The operator to use in the condition.

Key string

The tag key to use in the condition. The only valid value is TAG.

TagValues List<ClassificationJobS3JobDefinitionScopingExcludesAndTagScopeTermTagValue>

The tag keys or tag key and value pairs to use in the condition.

Target string

The type of object to apply the condition to. The only valid value is S3_OBJECT.

Comparator string

The operator to use in the condition.

Key string

The tag key to use in the condition. The only valid value is TAG.

TagValues []ClassificationJobS3JobDefinitionScopingExcludesAndTagScopeTermTagValue

The tag keys or tag key and value pairs to use in the condition.

Target string

The type of object to apply the condition to. The only valid value is S3_OBJECT.

comparator String

The operator to use in the condition.

key String

The tag key to use in the condition. The only valid value is TAG.

tagValues List<ClassificationJobS3JobDefinitionScopingExcludesAndTagScopeTermTagValue>

The tag keys or tag key and value pairs to use in the condition.

target String

The type of object to apply the condition to. The only valid value is S3_OBJECT.

comparator string

The operator to use in the condition.

key string

The tag key to use in the condition. The only valid value is TAG.

tagValues ClassificationJobS3JobDefinitionScopingExcludesAndTagScopeTermTagValue[]

The tag keys or tag key and value pairs to use in the condition.

target string

The type of object to apply the condition to. The only valid value is S3_OBJECT.

comparator str

The operator to use in the condition.

key str

The tag key to use in the condition. The only valid value is TAG.

tag_values Sequence[ClassificationJobS3JobDefinitionScopingExcludesAndTagScopeTermTagValue]

The tag keys or tag key and value pairs to use in the condition.

target str

The type of object to apply the condition to. The only valid value is S3_OBJECT.

comparator String

The operator to use in the condition.

key String

The tag key to use in the condition. The only valid value is TAG.

tagValues List<Property Map>

The tag keys or tag key and value pairs to use in the condition.

target String

The type of object to apply the condition to. The only valid value is S3_OBJECT.

ClassificationJobS3JobDefinitionScopingExcludesAndTagScopeTermTagValue

Key string

The tag key.

Value string

The tag value.

Key string

The tag key.

Value string

The tag value.

key String

The tag key.

value String

The tag value.

key string

The tag key.

value string

The tag value.

key str

The tag key.

value str

The tag value.

key String

The tag key.

value String

The tag value.

ClassificationJobS3JobDefinitionScopingIncludes

Ands List<ClassificationJobS3JobDefinitionScopingIncludesAnd>

An array of conditions, one for each condition that determines which S3 buckets to include or exclude from the job. (documented below)

Ands []ClassificationJobS3JobDefinitionScopingIncludesAnd

An array of conditions, one for each condition that determines which S3 buckets to include or exclude from the job. (documented below)

ands List<ClassificationJobS3JobDefinitionScopingIncludesAnd>

An array of conditions, one for each condition that determines which S3 buckets to include or exclude from the job. (documented below)

ands ClassificationJobS3JobDefinitionScopingIncludesAnd[]

An array of conditions, one for each condition that determines which S3 buckets to include or exclude from the job. (documented below)

ands Sequence[ClassificationJobS3JobDefinitionScopingIncludesAnd]

An array of conditions, one for each condition that determines which S3 buckets to include or exclude from the job. (documented below)

ands List<Property Map>

An array of conditions, one for each condition that determines which S3 buckets to include or exclude from the job. (documented below)

ClassificationJobS3JobDefinitionScopingIncludesAnd

SimpleScopeTerm ClassificationJobS3JobDefinitionScopingIncludesAndSimpleScopeTerm

A property-based condition that defines a property, operator, and one or more values for including or excluding an object from the job. (documented below)

TagScopeTerm ClassificationJobS3JobDefinitionScopingIncludesAndTagScopeTerm

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an object from the job. (documented below)

SimpleScopeTerm ClassificationJobS3JobDefinitionScopingIncludesAndSimpleScopeTerm

A property-based condition that defines a property, operator, and one or more values for including or excluding an object from the job. (documented below)

TagScopeTerm ClassificationJobS3JobDefinitionScopingIncludesAndTagScopeTerm

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an object from the job. (documented below)

simpleScopeTerm ClassificationJobS3JobDefinitionScopingIncludesAndSimpleScopeTerm

A property-based condition that defines a property, operator, and one or more values for including or excluding an object from the job. (documented below)

tagScopeTerm ClassificationJobS3JobDefinitionScopingIncludesAndTagScopeTerm

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an object from the job. (documented below)

simpleScopeTerm ClassificationJobS3JobDefinitionScopingIncludesAndSimpleScopeTerm

A property-based condition that defines a property, operator, and one or more values for including or excluding an object from the job. (documented below)

tagScopeTerm ClassificationJobS3JobDefinitionScopingIncludesAndTagScopeTerm

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an object from the job. (documented below)

simple_scope_term ClassificationJobS3JobDefinitionScopingIncludesAndSimpleScopeTerm

A property-based condition that defines a property, operator, and one or more values for including or excluding an object from the job. (documented below)

tag_scope_term ClassificationJobS3JobDefinitionScopingIncludesAndTagScopeTerm

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an object from the job. (documented below)

simpleScopeTerm Property Map

A property-based condition that defines a property, operator, and one or more values for including or excluding an object from the job. (documented below)

tagScopeTerm Property Map

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an object from the job. (documented below)

ClassificationJobS3JobDefinitionScopingIncludesAndSimpleScopeTerm

Comparator string

The operator to use in a condition. Valid values are: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH

Key string

The object property to use in the condition.

Values List<string>

An array that lists the values to use in the condition.

Comparator string

The operator to use in a condition. Valid values are: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH

Key string

The object property to use in the condition.

Values []string

An array that lists the values to use in the condition.

comparator String

The operator to use in a condition. Valid values are: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH

key String

The object property to use in the condition.

values List<String>

An array that lists the values to use in the condition.

comparator string

The operator to use in a condition. Valid values are: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH

key string

The object property to use in the condition.

values string[]

An array that lists the values to use in the condition.

comparator str

The operator to use in a condition. Valid values are: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH

key str

The object property to use in the condition.

values Sequence[str]

An array that lists the values to use in the condition.

comparator String

The operator to use in a condition. Valid values are: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH

key String

The object property to use in the condition.

values List<String>

An array that lists the values to use in the condition.

ClassificationJobS3JobDefinitionScopingIncludesAndTagScopeTerm

Comparator string

The operator to use in the condition.

Key string

The tag key to use in the condition. The only valid value is TAG.

TagValues List<ClassificationJobS3JobDefinitionScopingIncludesAndTagScopeTermTagValue>

The tag keys or tag key and value pairs to use in the condition.

Target string

The type of object to apply the condition to. The only valid value is S3_OBJECT.

Comparator string

The operator to use in the condition.

Key string

The tag key to use in the condition. The only valid value is TAG.

TagValues []ClassificationJobS3JobDefinitionScopingIncludesAndTagScopeTermTagValue

The tag keys or tag key and value pairs to use in the condition.

Target string

The type of object to apply the condition to. The only valid value is S3_OBJECT.

comparator String

The operator to use in the condition.

key String

The tag key to use in the condition. The only valid value is TAG.

tagValues List<ClassificationJobS3JobDefinitionScopingIncludesAndTagScopeTermTagValue>

The tag keys or tag key and value pairs to use in the condition.

target String

The type of object to apply the condition to. The only valid value is S3_OBJECT.

comparator string

The operator to use in the condition.

key string

The tag key to use in the condition. The only valid value is TAG.

tagValues ClassificationJobS3JobDefinitionScopingIncludesAndTagScopeTermTagValue[]

The tag keys or tag key and value pairs to use in the condition.

target string

The type of object to apply the condition to. The only valid value is S3_OBJECT.

comparator str

The operator to use in the condition.

key str

The tag key to use in the condition. The only valid value is TAG.

tag_values Sequence[ClassificationJobS3JobDefinitionScopingIncludesAndTagScopeTermTagValue]

The tag keys or tag key and value pairs to use in the condition.

target str

The type of object to apply the condition to. The only valid value is S3_OBJECT.

comparator String

The operator to use in the condition.

key String

The tag key to use in the condition. The only valid value is TAG.

tagValues List<Property Map>

The tag keys or tag key and value pairs to use in the condition.

target String

The type of object to apply the condition to. The only valid value is S3_OBJECT.

ClassificationJobS3JobDefinitionScopingIncludesAndTagScopeTermTagValue

Key string

The tag key.

Value string

The tag value.

Key string

The tag key.

Value string

The tag value.

key String

The tag key.

value String

The tag value.

key string

The tag key.

value string

The tag value.

key str

The tag key.

value str

The tag value.

key String

The tag key.

value String

The tag value.

ClassificationJobScheduleFrequency

DailySchedule bool

Specifies a daily recurrence pattern for running the job.

MonthlySchedule int

Specifies a monthly recurrence pattern for running the job.

WeeklySchedule string

Specifies a weekly recurrence pattern for running the job.

DailySchedule bool

Specifies a daily recurrence pattern for running the job.

MonthlySchedule int

Specifies a monthly recurrence pattern for running the job.

WeeklySchedule string

Specifies a weekly recurrence pattern for running the job.

dailySchedule Boolean

Specifies a daily recurrence pattern for running the job.

monthlySchedule Integer

Specifies a monthly recurrence pattern for running the job.

weeklySchedule String

Specifies a weekly recurrence pattern for running the job.

dailySchedule boolean

Specifies a daily recurrence pattern for running the job.

monthlySchedule number

Specifies a monthly recurrence pattern for running the job.

weeklySchedule string

Specifies a weekly recurrence pattern for running the job.

daily_schedule bool

Specifies a daily recurrence pattern for running the job.

monthly_schedule int

Specifies a monthly recurrence pattern for running the job.

weekly_schedule str

Specifies a weekly recurrence pattern for running the job.

dailySchedule Boolean

Specifies a daily recurrence pattern for running the job.

monthlySchedule Number

Specifies a monthly recurrence pattern for running the job.

weeklySchedule String

Specifies a weekly recurrence pattern for running the job.

ClassificationJobUserPausedDetail

Import

aws_macie2_classification_job can be imported using the id, e.g.,

 $ pulumi import aws:macie2/classificationJob:ClassificationJob example abcd1

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.