Class: Aws::Macie2::Types::DescribeClassificationJobResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb

Overview

Provides information about a classification job, including the current configuration settings and status of the job.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

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

Returns:

  • (String)


2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 2088

class DescribeClassificationJobResponse < Struct.new(
  :client_token,
  :created_at,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_arn,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :last_run_time,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :statistics,
  :tags,
  :user_paused_details)
  SENSITIVE = []
  include Aws::Structure
end

#created_atTime

Returns:

  • (Time)


2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 2088

class DescribeClassificationJobResponse < Struct.new(
  :client_token,
  :created_at,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_arn,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :last_run_time,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :statistics,
  :tags,
  :user_paused_details)
  SENSITIVE = []
  include Aws::Structure
end

#custom_data_identifier_idsArray<String>

Returns:

  • (Array<String>)


2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 2088

class DescribeClassificationJobResponse < Struct.new(
  :client_token,
  :created_at,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_arn,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :last_run_time,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :statistics,
  :tags,
  :user_paused_details)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

Returns:

  • (String)


2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 2088

class DescribeClassificationJobResponse < Struct.new(
  :client_token,
  :created_at,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_arn,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :last_run_time,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :statistics,
  :tags,
  :user_paused_details)
  SENSITIVE = []
  include Aws::Structure
end

#initial_runBoolean

Returns:

  • (Boolean)


2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 2088

class DescribeClassificationJobResponse < Struct.new(
  :client_token,
  :created_at,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_arn,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :last_run_time,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :statistics,
  :tags,
  :user_paused_details)
  SENSITIVE = []
  include Aws::Structure
end

#job_arnString

Returns:

  • (String)


2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 2088

class DescribeClassificationJobResponse < Struct.new(
  :client_token,
  :created_at,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_arn,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :last_run_time,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :statistics,
  :tags,
  :user_paused_details)
  SENSITIVE = []
  include Aws::Structure
end

#job_idString

Returns:

  • (String)


2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 2088

class DescribeClassificationJobResponse < Struct.new(
  :client_token,
  :created_at,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_arn,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :last_run_time,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :statistics,
  :tags,
  :user_paused_details)
  SENSITIVE = []
  include Aws::Structure
end

#job_statusString

The status of a classification job. Possible values are:

Returns:

  • (String)


2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 2088

class DescribeClassificationJobResponse < Struct.new(
  :client_token,
  :created_at,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_arn,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :last_run_time,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :statistics,
  :tags,
  :user_paused_details)
  SENSITIVE = []
  include Aws::Structure
end

#job_typeString

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

Returns:

  • (String)


2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 2088

class DescribeClassificationJobResponse < Struct.new(
  :client_token,
  :created_at,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_arn,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :last_run_time,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :statistics,
  :tags,
  :user_paused_details)
  SENSITIVE = []
  include Aws::Structure
end

#last_run_error_statusTypes::LastRunErrorStatus

Specifies whether any account- or bucket-level access errors occurred when a classification job ran. For information about using logging data to investigate these errors, see Monitoring sensitive data discovery jobs in the Amazon Macie User Guide.



2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 2088

class DescribeClassificationJobResponse < Struct.new(
  :client_token,
  :created_at,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_arn,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :last_run_time,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :statistics,
  :tags,
  :user_paused_details)
  SENSITIVE = []
  include Aws::Structure
end

#last_run_timeTime

Returns:

  • (Time)


2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 2088

class DescribeClassificationJobResponse < Struct.new(
  :client_token,
  :created_at,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_arn,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :last_run_time,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :statistics,
  :tags,
  :user_paused_details)
  SENSITIVE = []
  include Aws::Structure
end

#managed_data_identifier_idsArray<String>

Returns:

  • (Array<String>)


2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 2088

class DescribeClassificationJobResponse < Struct.new(
  :client_token,
  :created_at,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_arn,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :last_run_time,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :statistics,
  :tags,
  :user_paused_details)
  SENSITIVE = []
  include Aws::Structure
end

#managed_data_identifier_selectorString

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

Returns:

  • (String)


2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 2088

class DescribeClassificationJobResponse < Struct.new(
  :client_token,
  :created_at,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_arn,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :last_run_time,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :statistics,
  :tags,
  :user_paused_details)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

Returns:

  • (String)


2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 2088

class DescribeClassificationJobResponse < Struct.new(
  :client_token,
  :created_at,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_arn,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :last_run_time,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :statistics,
  :tags,
  :user_paused_details)
  SENSITIVE = []
  include Aws::Structure
end

#s3_job_definitionTypes::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.



2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 2088

class DescribeClassificationJobResponse < Struct.new(
  :client_token,
  :created_at,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_arn,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :last_run_time,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :statistics,
  :tags,
  :user_paused_details)
  SENSITIVE = []
  include Aws::Structure
end

#sampling_percentageInteger

Returns:

  • (Integer)


2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 2088

class DescribeClassificationJobResponse < Struct.new(
  :client_token,
  :created_at,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_arn,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :last_run_time,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :statistics,
  :tags,
  :user_paused_details)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_frequencyTypes::JobScheduleFrequency

Specifies the recurrence pattern for running a classification job.



2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 2088

class DescribeClassificationJobResponse < Struct.new(
  :client_token,
  :created_at,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_arn,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :last_run_time,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :statistics,
  :tags,
  :user_paused_details)
  SENSITIVE = []
  include Aws::Structure
end

#statisticsTypes::Statistics

Provides processing statistics for a classification job.

Returns:



2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 2088

class DescribeClassificationJobResponse < Struct.new(
  :client_token,
  :created_at,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_arn,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :last_run_time,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :statistics,
  :tags,
  :user_paused_details)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<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>)


2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 2088

class DescribeClassificationJobResponse < Struct.new(
  :client_token,
  :created_at,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_arn,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :last_run_time,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :statistics,
  :tags,
  :user_paused_details)
  SENSITIVE = []
  include Aws::Structure
end

#user_paused_detailsTypes::UserPausedDetails

Provides information about when a classification job was paused. For a one-time job, this object also specifies when the job will expire and be cancelled if it isn't resumed. For a recurring job, this object also specifies when the paused job run will expire and be cancelled if it isn't resumed. This object is present only if a job's current status (jobStatus) is USER_PAUSED. The information in this object applies only to a job that was paused while it had a status of RUNNING.



2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
# File 'gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb', line 2088

class DescribeClassificationJobResponse < Struct.new(
  :client_token,
  :created_at,
  :custom_data_identifier_ids,
  :description,
  :initial_run,
  :job_arn,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :last_run_time,
  :managed_data_identifier_ids,
  :managed_data_identifier_selector,
  :name,
  :s3_job_definition,
  :sampling_percentage,
  :schedule_frequency,
  :statistics,
  :tags,
  :user_paused_details)
  SENSITIVE = []
  include Aws::Structure
end