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

Inherits:

Struct

Object
Struct
Aws::Macie2::Types::CreateClassificationJobRequest

show all

Defined in:: gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb

Overview

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 to ensure that you have an immutable history of sensitive data findings and discovery results for data privacy and protection audits or investigations.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#allow_list_ids ⇒ Array<String>
#client_token ⇒ String
A suitable default value is auto-generated. You should normally not need to pass this option.
#custom_data_identifier_ids ⇒ Array<String>
#description ⇒ String
#initial_run ⇒ Boolean
#job_type ⇒ String
The schedule for running a classification job.
#managed_data_identifier_ids ⇒ Array<String>
#managed_data_identifier_selector ⇒ String
The selection type that determines which managed data identifiers a classification job uses to analyze data.
#name ⇒ String
#s3_job_definition ⇒ Types::S3JobDefinition
Specifies which S3 buckets contain the objects that a classification job analyzes, and the scope of that analysis.
#sampling_percentage ⇒ Integer
#schedule_frequency ⇒ Types::JobScheduleFrequency
Specifies the recurrence pattern for running a classification job.
#tags ⇒ Hash<String,String>
A string-to-string map of key-value pairs that specifies the tags (keys and values) for an Amazon Macie resource.

Instance Attribute Details

#allow_list_ids ⇒ `Array<String>`

Returns:

(Array<String>)

# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 1208

class CreateClassificationJobRequest < Struct.new(
  :allow_list_ids,
  :client_token,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_type,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ `String`

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

(String)

# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 1208

class CreateClassificationJobRequest < Struct.new(
  :allow_list_ids,
  :client_token,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_type,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#custom_data_identifier_ids ⇒ `Array<String>`

Returns:

(Array<String>)

# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 1208

class CreateClassificationJobRequest < Struct.new(
  :allow_list_ids,
  :client_token,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_type,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

Returns:

(String)

# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 1208

class CreateClassificationJobRequest < Struct.new(
  :allow_list_ids,
  :client_token,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_type,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#initial_run ⇒ `Boolean`

Returns:

(Boolean)

# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 1208

class CreateClassificationJobRequest < Struct.new(
  :allow_list_ids,
  :client_token,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_type,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#job_type ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 1208

class CreateClassificationJobRequest < Struct.new(
  :allow_list_ids,
  :client_token,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_type,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#managed_data_identifier_ids ⇒ `Array<String>`

Returns:

(Array<String>)

# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 1208

class CreateClassificationJobRequest < Struct.new(
  :allow_list_ids,
  :client_token,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_type,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#managed_data_identifier_selector ⇒ `String`

The selection type that determines which managed data identifiers a classification job uses to analyze data. Valid values are:

Returns:

(String)

# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 1208

class CreateClassificationJobRequest < Struct.new(
  :allow_list_ids,
  :client_token,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_type,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

Returns:

(String)

# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 1208

class CreateClassificationJobRequest < Struct.new(
  :allow_list_ids,
  :client_token,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_type,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#s3_job_definition ⇒ `Types::S3JobDefinition`

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.

Returns:

(Types::S3JobDefinition)

# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 1208

class CreateClassificationJobRequest < Struct.new(
  :allow_list_ids,
  :client_token,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_type,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#sampling_percentage ⇒ `Integer`

Returns:

(Integer)

# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 1208

class CreateClassificationJobRequest < Struct.new(
  :allow_list_ids,
  :client_token,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_type,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_frequency ⇒ `Types::JobScheduleFrequency`

Specifies the recurrence pattern for running a classification job.

Returns:

(Types::JobScheduleFrequency)

# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 1208

class CreateClassificationJobRequest < Struct.new(
  :allow_list_ids,
  :client_token,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_type,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Hash<String,String>`

A string-to-string map of key-value pairs that specifies the tags (keys and values) for an Amazon Macie resource.

Returns:

(Hash<String,String>)

# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 1208

class CreateClassificationJobRequest < Struct.new(
  :allow_list_ids,
  :client_token,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_type,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#allow_list_ids ⇒ Array<String>

#client_token ⇒ String

#custom_data_identifier_ids ⇒ Array<String>

#description ⇒ String

#initial_run ⇒ Boolean

#job_type ⇒ String

#managed_data_identifier_ids ⇒ Array<String>

#managed_data_identifier_selector ⇒ String

#name ⇒ String

#s3_job_definition ⇒ Types::S3JobDefinition

#sampling_percentage ⇒ Integer

#schedule_frequency ⇒ Types::JobScheduleFrequency

#tags ⇒ Hash<String,String>

#allow_list_ids ⇒ `Array<String>`

#client_token ⇒ `String`

#custom_data_identifier_ids ⇒ `Array<String>`

#description ⇒ `String`

#initial_run ⇒ `Boolean`

#job_type ⇒ `String`

#managed_data_identifier_ids ⇒ `Array<String>`

#managed_data_identifier_selector ⇒ `String`

#name ⇒ `String`

#s3_job_definition ⇒ `Types::S3JobDefinition`

#sampling_percentage ⇒ `Integer`

#schedule_frequency ⇒ `Types::JobScheduleFrequency`

#tags ⇒ `Hash<String,String>`