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

Inherits:
Struct
  • Object
show all
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

Instance Attribute Details

#confirmation_requiredBoolean

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)


2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 2399

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_timeTime

A timestamp indicating when this job was created.

Returns:

  • (Time)


2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 2399

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

#descriptionString

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

Returns:

  • (String)


2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 2399

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_reasonsArray<Types::JobFailure>

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

Returns:



2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 2399

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_descriptorTypes::S3GeneratedManifestDescriptor

The attribute of the JobDescriptor containing details about the job's generated manifest.



2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 2399

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_arnString

The Amazon Resource Name (ARN) for this job.

Returns:

  • (String)


2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 2399

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_idString

The ID for the specified job.

Returns:

  • (String)


2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 2399

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

#manifestTypes::JobManifest

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

Returns:



2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 2399

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_generatorTypes::JobManifestGenerator

The manifest generator that was used to generate a job manifest for this job.



2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 2399

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

#operationTypes::JobOperation

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

Returns:



2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 2399

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

#priorityInteger

The priority of the specified job.

Returns:

  • (Integer)


2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 2399

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_summaryTypes::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.



2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 2399

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

#reportTypes::JobReport

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

Returns:



2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 2399

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_arnString

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

Returns:

  • (String)


2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 2399

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

#statusString

The current status of the specified job.

Returns:

  • (String)


2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 2399

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_reasonString

The reason for updating the job.

Returns:

  • (String)


2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 2399

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_causeString

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)


2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 2399

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_dateTime

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

Returns:

  • (Time)


2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 2399

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_dateTime

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)


2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 2399

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