Class: Aws::S3Control::Types::JobDescriptor
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3Control::Types::JobDescriptor
- Defined in:
- gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb
Overview
A container element for the job configuration and status information
returned by a Describe Job
request.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#confirmation_required ⇒ 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.
-
#description ⇒ 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.
-
#generated_manifest_descriptor ⇒ Types::S3GeneratedManifestDescriptor
The attribute of the JobDescriptor containing details about the job's generated manifest.
-
#job_arn ⇒ String
The Amazon Resource Name (ARN) for this job.
-
#job_id ⇒ String
The ID for the specified job.
-
#manifest ⇒ Types::JobManifest
The configuration information for the specified job's manifest object.
-
#manifest_generator ⇒ Types::JobManifestGenerator
The manifest generator that was used to generate a job manifest for this job.
-
#operation ⇒ 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.
-
#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.
-
#report ⇒ 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 Identity and Access Management (IAM) role assigned to run the tasks for this job.
-
#status ⇒ String
The current status of the specified job.
-
#status_update_reason ⇒ String
The reason for updating the job.
-
#suspended_cause ⇒ String
The reason why the specified job was suspended.
-
#suspended_date ⇒ Time
The timestamp when this job was suspended, if it has been suspended.
-
#termination_date ⇒ Time
A timestamp indicating when this job terminated.
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.
3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 3676 class JobDescriptor < Struct.new( :job_id, :confirmation_required, :description, :job_arn, :status, :manifest, :operation, :priority, :progress_summary, :status_update_reason, :failure_reasons, :report, :creation_time, :termination_date, :role_arn, :suspended_date, :suspended_cause, :manifest_generator, :generated_manifest_descriptor) SENSITIVE = [] include Aws::Structure end |
#creation_time ⇒ Time
A timestamp indicating when this job was created.
3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 3676 class JobDescriptor < Struct.new( :job_id, :confirmation_required, :description, :job_arn, :status, :manifest, :operation, :priority, :progress_summary, :status_update_reason, :failure_reasons, :report, :creation_time, :termination_date, :role_arn, :suspended_date, :suspended_cause, :manifest_generator, :generated_manifest_descriptor) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
The description for this job, if one was provided in this job's
Create Job
request.
3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 3676 class JobDescriptor < Struct.new( :job_id, :confirmation_required, :description, :job_arn, :status, :manifest, :operation, :priority, :progress_summary, :status_update_reason, :failure_reasons, :report, :creation_time, :termination_date, :role_arn, :suspended_date, :suspended_cause, :manifest_generator, :generated_manifest_descriptor) SENSITIVE = [] include Aws::Structure end |
#failure_reasons ⇒ Array<Types::JobFailure>
If the specified job failed, this field contains information describing the failure.
3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 3676 class JobDescriptor < Struct.new( :job_id, :confirmation_required, :description, :job_arn, :status, :manifest, :operation, :priority, :progress_summary, :status_update_reason, :failure_reasons, :report, :creation_time, :termination_date, :role_arn, :suspended_date, :suspended_cause, :manifest_generator, :generated_manifest_descriptor) SENSITIVE = [] include Aws::Structure end |
#generated_manifest_descriptor ⇒ Types::S3GeneratedManifestDescriptor
The attribute of the JobDescriptor containing details about the job's generated manifest.
3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 3676 class JobDescriptor < Struct.new( :job_id, :confirmation_required, :description, :job_arn, :status, :manifest, :operation, :priority, :progress_summary, :status_update_reason, :failure_reasons, :report, :creation_time, :termination_date, :role_arn, :suspended_date, :suspended_cause, :manifest_generator, :generated_manifest_descriptor) SENSITIVE = [] include Aws::Structure end |
#job_arn ⇒ String
The Amazon Resource Name (ARN) for this job.
3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 3676 class JobDescriptor < Struct.new( :job_id, :confirmation_required, :description, :job_arn, :status, :manifest, :operation, :priority, :progress_summary, :status_update_reason, :failure_reasons, :report, :creation_time, :termination_date, :role_arn, :suspended_date, :suspended_cause, :manifest_generator, :generated_manifest_descriptor) SENSITIVE = [] include Aws::Structure end |
#job_id ⇒ String
The ID for the specified job.
3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 3676 class JobDescriptor < Struct.new( :job_id, :confirmation_required, :description, :job_arn, :status, :manifest, :operation, :priority, :progress_summary, :status_update_reason, :failure_reasons, :report, :creation_time, :termination_date, :role_arn, :suspended_date, :suspended_cause, :manifest_generator, :generated_manifest_descriptor) SENSITIVE = [] include Aws::Structure end |
#manifest ⇒ Types::JobManifest
The configuration information for the specified job's manifest object.
3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 3676 class JobDescriptor < Struct.new( :job_id, :confirmation_required, :description, :job_arn, :status, :manifest, :operation, :priority, :progress_summary, :status_update_reason, :failure_reasons, :report, :creation_time, :termination_date, :role_arn, :suspended_date, :suspended_cause, :manifest_generator, :generated_manifest_descriptor) SENSITIVE = [] include Aws::Structure end |
#manifest_generator ⇒ Types::JobManifestGenerator
The manifest generator that was used to generate a job manifest for this job.
3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 3676 class JobDescriptor < Struct.new( :job_id, :confirmation_required, :description, :job_arn, :status, :manifest, :operation, :priority, :progress_summary, :status_update_reason, :failure_reasons, :report, :creation_time, :termination_date, :role_arn, :suspended_date, :suspended_cause, :manifest_generator, :generated_manifest_descriptor) SENSITIVE = [] include Aws::Structure end |
#operation ⇒ Types::JobOperation
The operation that the specified job is configured to run on the objects listed in the manifest.
3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 3676 class JobDescriptor < Struct.new( :job_id, :confirmation_required, :description, :job_arn, :status, :manifest, :operation, :priority, :progress_summary, :status_update_reason, :failure_reasons, :report, :creation_time, :termination_date, :role_arn, :suspended_date, :suspended_cause, :manifest_generator, :generated_manifest_descriptor) SENSITIVE = [] include Aws::Structure end |
#priority ⇒ Integer
The priority of the specified job.
3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 3676 class JobDescriptor < Struct.new( :job_id, :confirmation_required, :description, :job_arn, :status, :manifest, :operation, :priority, :progress_summary, :status_update_reason, :failure_reasons, :report, :creation_time, :termination_date, :role_arn, :suspended_date, :suspended_cause, :manifest_generator, :generated_manifest_descriptor) SENSITIVE = [] include Aws::Structure end |
#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.
3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 3676 class JobDescriptor < Struct.new( :job_id, :confirmation_required, :description, :job_arn, :status, :manifest, :operation, :priority, :progress_summary, :status_update_reason, :failure_reasons, :report, :creation_time, :termination_date, :role_arn, :suspended_date, :suspended_cause, :manifest_generator, :generated_manifest_descriptor) SENSITIVE = [] include Aws::Structure end |
#report ⇒ Types::JobReport
Contains the configuration information for the job-completion report
if you requested one in the Create Job
request.
3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 3676 class JobDescriptor < Struct.new( :job_id, :confirmation_required, :description, :job_arn, :status, :manifest, :operation, :priority, :progress_summary, :status_update_reason, :failure_reasons, :report, :creation_time, :termination_date, :role_arn, :suspended_date, :suspended_cause, :manifest_generator, :generated_manifest_descriptor) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role assigned to run the tasks for this job.
3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 3676 class JobDescriptor < Struct.new( :job_id, :confirmation_required, :description, :job_arn, :status, :manifest, :operation, :priority, :progress_summary, :status_update_reason, :failure_reasons, :report, :creation_time, :termination_date, :role_arn, :suspended_date, :suspended_cause, :manifest_generator, :generated_manifest_descriptor) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
The current status of the specified job.
3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 3676 class JobDescriptor < Struct.new( :job_id, :confirmation_required, :description, :job_arn, :status, :manifest, :operation, :priority, :progress_summary, :status_update_reason, :failure_reasons, :report, :creation_time, :termination_date, :role_arn, :suspended_date, :suspended_cause, :manifest_generator, :generated_manifest_descriptor) SENSITIVE = [] include Aws::Structure end |
#status_update_reason ⇒ String
The reason for updating the job.
3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 3676 class JobDescriptor < Struct.new( :job_id, :confirmation_required, :description, :job_arn, :status, :manifest, :operation, :priority, :progress_summary, :status_update_reason, :failure_reasons, :report, :creation_time, :termination_date, :role_arn, :suspended_date, :suspended_cause, :manifest_generator, :generated_manifest_descriptor) SENSITIVE = [] include Aws::Structure end |
#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.
3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 3676 class JobDescriptor < Struct.new( :job_id, :confirmation_required, :description, :job_arn, :status, :manifest, :operation, :priority, :progress_summary, :status_update_reason, :failure_reasons, :report, :creation_time, :termination_date, :role_arn, :suspended_date, :suspended_cause, :manifest_generator, :generated_manifest_descriptor) SENSITIVE = [] include Aws::Structure end |
#suspended_date ⇒ Time
The timestamp when this job was suspended, if it has been suspended.
3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 3676 class JobDescriptor < Struct.new( :job_id, :confirmation_required, :description, :job_arn, :status, :manifest, :operation, :priority, :progress_summary, :status_update_reason, :failure_reasons, :report, :creation_time, :termination_date, :role_arn, :suspended_date, :suspended_cause, :manifest_generator, :generated_manifest_descriptor) SENSITIVE = [] include Aws::Structure end |
#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.
3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 3676 class JobDescriptor < Struct.new( :job_id, :confirmation_required, :description, :job_arn, :status, :manifest, :operation, :priority, :progress_summary, :status_update_reason, :failure_reasons, :report, :creation_time, :termination_date, :role_arn, :suspended_date, :suspended_cause, :manifest_generator, :generated_manifest_descriptor) SENSITIVE = [] include Aws::Structure end |