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

Class: Aws::S3Control::Types::JobDescriptor

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

Overview

A container element for the job configuration and status information returned by a Describe Job request.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#confirmation_required ⇒ Boolean

Indicates whether confirmation is required before Amazon S3 begins running the specified job. Confirmation is required only for jobs created through the Amazon S3 console.

Returns:

  • (Boolean) —

    Indicates whether confirmation is required before Amazon S3 begins running the specified job.

#creation_time ⇒ Time

A timestamp indicating when this job was created.

Returns:

  • (Time) —

    A timestamp indicating when this job was created.

#description ⇒ String

The description for this job, if one was provided in this job\'s Create Job request.

Returns:

  • (String) —

    The description for this job, if one was provided in this job\'s Create Job request.

#failure_reasons ⇒ Array<Types::JobFailure>

If the specified job failed, this field contains information describing the failure.

Returns:

  • (Array<Types::JobFailure>) —

    If the specified job failed, this field contains information describing the failure.

#job_arn ⇒ String

The Amazon Resource Name (ARN) for this job.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) for this job.

#job_id ⇒ String

The ID for the specified job.

Returns:

  • (String) —

    The ID for the specified job.

#manifest ⇒ Types::JobManifest

The configuration information for the specified job\'s manifest object.

Returns:

  • (Types::JobManifest) —

    The configuration information for the specified job\'s manifest object.

#operation ⇒ Types::JobOperation

The operation that the specified job is configured to run on the objects listed in the manifest.

Returns:

  • (Types::JobOperation) —

    The operation that the specified job is configured to run on the objects listed in the manifest.

#priority ⇒ Integer

The priority of the specified job.

Returns:

  • (Integer) —

    The priority of the specified job.

#progress_summary ⇒ Types::JobProgressSummary

Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.

Returns:

  • (Types::JobProgressSummary) —

    Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.

#report ⇒ Types::JobReport

Contains the configuration information for the job-completion report if you requested one in the Create Job request.

Returns:

  • (Types::JobReport) —

    Contains the configuration information for the job-completion report if you requested one in the Create Job request.

#role_arn ⇒ String

The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to run the tasks for this job.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to run the tasks for this job.

#status ⇒ String

The current status of the specified job.

Possible values:

  • Active
  • Cancelled
  • Cancelling
  • Complete
  • Completing
  • Failed
  • Failing
  • New
  • Paused
  • Pausing
  • Preparing
  • Ready
  • Suspended

Returns:

  • (String) —

    The current status of the specified job.

#status_update_reason ⇒ String

The reason for updating the job.

Returns:

  • (String) —

    The reason for updating the job.

#suspended_cause ⇒ String

The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters the Suspended state to await confirmation before running. After you confirm the job, it automatically exits the Suspended state.

Returns:

  • (String) —

    The reason why the specified job was suspended.

#suspended_date ⇒ Time

The timestamp when this job was suspended, if it has been suspended.

Returns:

  • (Time) —

    The timestamp when this job was suspended, if it has been suspended.

#termination_date ⇒ Time

A timestamp indicating when this job terminated. A job\'s termination date is the date and time when it succeeded, failed, or was canceled.

Returns:

  • (Time) —

    A timestamp indicating when this job terminated.