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

Class: Aws::S3Control::Types::JobListDescriptor

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

Overview

Contains the configuration and status information for a single job retrieved as part of a job list.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#creation_time ⇒ Time

A timestamp indicating when the specified job was created.

Returns:

  • (Time) —

    A timestamp indicating when the specified job was created.

#description ⇒ String

The user-specified description that was included in the specified job\'s Create Job request.

Returns:

  • (String) —

    The user-specified description that was included in the specified job\'s Create Job request.

#job_id ⇒ String

The ID for the specified job.

Returns:

  • (String) —

    The ID for the specified job.

#operation ⇒ String

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

Possible values:

  • LambdaInvoke
  • S3PutObjectCopy
  • S3PutObjectAcl
  • S3PutObjectTagging
  • S3InitiateRestoreObject
  • S3PutObjectLegalHold
  • S3PutObjectRetention

Returns:

  • (String) —

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

#priority ⇒ Integer

The current priority for the specified job.

Returns:

  • (Integer) —

    The current priority for 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.

#status ⇒ String

The specified job\'s current status.

Possible values:

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

Returns:

  • (String) —

    The specified job\'s current status.

#termination_date ⇒ Time

A timestamp indicating when the specified 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 the specified job terminated.