You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Macie2::Types::CreateClassificationJobRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateClassificationJobRequest as input to an Aws::Client method, you can use a vanilla 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",
        buckets: ["__string"],
      },
    ],
    scoping: {
      excludes: {
        and: [
          {
            simple_scope_term: {
              comparator: "EQ", # accepts EQ, GT, GTE, LT, LTE, NE, CONTAINS
              key: "BUCKET_CREATION_DATE", # accepts BUCKET_CREATION_DATE, OBJECT_EXTENSION, OBJECT_LAST_MODIFIED_DATE, OBJECT_SIZE, TAG
              values: ["__string"],
            },
            tag_scope_term: {
              comparator: "EQ", # accepts EQ, GT, GTE, LT, LTE, NE, CONTAINS
              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
              key: "BUCKET_CREATION_DATE", # accepts BUCKET_CREATION_DATE, OBJECT_EXTENSION, OBJECT_LAST_MODIFIED_DATE, OBJECT_SIZE, TAG
              values: ["__string"],
            },
            tag_scope_term: {
              comparator: "EQ", # accepts EQ, GT, GTE, LT, LTE, NE, CONTAINS
              key: "__string",
              tag_values: [
                {
                  key: "__string",
                  value: "__string",
                },
              ],
              target: "S3_OBJECT", # accepts S3_OBJECT
            },
          },
        ],
      },
    },
  },
  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",
  },
}

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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

Returns:

  • (String)

#custom_data_identifier_ids ⇒ Array<String>

Returns:

  • (Array<String>)

#description ⇒ String

Returns:

  • (String)

#initial_run ⇒ Boolean

Returns:

  • (Boolean)

#job_type ⇒ String

The schedule for running a classification job. Valid values are:

Possible values:

  • ONE_TIME
  • SCHEDULED

Returns:

  • (String) —

    The schedule for running a classification job.

#name ⇒ String

Returns:

  • (String)

#s3_job_definition ⇒ Types::S3JobDefinition

Specifies which S3 buckets contain the objects that a classification job analyzes, and the scope of that analysis.

Returns:

  • (Types::S3JobDefinition) —

    Specifies which S3 buckets contain the objects that a classification job analyzes, and the scope of that analysis.

    .

#sampling_percentage ⇒ Integer

Returns:

  • (Integer)

#schedule_frequency ⇒ Types::JobScheduleFrequency

Specifies the recurrence pattern for running a classification job.

Returns:

#tags ⇒ Hash<String,String>

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.

Returns:

  • (Hash<String,String>) —

    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.

    .