class Aws::Macie2::Types::CreateClassificationJobRequest

Specifies the scope, schedule, and other settings for a classification job. You can't change any settings for a classification job after you create it. This helps ensure that you have an immutable history of sensitive data findings and discovery results for data privacy and protection audits or investigations.

@note When making an API call, you may pass CreateClassificationJobRequest

data as a hash:

    {
      client_token: "__string", # required
      custom_data_identifier_ids: ["__string"],
      description: "__string",
      initial_run: false,
      job_type: "ONE_TIME", # required, accepts ONE_TIME, SCHEDULED
      name: "__string", # required
      s3_job_definition: { # required
        bucket_definitions: [
          {
            account_id: "__string", # required
            buckets: ["__string"], # required
          },
        ],
        scoping: {
          excludes: {
            and: [
              {
                simple_scope_term: {
                  comparator: "EQ", # accepts EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH
                  key: "OBJECT_EXTENSION", # accepts OBJECT_EXTENSION, OBJECT_LAST_MODIFIED_DATE, OBJECT_SIZE, OBJECT_KEY
                  values: ["__string"],
                },
                tag_scope_term: {
                  comparator: "EQ", # accepts EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH
                  key: "__string",
                  tag_values: [
                    {
                      key: "__string",
                      value: "__string",
                    },
                  ],
                  target: "S3_OBJECT", # accepts S3_OBJECT
                },
              },
            ],
          },
          includes: {
            and: [
              {
                simple_scope_term: {
                  comparator: "EQ", # accepts EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH
                  key: "OBJECT_EXTENSION", # accepts OBJECT_EXTENSION, OBJECT_LAST_MODIFIED_DATE, OBJECT_SIZE, OBJECT_KEY
                  values: ["__string"],
                },
                tag_scope_term: {
                  comparator: "EQ", # accepts EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH
                  key: "__string",
                  tag_values: [
                    {
                      key: "__string",
                      value: "__string",
                    },
                  ],
                  target: "S3_OBJECT", # accepts S3_OBJECT
                },
              },
            ],
          },
        },
        bucket_criteria: {
          excludes: {
            and: [
              {
                simple_criterion: {
                  comparator: "EQ", # accepts EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH
                  key: "ACCOUNT_ID", # accepts ACCOUNT_ID, S3_BUCKET_NAME, S3_BUCKET_EFFECTIVE_PERMISSION, S3_BUCKET_SHARED_ACCESS
                  values: ["__string"],
                },
                tag_criterion: {
                  comparator: "EQ", # accepts EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH
                  tag_values: [
                    {
                      key: "__string",
                      value: "__string",
                    },
                  ],
                },
              },
            ],
          },
          includes: {
            and: [
              {
                simple_criterion: {
                  comparator: "EQ", # accepts EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH
                  key: "ACCOUNT_ID", # accepts ACCOUNT_ID, S3_BUCKET_NAME, S3_BUCKET_EFFECTIVE_PERMISSION, S3_BUCKET_SHARED_ACCESS
                  values: ["__string"],
                },
                tag_criterion: {
                  comparator: "EQ", # accepts EQ, GT, GTE, LT, LTE, NE, CONTAINS, STARTS_WITH
                  tag_values: [
                    {
                      key: "__string",
                      value: "__string",
                    },
                  ],
                },
              },
            ],
          },
        },
      },
      sampling_percentage: 1,
      schedule_frequency: {
        daily_schedule: {
        },
        monthly_schedule: {
          day_of_month: 1,
        },
        weekly_schedule: {
          day_of_week: "SUNDAY", # accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
        },
      },
      tags: {
        "__string" => "__string",
      },
    }

@!attribute [rw] client_token

**A suitable default value is auto-generated.** You should normally
not need to pass this option.
@return [String]

@!attribute [rw] custom_data_identifier_ids

@return [Array<String>]

@!attribute [rw] description

@return [String]

@!attribute [rw] initial_run

@return [Boolean]

@!attribute [rw] job_type

The schedule for running a classification job. Valid values are:
@return [String]

@!attribute [rw] name

@return [String]

@!attribute [rw] s3_job_definition

Specifies which S3 buckets contain the objects that a classification
job analyzes, and the scope of that analysis. The bucket
specification can be static (bucketDefinitions) or dynamic
(bucketCriteria). If it's static, the job analyzes objects in the
same predefined set of buckets each time the job runs. If it's
dynamic, the job analyzes objects in any buckets that match the
specified criteria each time the job starts to run.
@return [Types::S3JobDefinition]

@!attribute [rw] sampling_percentage

@return [Integer]

@!attribute [rw] schedule_frequency

Specifies the recurrence pattern for running a classification job.
@return [Types::JobScheduleFrequency]

@!attribute [rw] tags

A string-to-string map of key-value pairs that specifies the tags
(keys and values) for a classification job, custom data identifier,
findings filter, or member account.
@return [Hash<String,String>]

@see docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/CreateClassificationJobRequest AWS API Documentation

Constants

SENSITIVE