NAME

Paws::Macie2::CreateClassificationJob - Arguments for method CreateClassificationJob on Paws::Macie2

DESCRIPTION

This class represents the parameters used for calling the method CreateClassificationJob on the Amazon Macie 2 service. Use the attributes of this class as arguments to method CreateClassificationJob.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateClassificationJob.

SYNOPSIS

    my $macie2 = Paws->service('Macie2');
    my $CreateClassificationJobResponse = $macie2->CreateClassificationJob(
      ClientToken     => 'My__string',
      JobType         => 'ONE_TIME',
      Name            => 'My__string',
      S3JobDefinition => {
        BucketCriteria => {
          Excludes => {
            And => [
              {
                SimpleCriterion => {
                  Comparator => 'EQ'
                  , # values: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH; OPTIONAL
                  Key => 'ACCOUNT_ID'
                  , # values: ACCOUNT_ID, S3_BUCKET_NAME, S3_BUCKET_EFFECTIVE_PERMISSION, S3_BUCKET_SHARED_ACCESS; OPTIONAL
                  Values => [ 'My__string', ... ],    # OPTIONAL
                },    # OPTIONAL
                TagCriterion => {
                  Comparator => 'EQ'
                  , # values: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH; OPTIONAL
                  TagValues => [
                    {
                      Key   => 'My__string',
                      Value => 'My__string',
                    },
                    ...
                  ],    # OPTIONAL
                },    # OPTIONAL
              },
              ...
            ],    # OPTIONAL
          },    # OPTIONAL
          Includes => {
            And => [
              {
                SimpleCriterion => {
                  Comparator => 'EQ'
                  , # values: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH; OPTIONAL
                  Key => 'ACCOUNT_ID'
                  , # values: ACCOUNT_ID, S3_BUCKET_NAME, S3_BUCKET_EFFECTIVE_PERMISSION, S3_BUCKET_SHARED_ACCESS; OPTIONAL
                  Values => [ 'My__string', ... ],    # OPTIONAL
                },    # OPTIONAL
                TagCriterion => {
                  Comparator => 'EQ'
                  , # values: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH; OPTIONAL
                  TagValues => [
                    {
                      Key   => 'My__string',
                      Value => 'My__string',
                    },
                    ...
                  ],    # OPTIONAL
                },    # OPTIONAL
              },
              ...
            ],    # OPTIONAL
          },    # OPTIONAL
        },    # OPTIONAL
        BucketDefinitions => [
          {
            AccountId => 'My__string',
            Buckets   => [ 'My__string', ... ],    # OPTIONAL
          },
          ...
        ],    # OPTIONAL
        Scoping => {
          Excludes => {
            And => [
              {
                SimpleScopeTerm => {
                  Comparator => 'EQ'
                  , # values: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH; OPTIONAL
                  Key => 'OBJECT_EXTENSION'
                  , # values: OBJECT_EXTENSION, OBJECT_LAST_MODIFIED_DATE, OBJECT_SIZE, OBJECT_KEY; OPTIONAL
                  Values => [ 'My__string', ... ],    # OPTIONAL
                },    # OPTIONAL
                TagScopeTerm => {
                  Comparator => 'EQ'
                  , # values: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH; OPTIONAL
                  Key       => 'My__string',
                  TagValues => [
                    {
                      Key   => 'My__string',
                      Value => 'My__string',
                    },
                    ...
                  ],    # OPTIONAL
                  Target => 'S3_OBJECT',    # values: S3_OBJECT; OPTIONAL
                },    # OPTIONAL
              },
              ...
            ],    # OPTIONAL
          },    # OPTIONAL
          Includes => {
            And => [
              {
                SimpleScopeTerm => {
                  Comparator => 'EQ'
                  , # values: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH; OPTIONAL
                  Key => 'OBJECT_EXTENSION'
                  , # values: OBJECT_EXTENSION, OBJECT_LAST_MODIFIED_DATE, OBJECT_SIZE, OBJECT_KEY; OPTIONAL
                  Values => [ 'My__string', ... ],    # OPTIONAL
                },    # OPTIONAL
                TagScopeTerm => {
                  Comparator => 'EQ'
                  , # values: EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH; OPTIONAL
                  Key       => 'My__string',
                  TagValues => [
                    {
                      Key   => 'My__string',
                      Value => 'My__string',
                    },
                    ...
                  ],    # OPTIONAL
                  Target => 'S3_OBJECT',    # values: S3_OBJECT; OPTIONAL
                },    # OPTIONAL
              },
              ...
            ],    # OPTIONAL
          },    # OPTIONAL
        },    # OPTIONAL
      },
      CustomDataIdentifierIds => [ 'My__string', ... ],    # OPTIONAL
      Description             => 'My__string',             # OPTIONAL
      InitialRun              => 1,                        # OPTIONAL
      SamplingPercentage      => 1,                        # OPTIONAL
      ScheduleFrequency       => {
        DailySchedule => {
        },                                                 # OPTIONAL
        MonthlySchedule => { DayOfMonth => 1, },           # OPTIONAL
        WeeklySchedule  => {
          DayOfWeek => 'SUNDAY'
          , # values: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY; OPTIONAL
        },    # OPTIONAL
      },    # OPTIONAL
      Tags => { 'My__string' => 'My__string', },    # OPTIONAL
    );
    # Results:
    my $JobArn = $CreateClassificationJobResponse->JobArn;
    my $JobId  = $CreateClassificationJobResponse->JobId;
    # Returns a L<Paws::Macie2::CreateClassificationJobResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/macie2/CreateClassificationJob>

ATTRIBUTES

REQUIRED ClientToken => Str

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

CustomDataIdentifierIds => ArrayRef[Str|Undef]

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.

InitialRun => Bool

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

REQUIRED JobType => Str

The schedule for running the job. Valid values are:

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

Valid values are: "ONE_TIME", "SCHEDULED"

REQUIRED Name => Str

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

REQUIRED S3JobDefinition => Paws::Macie2::S3JobDefinition

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

SamplingPercentage => Int

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

ScheduleFrequency => Paws::Macie2::JobScheduleFrequency

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

Tags => Paws::Macie2::TagMap

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.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>