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

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

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allow_list_ids ⇒ Array<String>

Returns:

  • (Array<String>) 


2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
 
# File 'lib/aws-sdk-macie2/types.rb', line 2056

class DescribeClassificationJobResponse < Struct.new(
  :allow_list_ids,
  :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

#client_token ⇒ String

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

Returns:

  • (String) 


2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
 
# File 'lib/aws-sdk-macie2/types.rb', line 2056

class DescribeClassificationJobResponse < Struct.new(
  :allow_list_ids,
  :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_at ⇒ Time

Returns:

  • (Time) 


2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
 
# File 'lib/aws-sdk-macie2/types.rb', line 2056

class DescribeClassificationJobResponse < Struct.new(
  :allow_list_ids,
  :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_ids ⇒ Array<String>

Returns:

  • (Array<String>) 


2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
 
# File 'lib/aws-sdk-macie2/types.rb', line 2056

class DescribeClassificationJobResponse < Struct.new(
  :allow_list_ids,
  :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

#description ⇒ String

Returns:

  • (String) 


2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
 
# File 'lib/aws-sdk-macie2/types.rb', line 2056

class DescribeClassificationJobResponse < Struct.new(
  :allow_list_ids,
  :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_run ⇒ Boolean

Returns:

  • (Boolean) 


2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
 
# File 'lib/aws-sdk-macie2/types.rb', line 2056

class DescribeClassificationJobResponse < Struct.new(
  :allow_list_ids,
  :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_arn ⇒ String

Returns:

  • (String) 


2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
 
# File 'lib/aws-sdk-macie2/types.rb', line 2056

class DescribeClassificationJobResponse < Struct.new(
  :allow_list_ids,
  :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_id ⇒ String

Returns:

  • (String) 


2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
 
# File 'lib/aws-sdk-macie2/types.rb', line 2056

class DescribeClassificationJobResponse < Struct.new(
  :allow_list_ids,
  :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_status ⇒ String

The status of a classification job. Possible values are:

Returns:

  • (String) 


2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
 
# File 'lib/aws-sdk-macie2/types.rb', line 2056

class DescribeClassificationJobResponse < Struct.new(
  :allow_list_ids,
  :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_type ⇒ String

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

Returns:

  • (String) 


2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
 
# File 'lib/aws-sdk-macie2/types.rb', line 2056

class DescribeClassificationJobResponse < Struct.new(
  :allow_list_ids,
  :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_status ⇒ Types::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*.

[1]: docs.aws.amazon.com/macie/latest/user/discovery-jobs-monitor-cw-logs.html

Returns:



2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
 
# File 'lib/aws-sdk-macie2/types.rb', line 2056

class DescribeClassificationJobResponse < Struct.new(
  :allow_list_ids,
  :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_time ⇒ Time

Returns:

  • (Time) 


2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
 
# File 'lib/aws-sdk-macie2/types.rb', line 2056

class DescribeClassificationJobResponse < Struct.new(
  :allow_list_ids,
  :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_ids ⇒ Array<String>

Returns:

  • (Array<String>) 


2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
 
# File 'lib/aws-sdk-macie2/types.rb', line 2056

class DescribeClassificationJobResponse < Struct.new(
  :allow_list_ids,
  :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_selector ⇒ String

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

Returns:

  • (String) 


2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
 
# File 'lib/aws-sdk-macie2/types.rb', line 2056

class DescribeClassificationJobResponse < Struct.new(
  :allow_list_ids,
  :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

#name ⇒ String

Returns:

  • (String) 


2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
 
# File 'lib/aws-sdk-macie2/types.rb', line 2056

class DescribeClassificationJobResponse < Struct.new(
  :allow_list_ids,
  :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_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:



2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
 
# File 'lib/aws-sdk-macie2/types.rb', line 2056

class DescribeClassificationJobResponse < Struct.new(
  :allow_list_ids,
  :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_percentage ⇒ Integer

Returns:

  • (Integer) 


2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
 
# File 'lib/aws-sdk-macie2/types.rb', line 2056

class DescribeClassificationJobResponse < Struct.new(
  :allow_list_ids,
  :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_frequency ⇒ Types::JobScheduleFrequency

Specifies the recurrence pattern for running a classification job.

Returns:



2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
 
# File 'lib/aws-sdk-macie2/types.rb', line 2056

class DescribeClassificationJobResponse < Struct.new(
  :allow_list_ids,
  :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

#statistics ⇒ Types::Statistics

Provides processing statistics for a classification job.

Returns:



2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
 
# File 'lib/aws-sdk-macie2/types.rb', line 2056

class DescribeClassificationJobResponse < Struct.new(
  :allow_list_ids,
  :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

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


2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
 
# File 'lib/aws-sdk-macie2/types.rb', line 2056

class DescribeClassificationJobResponse < Struct.new(
  :allow_list_ids,
  :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_details ⇒ Types::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.

Returns:



2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
 
# File 'lib/aws-sdk-macie2/types.rb', line 2056

class DescribeClassificationJobResponse < Struct.new(
  :allow_list_ids,
  :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