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

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

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

Overview

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

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

Returns:

  • (String)

#created_at ⇒ Time

Returns:

  • (Time)

#custom_data_identifier_ids ⇒ Array<String>

Returns:

  • (Array<String>)

#description ⇒ String

Returns:

  • (String)

#initial_run ⇒ Boolean

Returns:

  • (Boolean)

#job_arn ⇒ String

Returns:

  • (String)

#job_id ⇒ String

Returns:

  • (String)

#job_status ⇒ String

The status of a classification job. Possible values are:

Possible values:

  • RUNNING
  • PAUSED
  • CANCELLED
  • COMPLETE
  • IDLE
  • USER_PAUSED

Returns:

  • (String) —

    The status of a classification job.

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

#last_run_error_status ⇒ Types::LastRunErrorStatus

Specifies whether any account- or bucket-level access errors occurred when a classification job ran. For example, the job is configured to analyze data for a member account that was suspended, or the job is configured to analyze an S3 bucket that Amazon Macie isn't allowed to access.

Returns:

  • (Types::LastRunErrorStatus) —

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

#last_run_time ⇒ Time

Returns:

  • (Time)

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

#statistics ⇒ Types::Statistics

Provides processing statistics for 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.

    .

#user_paused_details ⇒ Types::UserPausedDetails

Provides information about when a classification job was paused and when it 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) —

    Provides information about when a classification job was paused and when it will expire and be cancelled if it isn't resumed.