aws.macie2.ClassificationJob
Explore with Pulumi AI
Provides a resource to manage an AWS Macie Classification Job.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = new aws.macie2.Account("test", {});
const testClassificationJob = new aws.macie2.ClassificationJob("test", {
jobType: "ONE_TIME",
name: "NAME OF THE CLASSIFICATION JOB",
s3JobDefinition: {
bucketDefinitions: [{
accountId: "ACCOUNT ID",
buckets: ["S3 BUCKET NAME"],
}],
},
}, {
dependsOn: [test],
});
import pulumi
import pulumi_aws as aws
test = aws.macie2.Account("test")
test_classification_job = aws.macie2.ClassificationJob("test",
job_type="ONE_TIME",
name="NAME OF THE CLASSIFICATION JOB",
s3_job_definition={
"bucket_definitions": [{
"account_id": "ACCOUNT ID",
"buckets": ["S3 BUCKET NAME"],
}],
},
opts = pulumi.ResourceOptions(depends_on=[test]))
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/macie2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
test, err := macie2.NewAccount(ctx, "test", nil)
if err != nil {
return err
}
_, err = macie2.NewClassificationJob(ctx, "test", &macie2.ClassificationJobArgs{
JobType: pulumi.String("ONE_TIME"),
Name: pulumi.String("NAME OF THE CLASSIFICATION JOB"),
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{
test,
}))
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var test = new Aws.Macie2.Account("test");
var testClassificationJob = new Aws.Macie2.ClassificationJob("test", new()
{
JobType = "ONE_TIME",
Name = "NAME OF THE CLASSIFICATION JOB",
S3JobDefinition = new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionArgs
{
BucketDefinitions = new[]
{
new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionBucketDefinitionArgs
{
AccountId = "ACCOUNT ID",
Buckets = new[]
{
"S3 BUCKET NAME",
},
},
},
},
}, new CustomResourceOptions
{
DependsOn =
{
test,
},
});
});
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 test = new Account("test");
var testClassificationJob = new ClassificationJob("testClassificationJob", ClassificationJobArgs.builder()
.jobType("ONE_TIME")
.name("NAME OF THE CLASSIFICATION JOB")
.s3JobDefinition(ClassificationJobS3JobDefinitionArgs.builder()
.bucketDefinitions(ClassificationJobS3JobDefinitionBucketDefinitionArgs.builder()
.accountId("ACCOUNT ID")
.buckets("S3 BUCKET NAME")
.build())
.build())
.build(), CustomResourceOptions.builder()
.dependsOn(test)
.build());
}
}
resources:
test:
type: aws:macie2:Account
testClassificationJob:
type: aws:macie2:ClassificationJob
name: test
properties:
jobType: ONE_TIME
name: NAME OF THE CLASSIFICATION JOB
s3JobDefinition:
bucketDefinitions:
- accountId: ACCOUNT ID
buckets:
- S3 BUCKET NAME
options:
dependson:
- ${test}
Create ClassificationJob Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ClassificationJob(name: string, args: ClassificationJobArgs, opts?: CustomResourceOptions);
@overload
def ClassificationJob(resource_name: str,
args: ClassificationJobArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ClassificationJob(resource_name: str,
opts: Optional[ResourceOptions] = None,
job_type: Optional[str] = None,
s3_job_definition: Optional[ClassificationJobS3JobDefinitionArgs] = None,
custom_data_identifier_ids: Optional[Sequence[str]] = None,
description: Optional[str] = None,
initial_run: Optional[bool] = None,
job_status: Optional[str] = None,
name: Optional[str] = None,
name_prefix: Optional[str] = None,
sampling_percentage: Optional[int] = None,
schedule_frequency: Optional[ClassificationJobScheduleFrequencyArgs] = None,
tags: Optional[Mapping[str, str]] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var classificationJobResource = new Aws.Macie2.ClassificationJob("classificationJobResource", new()
{
JobType = "string",
S3JobDefinition = new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionArgs
{
BucketCriteria = new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionBucketCriteriaArgs
{
Excludes = new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionBucketCriteriaExcludesArgs
{
Ands = new[]
{
new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndArgs
{
SimpleCriterion = new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndSimpleCriterionArgs
{
Comparator = "string",
Key = "string",
Values = new[]
{
"string",
},
},
TagCriterion = new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndTagCriterionArgs
{
Comparator = "string",
TagValues = new[]
{
new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndTagCriterionTagValueArgs
{
Key = "string",
Value = "string",
},
},
},
},
},
},
Includes = new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionBucketCriteriaIncludesArgs
{
Ands = new[]
{
new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndArgs
{
SimpleCriterion = new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndSimpleCriterionArgs
{
Comparator = "string",
Key = "string",
Values = new[]
{
"string",
},
},
TagCriterion = new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndTagCriterionArgs
{
Comparator = "string",
TagValues = new[]
{
new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndTagCriterionTagValueArgs
{
Key = "string",
Value = "string",
},
},
},
},
},
},
},
BucketDefinitions = new[]
{
new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionBucketDefinitionArgs
{
AccountId = "string",
Buckets = new[]
{
"string",
},
},
},
Scoping = new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionScopingArgs
{
Excludes = new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionScopingExcludesArgs
{
Ands = new[]
{
new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionScopingExcludesAndArgs
{
SimpleScopeTerm = new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionScopingExcludesAndSimpleScopeTermArgs
{
Comparator = "string",
Key = "string",
Values = new[]
{
"string",
},
},
TagScopeTerm = new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionScopingExcludesAndTagScopeTermArgs
{
Comparator = "string",
Key = "string",
TagValues = new[]
{
new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionScopingExcludesAndTagScopeTermTagValueArgs
{
Key = "string",
Value = "string",
},
},
Target = "string",
},
},
},
},
Includes = new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionScopingIncludesArgs
{
Ands = new[]
{
new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionScopingIncludesAndArgs
{
SimpleScopeTerm = new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionScopingIncludesAndSimpleScopeTermArgs
{
Comparator = "string",
Key = "string",
Values = new[]
{
"string",
},
},
TagScopeTerm = new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionScopingIncludesAndTagScopeTermArgs
{
Comparator = "string",
Key = "string",
TagValues = new[]
{
new Aws.Macie2.Inputs.ClassificationJobS3JobDefinitionScopingIncludesAndTagScopeTermTagValueArgs
{
Key = "string",
Value = "string",
},
},
Target = "string",
},
},
},
},
},
},
CustomDataIdentifierIds = new[]
{
"string",
},
Description = "string",
InitialRun = false,
JobStatus = "string",
Name = "string",
NamePrefix = "string",
SamplingPercentage = 0,
ScheduleFrequency = new Aws.Macie2.Inputs.ClassificationJobScheduleFrequencyArgs
{
DailySchedule = false,
MonthlySchedule = 0,
WeeklySchedule = "string",
},
Tags =
{
{ "string", "string" },
},
});
example, err := macie2.NewClassificationJob(ctx, "classificationJobResource", &macie2.ClassificationJobArgs{
JobType: pulumi.String("string"),
S3JobDefinition: &macie2.ClassificationJobS3JobDefinitionArgs{
BucketCriteria: &macie2.ClassificationJobS3JobDefinitionBucketCriteriaArgs{
Excludes: &macie2.ClassificationJobS3JobDefinitionBucketCriteriaExcludesArgs{
Ands: macie2.ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndArray{
&macie2.ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndArgs{
SimpleCriterion: &macie2.ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndSimpleCriterionArgs{
Comparator: pulumi.String("string"),
Key: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
TagCriterion: &macie2.ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndTagCriterionArgs{
Comparator: pulumi.String("string"),
TagValues: macie2.ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndTagCriterionTagValueArray{
&macie2.ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndTagCriterionTagValueArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
},
},
},
},
Includes: &macie2.ClassificationJobS3JobDefinitionBucketCriteriaIncludesArgs{
Ands: macie2.ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndArray{
&macie2.ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndArgs{
SimpleCriterion: &macie2.ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndSimpleCriterionArgs{
Comparator: pulumi.String("string"),
Key: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
TagCriterion: &macie2.ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndTagCriterionArgs{
Comparator: pulumi.String("string"),
TagValues: macie2.ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndTagCriterionTagValueArray{
&macie2.ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndTagCriterionTagValueArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
},
},
},
},
},
BucketDefinitions: macie2.ClassificationJobS3JobDefinitionBucketDefinitionArray{
&macie2.ClassificationJobS3JobDefinitionBucketDefinitionArgs{
AccountId: pulumi.String("string"),
Buckets: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Scoping: &macie2.ClassificationJobS3JobDefinitionScopingArgs{
Excludes: &macie2.ClassificationJobS3JobDefinitionScopingExcludesArgs{
Ands: macie2.ClassificationJobS3JobDefinitionScopingExcludesAndArray{
&macie2.ClassificationJobS3JobDefinitionScopingExcludesAndArgs{
SimpleScopeTerm: &macie2.ClassificationJobS3JobDefinitionScopingExcludesAndSimpleScopeTermArgs{
Comparator: pulumi.String("string"),
Key: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
TagScopeTerm: &macie2.ClassificationJobS3JobDefinitionScopingExcludesAndTagScopeTermArgs{
Comparator: pulumi.String("string"),
Key: pulumi.String("string"),
TagValues: macie2.ClassificationJobS3JobDefinitionScopingExcludesAndTagScopeTermTagValueArray{
&macie2.ClassificationJobS3JobDefinitionScopingExcludesAndTagScopeTermTagValueArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Target: pulumi.String("string"),
},
},
},
},
Includes: &macie2.ClassificationJobS3JobDefinitionScopingIncludesArgs{
Ands: macie2.ClassificationJobS3JobDefinitionScopingIncludesAndArray{
&macie2.ClassificationJobS3JobDefinitionScopingIncludesAndArgs{
SimpleScopeTerm: &macie2.ClassificationJobS3JobDefinitionScopingIncludesAndSimpleScopeTermArgs{
Comparator: pulumi.String("string"),
Key: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
TagScopeTerm: &macie2.ClassificationJobS3JobDefinitionScopingIncludesAndTagScopeTermArgs{
Comparator: pulumi.String("string"),
Key: pulumi.String("string"),
TagValues: macie2.ClassificationJobS3JobDefinitionScopingIncludesAndTagScopeTermTagValueArray{
&macie2.ClassificationJobS3JobDefinitionScopingIncludesAndTagScopeTermTagValueArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Target: pulumi.String("string"),
},
},
},
},
},
},
CustomDataIdentifierIds: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
InitialRun: pulumi.Bool(false),
JobStatus: pulumi.String("string"),
Name: pulumi.String("string"),
NamePrefix: pulumi.String("string"),
SamplingPercentage: pulumi.Int(0),
ScheduleFrequency: &macie2.ClassificationJobScheduleFrequencyArgs{
DailySchedule: pulumi.Bool(false),
MonthlySchedule: pulumi.Int(0),
WeeklySchedule: pulumi.String("string"),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var classificationJobResource = new ClassificationJob("classificationJobResource", ClassificationJobArgs.builder()
.jobType("string")
.s3JobDefinition(ClassificationJobS3JobDefinitionArgs.builder()
.bucketCriteria(ClassificationJobS3JobDefinitionBucketCriteriaArgs.builder()
.excludes(ClassificationJobS3JobDefinitionBucketCriteriaExcludesArgs.builder()
.ands(ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndArgs.builder()
.simpleCriterion(ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndSimpleCriterionArgs.builder()
.comparator("string")
.key("string")
.values("string")
.build())
.tagCriterion(ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndTagCriterionArgs.builder()
.comparator("string")
.tagValues(ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndTagCriterionTagValueArgs.builder()
.key("string")
.value("string")
.build())
.build())
.build())
.build())
.includes(ClassificationJobS3JobDefinitionBucketCriteriaIncludesArgs.builder()
.ands(ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndArgs.builder()
.simpleCriterion(ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndSimpleCriterionArgs.builder()
.comparator("string")
.key("string")
.values("string")
.build())
.tagCriterion(ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndTagCriterionArgs.builder()
.comparator("string")
.tagValues(ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndTagCriterionTagValueArgs.builder()
.key("string")
.value("string")
.build())
.build())
.build())
.build())
.build())
.bucketDefinitions(ClassificationJobS3JobDefinitionBucketDefinitionArgs.builder()
.accountId("string")
.buckets("string")
.build())
.scoping(ClassificationJobS3JobDefinitionScopingArgs.builder()
.excludes(ClassificationJobS3JobDefinitionScopingExcludesArgs.builder()
.ands(ClassificationJobS3JobDefinitionScopingExcludesAndArgs.builder()
.simpleScopeTerm(ClassificationJobS3JobDefinitionScopingExcludesAndSimpleScopeTermArgs.builder()
.comparator("string")
.key("string")
.values("string")
.build())
.tagScopeTerm(ClassificationJobS3JobDefinitionScopingExcludesAndTagScopeTermArgs.builder()
.comparator("string")
.key("string")
.tagValues(ClassificationJobS3JobDefinitionScopingExcludesAndTagScopeTermTagValueArgs.builder()
.key("string")
.value("string")
.build())
.target("string")
.build())
.build())
.build())
.includes(ClassificationJobS3JobDefinitionScopingIncludesArgs.builder()
.ands(ClassificationJobS3JobDefinitionScopingIncludesAndArgs.builder()
.simpleScopeTerm(ClassificationJobS3JobDefinitionScopingIncludesAndSimpleScopeTermArgs.builder()
.comparator("string")
.key("string")
.values("string")
.build())
.tagScopeTerm(ClassificationJobS3JobDefinitionScopingIncludesAndTagScopeTermArgs.builder()
.comparator("string")
.key("string")
.tagValues(ClassificationJobS3JobDefinitionScopingIncludesAndTagScopeTermTagValueArgs.builder()
.key("string")
.value("string")
.build())
.target("string")
.build())
.build())
.build())
.build())
.build())
.customDataIdentifierIds("string")
.description("string")
.initialRun(false)
.jobStatus("string")
.name("string")
.namePrefix("string")
.samplingPercentage(0)
.scheduleFrequency(ClassificationJobScheduleFrequencyArgs.builder()
.dailySchedule(false)
.monthlySchedule(0)
.weeklySchedule("string")
.build())
.tags(Map.of("string", "string"))
.build());
classification_job_resource = aws.macie2.ClassificationJob("classificationJobResource",
job_type="string",
s3_job_definition={
"bucket_criteria": {
"excludes": {
"ands": [{
"simple_criterion": {
"comparator": "string",
"key": "string",
"values": ["string"],
},
"tag_criterion": {
"comparator": "string",
"tag_values": [{
"key": "string",
"value": "string",
}],
},
}],
},
"includes": {
"ands": [{
"simple_criterion": {
"comparator": "string",
"key": "string",
"values": ["string"],
},
"tag_criterion": {
"comparator": "string",
"tag_values": [{
"key": "string",
"value": "string",
}],
},
}],
},
},
"bucket_definitions": [{
"account_id": "string",
"buckets": ["string"],
}],
"scoping": {
"excludes": {
"ands": [{
"simple_scope_term": {
"comparator": "string",
"key": "string",
"values": ["string"],
},
"tag_scope_term": {
"comparator": "string",
"key": "string",
"tag_values": [{
"key": "string",
"value": "string",
}],
"target": "string",
},
}],
},
"includes": {
"ands": [{
"simple_scope_term": {
"comparator": "string",
"key": "string",
"values": ["string"],
},
"tag_scope_term": {
"comparator": "string",
"key": "string",
"tag_values": [{
"key": "string",
"value": "string",
}],
"target": "string",
},
}],
},
},
},
custom_data_identifier_ids=["string"],
description="string",
initial_run=False,
job_status="string",
name="string",
name_prefix="string",
sampling_percentage=0,
schedule_frequency={
"daily_schedule": False,
"monthly_schedule": 0,
"weekly_schedule": "string",
},
tags={
"string": "string",
})
const classificationJobResource = new aws.macie2.ClassificationJob("classificationJobResource", {
jobType: "string",
s3JobDefinition: {
bucketCriteria: {
excludes: {
ands: [{
simpleCriterion: {
comparator: "string",
key: "string",
values: ["string"],
},
tagCriterion: {
comparator: "string",
tagValues: [{
key: "string",
value: "string",
}],
},
}],
},
includes: {
ands: [{
simpleCriterion: {
comparator: "string",
key: "string",
values: ["string"],
},
tagCriterion: {
comparator: "string",
tagValues: [{
key: "string",
value: "string",
}],
},
}],
},
},
bucketDefinitions: [{
accountId: "string",
buckets: ["string"],
}],
scoping: {
excludes: {
ands: [{
simpleScopeTerm: {
comparator: "string",
key: "string",
values: ["string"],
},
tagScopeTerm: {
comparator: "string",
key: "string",
tagValues: [{
key: "string",
value: "string",
}],
target: "string",
},
}],
},
includes: {
ands: [{
simpleScopeTerm: {
comparator: "string",
key: "string",
values: ["string"],
},
tagScopeTerm: {
comparator: "string",
key: "string",
tagValues: [{
key: "string",
value: "string",
}],
target: "string",
},
}],
},
},
},
customDataIdentifierIds: ["string"],
description: "string",
initialRun: false,
jobStatus: "string",
name: "string",
namePrefix: "string",
samplingPercentage: 0,
scheduleFrequency: {
dailySchedule: false,
monthlySchedule: 0,
weeklySchedule: "string",
},
tags: {
string: "string",
},
});
type: aws:macie2:ClassificationJob
properties:
customDataIdentifierIds:
- string
description: string
initialRun: false
jobStatus: string
jobType: string
name: string
namePrefix: string
s3JobDefinition:
bucketCriteria:
excludes:
ands:
- simpleCriterion:
comparator: string
key: string
values:
- string
tagCriterion:
comparator: string
tagValues:
- key: string
value: string
includes:
ands:
- simpleCriterion:
comparator: string
key: string
values:
- string
tagCriterion:
comparator: string
tagValues:
- key: string
value: string
bucketDefinitions:
- accountId: string
buckets:
- string
scoping:
excludes:
ands:
- simpleScopeTerm:
comparator: string
key: string
values:
- string
tagScopeTerm:
comparator: string
key: string
tagValues:
- key: string
value: string
target: string
includes:
ands:
- simpleScopeTerm:
comparator: string
key: string
values:
- string
tagScopeTerm:
comparator: string
key: string
tagValues:
- key: string
value: string
target: string
samplingPercentage: 0
scheduleFrequency:
dailySchedule: false
monthlySchedule: 0
weeklySchedule: string
tags:
string: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ClassificationJob resource accepts the following input properties:
- Job
Type 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 theschedule_frequency
property.SCHEDULED
- Run the job on a daily, weekly, or monthly basis. If you specify this value, use theschedule_frequency
property to define the recurrence pattern for the job. - S3Job
Definition ClassificationJob S3Job Definition - The S3 buckets that contain the objects to analyze, and the scope of that analysis. (documented below)
- Custom
Data List<string>Identifier Ids - 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.
- Initial
Run bool - Specifies whether to analyze all existing, eligible objects immediately after the job is created.
- Job
Status string - The status for the job. Valid values are:
CANCELLED
,RUNNING
andUSER_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
. - Name
Prefix string - 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 ClassificationJob Schedule Frequency - 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 toONE_TIME
. (documented below) - 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.
- Job
Type 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 theschedule_frequency
property.SCHEDULED
- Run the job on a daily, weekly, or monthly basis. If you specify this value, use theschedule_frequency
property to define the recurrence pattern for the job. - S3Job
Definition ClassificationJob S3Job Definition Args - The S3 buckets that contain the objects to analyze, and the scope of that analysis. (documented below)
- Custom
Data []stringIdentifier Ids - 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.
- Initial
Run bool - Specifies whether to analyze all existing, eligible objects immediately after the job is created.
- Job
Status string - The status for the job. Valid values are:
CANCELLED
,RUNNING
andUSER_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
. - Name
Prefix string - 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 ClassificationJob Schedule Frequency Args - 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 toONE_TIME
. (documented below) - 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.
- job
Type 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 theschedule_frequency
property.SCHEDULED
- Run the job on a daily, weekly, or monthly basis. If you specify this value, use theschedule_frequency
property to define the recurrence pattern for the job. - s3Job
Definition ClassificationJob S3Job Definition - The S3 buckets that contain the objects to analyze, and the scope of that analysis. (documented below)
- custom
Data List<String>Identifier Ids - 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.
- initial
Run Boolean - Specifies whether to analyze all existing, eligible objects immediately after the job is created.
- job
Status String - The status for the job. Valid values are:
CANCELLED
,RUNNING
andUSER_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
. - name
Prefix String - Creates a unique name beginning with the specified prefix. Conflicts with
name
. - sampling
Percentage 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.
- schedule
Frequency ClassificationJob Schedule Frequency - 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 toONE_TIME
. (documented below) - 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.
- job
Type 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 theschedule_frequency
property.SCHEDULED
- Run the job on a daily, weekly, or monthly basis. If you specify this value, use theschedule_frequency
property to define the recurrence pattern for the job. - s3Job
Definition ClassificationJob S3Job Definition - The S3 buckets that contain the objects to analyze, and the scope of that analysis. (documented below)
- custom
Data string[]Identifier Ids - 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.
- initial
Run boolean - Specifies whether to analyze all existing, eligible objects immediately after the job is created.
- job
Status string - The status for the job. Valid values are:
CANCELLED
,RUNNING
andUSER_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
. - name
Prefix string - Creates a unique name beginning with the specified prefix. Conflicts with
name
. - sampling
Percentage 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.
- schedule
Frequency ClassificationJob Schedule Frequency - 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 toONE_TIME
. (documented below) - {[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 theschedule_frequency
property.SCHEDULED
- Run the job on a daily, weekly, or monthly basis. If you specify this value, use theschedule_frequency
property to define the recurrence pattern for the job. - s3_
job_ Classificationdefinition Job S3Job Definition Args - The S3 buckets that contain the objects to analyze, and the scope of that analysis. (documented below)
- custom_
data_ Sequence[str]identifier_ ids - 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
andUSER_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 ClassificationJob Schedule Frequency Args - 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 toONE_TIME
. (documented below) - 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.
- job
Type 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 theschedule_frequency
property.SCHEDULED
- Run the job on a daily, weekly, or monthly basis. If you specify this value, use theschedule_frequency
property to define the recurrence pattern for the job. - s3Job
Definition Property Map - The S3 buckets that contain the objects to analyze, and the scope of that analysis. (documented below)
- custom
Data List<String>Identifier Ids - 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.
- initial
Run Boolean - Specifies whether to analyze all existing, eligible objects immediately after the job is created.
- job
Status String - The status for the job. Valid values are:
CANCELLED
,RUNNING
andUSER_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
. - name
Prefix String - Creates a unique name beginning with the specified prefix. Conflicts with
name
. - sampling
Percentage 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.
- schedule
Frequency 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 toONE_TIME
. (documented below) - 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:
- Created
At 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.
- Job
Arn string - Job
Id string - Dictionary<string, string>
- User
Paused List<ClassificationDetails Job User Paused Detail> - 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 canceled if it isn't resumed. This value is present only if the value forjob-status
isUSER_PAUSED
.
- Created
At 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.
- Job
Arn string - Job
Id string - map[string]string
- User
Paused []ClassificationDetails Job User Paused Detail - 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 canceled if it isn't resumed. This value is present only if the value forjob-status
isUSER_PAUSED
.
- created
At 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.
- job
Arn String - job
Id String - Map<String,String>
- user
Paused List<ClassificationDetails Job User Paused Detail> - 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 canceled if it isn't resumed. This value is present only if the value forjob-status
isUSER_PAUSED
.
- created
At 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.
- job
Arn string - job
Id string - {[key: string]: string}
- user
Paused ClassificationDetails Job User Paused Detail[] - 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 canceled if it isn't resumed. This value is present only if the value forjob-status
isUSER_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 - Mapping[str, str]
- user_
paused_ Sequence[Classificationdetails Job User Paused Detail] - 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 canceled if it isn't resumed. This value is present only if the value forjob-status
isUSER_PAUSED
.
- created
At 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.
- job
Arn String - job
Id String - Map<String>
- user
Paused List<Property Map>Details - 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 canceled if it isn't resumed. This value is present only if the value forjob-status
isUSER_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.
- Created
At string - The date and time, in UTC and extended RFC 3339 format, when the job was created.
- Custom
Data List<string>Identifier Ids - 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.
- Initial
Run bool - Specifies whether to analyze all existing, eligible objects immediately after the job is created.
- Job
Arn string - Job
Id string - Job
Status string - The status for the job. Valid values are:
CANCELLED
,RUNNING
andUSER_PAUSED
- Job
Type 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 theschedule_frequency
property.SCHEDULED
- Run the job on a daily, weekly, or monthly basis. If you specify this value, use theschedule_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
. - Name
Prefix string - Creates a unique name beginning with the specified prefix. Conflicts with
name
. - S3Job
Definition ClassificationJob S3Job Definition - 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 ClassificationJob Schedule Frequency - 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 toONE_TIME
. (documented below) - 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.
- Dictionary<string, string>
- User
Paused List<ClassificationDetails Job User Paused Detail> - 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 canceled if it isn't resumed. This value is present only if the value forjob-status
isUSER_PAUSED
.
- Created
At string - The date and time, in UTC and extended RFC 3339 format, when the job was created.
- Custom
Data []stringIdentifier Ids - 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.
- Initial
Run bool - Specifies whether to analyze all existing, eligible objects immediately after the job is created.
- Job
Arn string - Job
Id string - Job
Status string - The status for the job. Valid values are:
CANCELLED
,RUNNING
andUSER_PAUSED
- Job
Type 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 theschedule_frequency
property.SCHEDULED
- Run the job on a daily, weekly, or monthly basis. If you specify this value, use theschedule_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
. - Name
Prefix string - Creates a unique name beginning with the specified prefix. Conflicts with
name
. - S3Job
Definition ClassificationJob S3Job Definition Args - 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 ClassificationJob Schedule Frequency Args - 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 toONE_TIME
. (documented below) - 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.
- map[string]string
- User
Paused []ClassificationDetails Job User Paused Detail Args - 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 canceled if it isn't resumed. This value is present only if the value forjob-status
isUSER_PAUSED
.
- created
At String - The date and time, in UTC and extended RFC 3339 format, when the job was created.
- custom
Data List<String>Identifier Ids - 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.
- initial
Run Boolean - Specifies whether to analyze all existing, eligible objects immediately after the job is created.
- job
Arn String - job
Id String - job
Status String - The status for the job. Valid values are:
CANCELLED
,RUNNING
andUSER_PAUSED
- job
Type 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 theschedule_frequency
property.SCHEDULED
- Run the job on a daily, weekly, or monthly basis. If you specify this value, use theschedule_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
. - name
Prefix String - Creates a unique name beginning with the specified prefix. Conflicts with
name
. - s3Job
Definition ClassificationJob S3Job Definition - The S3 buckets that contain the objects to analyze, and the scope of that analysis. (documented below)
- sampling
Percentage 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.
- schedule
Frequency ClassificationJob Schedule Frequency - 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 toONE_TIME
. (documented below) - 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.
- Map<String,String>
- user
Paused List<ClassificationDetails Job User Paused Detail> - 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 canceled if it isn't resumed. This value is present only if the value forjob-status
isUSER_PAUSED
.
- created
At string - The date and time, in UTC and extended RFC 3339 format, when the job was created.
- custom
Data string[]Identifier Ids - 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.
- initial
Run boolean - Specifies whether to analyze all existing, eligible objects immediately after the job is created.
- job
Arn string - job
Id string - job
Status string - The status for the job. Valid values are:
CANCELLED
,RUNNING
andUSER_PAUSED
- job
Type 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 theschedule_frequency
property.SCHEDULED
- Run the job on a daily, weekly, or monthly basis. If you specify this value, use theschedule_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
. - name
Prefix string - Creates a unique name beginning with the specified prefix. Conflicts with
name
. - s3Job
Definition ClassificationJob S3Job Definition - The S3 buckets that contain the objects to analyze, and the scope of that analysis. (documented below)
- sampling
Percentage 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.
- schedule
Frequency ClassificationJob Schedule Frequency - 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 toONE_TIME
. (documented below) - {[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.
- {[key: string]: string}
- user
Paused ClassificationDetails Job User Paused Detail[] - 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 canceled if it isn't resumed. This value is present only if the value forjob-status
isUSER_PAUSED
.
- created_
at str - The date and time, in UTC and extended RFC 3339 format, when the job was created.
- custom_
data_ Sequence[str]identifier_ ids - 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
andUSER_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 theschedule_frequency
property.SCHEDULED
- Run the job on a daily, weekly, or monthly basis. If you specify this value, use theschedule_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_ Classificationdefinition Job S3Job Definition Args - 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 ClassificationJob Schedule Frequency Args - 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 toONE_TIME
. (documented below) - 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.
- Mapping[str, str]
- user_
paused_ Sequence[Classificationdetails Job User Paused Detail Args] - 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 canceled if it isn't resumed. This value is present only if the value forjob-status
isUSER_PAUSED
.
- created
At String - The date and time, in UTC and extended RFC 3339 format, when the job was created.
- custom
Data List<String>Identifier Ids - 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.
- initial
Run Boolean - Specifies whether to analyze all existing, eligible objects immediately after the job is created.
- job
Arn String - job
Id String - job
Status String - The status for the job. Valid values are:
CANCELLED
,RUNNING
andUSER_PAUSED
- job
Type 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 theschedule_frequency
property.SCHEDULED
- Run the job on a daily, weekly, or monthly basis. If you specify this value, use theschedule_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
. - name
Prefix String - Creates a unique name beginning with the specified prefix. Conflicts with
name
. - s3Job
Definition Property Map - The S3 buckets that contain the objects to analyze, and the scope of that analysis. (documented below)
- sampling
Percentage 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.
- schedule
Frequency 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 toONE_TIME
. (documented below) - 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.
- Map<String>
- user
Paused List<Property Map>Details - 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 canceled if it isn't resumed. This value is present only if the value forjob-status
isUSER_PAUSED
.
Supporting Types
ClassificationJobS3JobDefinition, ClassificationJobS3JobDefinitionArgs
- Bucket
Criteria ClassificationJob S3Job Definition Bucket Criteria - 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 List<ClassificationJob S3Job Definition Bucket Definition> - 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
Classification
Job S3Job Definition Scoping - The property- and tag-based conditions that determine which objects to include or exclude from the analysis. (documented below)
- Bucket
Criteria ClassificationJob S3Job Definition Bucket Criteria - 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 []ClassificationJob S3Job Definition Bucket Definition - 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
Classification
Job S3Job Definition Scoping - The property- and tag-based conditions that determine which objects to include or exclude from the analysis. (documented below)
- bucket
Criteria ClassificationJob S3Job Definition Bucket Criteria - 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 List<ClassificationJob S3Job Definition Bucket Definition> - 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
Classification
Job S3Job Definition Scoping - The property- and tag-based conditions that determine which objects to include or exclude from the analysis. (documented below)
- bucket
Criteria ClassificationJob S3Job Definition Bucket Criteria - 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 ClassificationJob S3Job Definition Bucket Definition[] - 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
Classification
Job S3Job Definition Scoping - The property- and tag-based conditions that determine which objects to include or exclude from the analysis. (documented below)
- bucket_
criteria ClassificationJob S3Job Definition Bucket Criteria - 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[ClassificationJob S3Job Definition Bucket Definition] - 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
Classification
Job S3Job Definition Scoping - The property- and tag-based conditions that determine which objects to include or exclude from the analysis. (documented below)
- bucket
Criteria 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) - bucket
Definitions 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, ClassificationJobS3JobDefinitionBucketCriteriaArgs
- Excludes
Classification
Job S3Job Definition Bucket Criteria Excludes - The property- or tag-based conditions that determine which S3 buckets to exclude from the analysis. (documented below)
- Includes
Classification
Job S3Job Definition Bucket Criteria Includes - The property- or tag-based conditions that determine which S3 buckets to include in the analysis. (documented below)
- Excludes
Classification
Job S3Job Definition Bucket Criteria Excludes - The property- or tag-based conditions that determine which S3 buckets to exclude from the analysis. (documented below)
- Includes
Classification
Job S3Job Definition Bucket Criteria Includes - The property- or tag-based conditions that determine which S3 buckets to include in the analysis. (documented below)
- excludes
Classification
Job S3Job Definition Bucket Criteria Excludes - The property- or tag-based conditions that determine which S3 buckets to exclude from the analysis. (documented below)
- includes
Classification
Job S3Job Definition Bucket Criteria Includes - The property- or tag-based conditions that determine which S3 buckets to include in the analysis. (documented below)
- excludes
Classification
Job S3Job Definition Bucket Criteria Excludes - The property- or tag-based conditions that determine which S3 buckets to exclude from the analysis. (documented below)
- includes
Classification
Job S3Job Definition Bucket Criteria Includes - The property- or tag-based conditions that determine which S3 buckets to include in the analysis. (documented below)
- excludes
Classification
Job S3Job Definition Bucket Criteria Excludes - The property- or tag-based conditions that determine which S3 buckets to exclude from the analysis. (documented below)
- includes
Classification
Job S3Job Definition Bucket Criteria Includes - 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, ClassificationJobS3JobDefinitionBucketCriteriaExcludesArgs
- Ands
List<Classification
Job S3Job Definition Bucket Criteria Excludes And> - An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)
- Ands
[]Classification
Job S3Job Definition Bucket Criteria Excludes And - An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)
- ands
List<Classification
Job S3Job Definition Bucket Criteria Excludes And> - An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)
- ands
Classification
Job S3Job Definition Bucket Criteria Excludes And[] - An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)
- ands
Sequence[Classification
Job S3Job Definition Bucket Criteria Excludes And] - 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, ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndArgs
- Simple
Criterion ClassificationJob S3Job Definition Bucket Criteria Excludes And Simple Criterion - 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 ClassificationJob S3Job Definition Bucket Criteria Excludes And Tag Criterion - 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 ClassificationJob S3Job Definition Bucket Criteria Excludes And Simple Criterion - 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 ClassificationJob S3Job Definition Bucket Criteria Excludes And Tag Criterion - 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 ClassificationJob S3Job Definition Bucket Criteria Excludes And Simple Criterion - 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 ClassificationJob S3Job Definition Bucket Criteria Excludes And Tag Criterion - 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 ClassificationJob S3Job Definition Bucket Criteria Excludes And Simple Criterion - 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 ClassificationJob S3Job Definition Bucket Criteria Excludes And Tag Criterion - 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 ClassificationJob S3Job Definition Bucket Criteria Excludes And Simple Criterion - 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 ClassificationJob S3Job Definition Bucket Criteria Excludes And Tag Criterion - 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 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)
- tag
Criterion 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, ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndSimpleCriterionArgs
- 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, ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndTagCriterionArgs
- Comparator string
- The operator to use in the condition. Valid combination and values are available in the AWS Documentation
- Tag
Values List<ClassificationJob S3Job Definition Bucket Criteria Excludes And Tag Criterion Tag Value> - 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
- Tag
Values []ClassificationJob S3Job Definition Bucket Criteria Excludes And Tag Criterion Tag Value - 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
- tag
Values List<ClassificationJob S3Job Definition Bucket Criteria Excludes And Tag Criterion Tag Value> - 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
- tag
Values ClassificationJob S3Job Definition Bucket Criteria Excludes And Tag Criterion Tag Value[] - 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[ClassificationJob S3Job Definition Bucket Criteria Excludes And Tag Criterion Tag Value] - 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
- tag
Values List<Property Map> - The tag key and value pairs to use in the condition. One or more blocks are allowed. (documented below)
ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndTagCriterionTagValue, ClassificationJobS3JobDefinitionBucketCriteriaExcludesAndTagCriterionTagValueArgs
ClassificationJobS3JobDefinitionBucketCriteriaIncludes, ClassificationJobS3JobDefinitionBucketCriteriaIncludesArgs
- Ands
List<Classification
Job S3Job Definition Bucket Criteria Includes And> - An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)
- Ands
[]Classification
Job S3Job Definition Bucket Criteria Includes And - An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)
- ands
List<Classification
Job S3Job Definition Bucket Criteria Includes And> - An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)
- ands
Classification
Job S3Job Definition Bucket Criteria Includes And[] - An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)
- ands
Sequence[Classification
Job S3Job Definition Bucket Criteria Includes And] - 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)
ClassificationJobS3JobDefinitionBucketCriteriaIncludesAnd, ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndArgs
- Simple
Criterion ClassificationJob S3Job Definition Bucket Criteria Includes And Simple Criterion - 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 ClassificationJob S3Job Definition Bucket Criteria Includes And Tag Criterion - 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 ClassificationJob S3Job Definition Bucket Criteria Includes And Simple Criterion - 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 ClassificationJob S3Job Definition Bucket Criteria Includes And Tag Criterion - 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 ClassificationJob S3Job Definition Bucket Criteria Includes And Simple Criterion - 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 ClassificationJob S3Job Definition Bucket Criteria Includes And Tag Criterion - 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 ClassificationJob S3Job Definition Bucket Criteria Includes And Simple Criterion - 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 ClassificationJob S3Job Definition Bucket Criteria Includes And Tag Criterion - 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 ClassificationJob S3Job Definition Bucket Criteria Includes And Simple Criterion - 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 ClassificationJob S3Job Definition Bucket Criteria Includes And Tag Criterion - 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 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)
- tag
Criterion 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, ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndSimpleCriterionArgs
- 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, ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndTagCriterionArgs
- Comparator string
- The operator to use in the condition. Valid combination and values are available in the AWS Documentation
- Tag
Values List<ClassificationJob S3Job Definition Bucket Criteria Includes And Tag Criterion Tag Value> - 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
- Tag
Values []ClassificationJob S3Job Definition Bucket Criteria Includes And Tag Criterion Tag Value - 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
- tag
Values List<ClassificationJob S3Job Definition Bucket Criteria Includes And Tag Criterion Tag Value> - 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
- tag
Values ClassificationJob S3Job Definition Bucket Criteria Includes And Tag Criterion Tag Value[] - 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[ClassificationJob S3Job Definition Bucket Criteria Includes And Tag Criterion Tag Value] - 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
- tag
Values List<Property Map> - The tag key and value pairs to use in the condition. One or more blocks are allowed. (documented below)
ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndTagCriterionTagValue, ClassificationJobS3JobDefinitionBucketCriteriaIncludesAndTagCriterionTagValueArgs
ClassificationJobS3JobDefinitionBucketDefinition, ClassificationJobS3JobDefinitionBucketDefinitionArgs
- 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.
ClassificationJobS3JobDefinitionScoping, ClassificationJobS3JobDefinitionScopingArgs
- Excludes
Classification
Job S3Job Definition Scoping Excludes - The property- or tag-based conditions that determine which objects to exclude from the analysis. (documented below)
- Includes
Classification
Job S3Job Definition Scoping Includes - The property- or tag-based conditions that determine which objects to include in the analysis. (documented below)
- Excludes
Classification
Job S3Job Definition Scoping Excludes - The property- or tag-based conditions that determine which objects to exclude from the analysis. (documented below)
- Includes
Classification
Job S3Job Definition Scoping Includes - The property- or tag-based conditions that determine which objects to include in the analysis. (documented below)
- excludes
Classification
Job S3Job Definition Scoping Excludes - The property- or tag-based conditions that determine which objects to exclude from the analysis. (documented below)
- includes
Classification
Job S3Job Definition Scoping Includes - The property- or tag-based conditions that determine which objects to include in the analysis. (documented below)
- excludes
Classification
Job S3Job Definition Scoping Excludes - The property- or tag-based conditions that determine which objects to exclude from the analysis. (documented below)
- includes
Classification
Job S3Job Definition Scoping Includes - The property- or tag-based conditions that determine which objects to include in the analysis. (documented below)
- excludes
Classification
Job S3Job Definition Scoping Excludes - The property- or tag-based conditions that determine which objects to exclude from the analysis. (documented below)
- includes
Classification
Job S3Job Definition Scoping Includes - 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, ClassificationJobS3JobDefinitionScopingExcludesArgs
- Ands
List<Classification
Job S3Job Definition Scoping Excludes And> - An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)
- Ands
[]Classification
Job S3Job Definition Scoping Excludes And - An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)
- ands
List<Classification
Job S3Job Definition Scoping Excludes And> - An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)
- ands
Classification
Job S3Job Definition Scoping Excludes And[] - An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)
- ands
Sequence[Classification
Job S3Job Definition Scoping Excludes And] - 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, ClassificationJobS3JobDefinitionScopingExcludesAndArgs
- Simple
Scope ClassificationTerm Job S3Job Definition Scoping Excludes And Simple Scope Term - 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)
- Classification
Job S3Job Definition Scoping Excludes And Tag Scope Term - 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 ClassificationTerm Job S3Job Definition Scoping Excludes And Simple Scope Term - 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)
- Classification
Job S3Job Definition Scoping Excludes And Tag Scope Term - 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 ClassificationTerm Job S3Job Definition Scoping Excludes And Simple Scope Term - 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)
- Classification
Job S3Job Definition Scoping Excludes And Tag Scope Term - 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 ClassificationTerm Job S3Job Definition Scoping Excludes And Simple Scope Term - 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)
- Classification
Job S3Job Definition Scoping Excludes And Tag Scope Term - 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_ Classificationterm Job S3Job Definition Scoping Excludes And Simple Scope Term - 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_ Classificationterm Job S3Job Definition Scoping Excludes And Tag Scope Term - 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 Property MapTerm - 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)
- 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, ClassificationJobS3JobDefinitionScopingExcludesAndSimpleScopeTermArgs
- 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, ClassificationJobS3JobDefinitionScopingExcludesAndTagScopeTermArgs
- 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
. - Tag
Values List<ClassificationJob S3Job Definition Scoping Excludes And Tag Scope Term Tag Value> - 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
. - Tag
Values []ClassificationJob S3Job Definition Scoping Excludes And Tag Scope Term Tag Value - 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
. - tag
Values List<ClassificationJob S3Job Definition Scoping Excludes And Tag Scope Term Tag Value> - 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
. - tag
Values ClassificationJob S3Job Definition Scoping Excludes And Tag Scope Term Tag Value[] - 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[ClassificationJob S3Job Definition Scoping Excludes And Tag Scope Term Tag Value] - 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
. - tag
Values 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, ClassificationJobS3JobDefinitionScopingExcludesAndTagScopeTermTagValueArgs
ClassificationJobS3JobDefinitionScopingIncludes, ClassificationJobS3JobDefinitionScopingIncludesArgs
- Ands
List<Classification
Job S3Job Definition Scoping Includes And> - An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)
- Ands
[]Classification
Job S3Job Definition Scoping Includes And - An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)
- ands
List<Classification
Job S3Job Definition Scoping Includes And> - An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)
- ands
Classification
Job S3Job Definition Scoping Includes And[] - An array of conditions, one for each condition that determines which objects to include or exclude from the job. (documented below)
- ands
Sequence[Classification
Job S3Job Definition Scoping Includes And] - 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)
ClassificationJobS3JobDefinitionScopingIncludesAnd, ClassificationJobS3JobDefinitionScopingIncludesAndArgs
- Simple
Scope ClassificationTerm Job S3Job Definition Scoping Includes And Simple Scope Term - 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)
- Classification
Job S3Job Definition Scoping Includes And Tag Scope Term - 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 ClassificationTerm Job S3Job Definition Scoping Includes And Simple Scope Term - 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)
- Classification
Job S3Job Definition Scoping Includes And Tag Scope Term - 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 ClassificationTerm Job S3Job Definition Scoping Includes And Simple Scope Term - 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)
- Classification
Job S3Job Definition Scoping Includes And Tag Scope Term - 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 ClassificationTerm Job S3Job Definition Scoping Includes And Simple Scope Term - 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)
- Classification
Job S3Job Definition Scoping Includes And Tag Scope Term - 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_ Classificationterm Job S3Job Definition Scoping Includes And Simple Scope Term - 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_ Classificationterm Job S3Job Definition Scoping Includes And Tag Scope Term - 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 Property MapTerm - 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)
- 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, ClassificationJobS3JobDefinitionScopingIncludesAndSimpleScopeTermArgs
- 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, ClassificationJobS3JobDefinitionScopingIncludesAndTagScopeTermArgs
- 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
. - Tag
Values List<ClassificationJob S3Job Definition Scoping Includes And Tag Scope Term Tag Value> - 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
. - Tag
Values []ClassificationJob S3Job Definition Scoping Includes And Tag Scope Term Tag Value - 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
. - tag
Values List<ClassificationJob S3Job Definition Scoping Includes And Tag Scope Term Tag Value> - 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
. - tag
Values ClassificationJob S3Job Definition Scoping Includes And Tag Scope Term Tag Value[] - 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[ClassificationJob S3Job Definition Scoping Includes And Tag Scope Term Tag Value] - 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
. - tag
Values 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, ClassificationJobS3JobDefinitionScopingIncludesAndTagScopeTermTagValueArgs
ClassificationJobScheduleFrequency, ClassificationJobScheduleFrequencyArgs
- 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 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 string - Specifies a weekly recurrence pattern for running the job.
- daily
Schedule Boolean - Specifies a daily recurrence pattern for running the job.
- monthly
Schedule Integer - Specifies a monthly recurrence pattern for running the job.
- weekly
Schedule String - Specifies a weekly recurrence pattern for running the job.
- daily
Schedule boolean - Specifies a daily recurrence pattern for running the job.
- monthly
Schedule number - Specifies a monthly recurrence pattern for running the job.
- weekly
Schedule 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.
- daily
Schedule Boolean - Specifies a daily recurrence pattern for running the job.
- monthly
Schedule Number - Specifies a monthly recurrence pattern for running the job.
- weekly
Schedule String - Specifies a weekly recurrence pattern for running the job.
ClassificationJobUserPausedDetail, ClassificationJobUserPausedDetailArgs
- Job
Expires stringAt - Job
Imminent stringExpiration Health Event Arn - Job
Paused stringAt
- Job
Expires stringAt - Job
Imminent stringExpiration Health Event Arn - Job
Paused stringAt
- job
Expires StringAt - job
Imminent StringExpiration Health Event Arn - job
Paused StringAt
- job
Expires stringAt - job
Imminent stringExpiration Health Event Arn - job
Paused stringAt
- job
Expires StringAt - job
Imminent StringExpiration Health Event Arn - job
Paused StringAt
Import
Using pulumi import
, import aws_macie2_classification_job
using the id. For example:
$ pulumi import aws:macie2/classificationJob:ClassificationJob example abcd1
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.