Class: Aws::Macie2::Types::JobSummary

Inherits:

Struct

• Object
• Struct
• Aws::Macie2::Types::JobSummary

Defined in:

gems/aws-sdk-macie2/lib/aws-sdk-macie2/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bucket_criteria ⇒ Types::S3BucketCriteriaForJob

  Specifies property- and tag-based conditions that define criteria for including or excluding S3 buckets from a classification job.

• #bucket_definitions ⇒ Array<Types::S3BucketDefinitionForJob>
• #created_at ⇒ Time
• #job_id ⇒ String
• #job_status ⇒ String

  The status of a classification job.

• #job_type ⇒ String

  The schedule for running a classification job.

• #last_run_error_status ⇒ Types::LastRunErrorStatus

  Specifies whether any account- or bucket-level access errors occurred when a classification job ran.

• #name ⇒ String
• #user_paused_details ⇒ Types::UserPausedDetails

  Provides information about when a classification job was paused.

Instance Attribute Details

#bucket_criteria ⇒ Types::S3BucketCriteriaForJob

Specifies property- and tag-based conditions that define criteria for including or excluding S3 buckets from a classification job. Exclude conditions take precedence over include conditions.

Returns:

• (Types::S3BucketCriteriaForJob)

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

class JobSummary < Struct.new(
  :bucket_criteria,
  :bucket_definitions,
  :created_at,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :name,
  :user_paused_details)
  SENSITIVE = []
  include Aws::Structure
end

#bucket_definitions ⇒ Array<Types::S3BucketDefinitionForJob>

Returns:

• (Array<Types::S3BucketDefinitionForJob>)

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

class JobSummary < Struct.new(
  :bucket_criteria,
  :bucket_definitions,
  :created_at,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :name,
  :user_paused_details)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

Returns:

• (Time)

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

class JobSummary < Struct.new(
  :bucket_criteria,
  :bucket_definitions,
  :created_at,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :name,
  :user_paused_details)
  SENSITIVE = []
  include Aws::Structure
end

#job_id ⇒ String

Returns:

• (String)

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

class JobSummary < Struct.new(
  :bucket_criteria,
  :bucket_definitions,
  :created_at,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :name,
  :user_paused_details)
  SENSITIVE = []
  include Aws::Structure
end

#job_status ⇒ String

The status of a classification job. Possible values are:

Returns:

• (String)

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

class JobSummary < Struct.new(
  :bucket_criteria,
  :bucket_definitions,
  :created_at,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :name,
  :user_paused_details)
  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 3942

class JobSummary < Struct.new(
  :bucket_criteria,
  :bucket_definitions,
  :created_at,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :name,
  :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.

Returns:

• (Types::LastRunErrorStatus)

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

class JobSummary < Struct.new(
  :bucket_criteria,
  :bucket_definitions,
  :created_at,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :name,
  :user_paused_details)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

Returns:

• (String)

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

class JobSummary < Struct.new(
  :bucket_criteria,
  :bucket_definitions,
  :created_at,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :name,
  :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:

• (Types::UserPausedDetails)

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

class JobSummary < Struct.new(
  :bucket_criteria,
  :bucket_definitions,
  :created_at,
  :job_id,
  :job_status,
  :job_type,
  :last_run_error_status,
  :name,
  :user_paused_details)
  SENSITIVE = []
  include Aws::Structure
end