/AWS1/CL_S3CJOBDESCRIPTOR

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

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_jobid TYPE /AWS1/S3CJOBID /AWS1/S3CJOBID

The ID for the specified job.

iv_confirmationrequired TYPE /AWS1/S3CCONFIRMATIONREQUIRED /AWS1/S3CCONFIRMATIONREQUIRED

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.

iv_description TYPE /AWS1/S3CNONEMPTYMAXLENGTH2500 /AWS1/S3CNONEMPTYMAXLENGTH2500

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

iv_jobarn TYPE /AWS1/S3CJOBARN /AWS1/S3CJOBARN

The Amazon Resource Name (ARN) for this job.

iv_status TYPE /AWS1/S3CJOBSTATUS /AWS1/S3CJOBSTATUS

The current status of the specified job.

io_manifest TYPE REF TO /AWS1/CL_S3CJOBMANIFEST /AWS1/CL_S3CJOBMANIFEST

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

io_operation TYPE REF TO /AWS1/CL_S3CJOBOPERATION /AWS1/CL_S3CJOBOPERATION

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

iv_priority TYPE /AWS1/S3CJOBPRIORITY /AWS1/S3CJOBPRIORITY

The priority of the specified job.

io_progresssummary TYPE REF TO /AWS1/CL_S3CJOBPROGRESSSUMMARY /AWS1/CL_S3CJOBPROGRESSSUMMARY

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.

iv_statusupdatereason TYPE /AWS1/S3CJOBSTATUSUPDATEREASON /AWS1/S3CJOBSTATUSUPDATEREASON

The reason for updating the job.

it_failurereasons TYPE /AWS1/CL_S3CJOBFAILURE=>TT_JOBFAILURELIST TT_JOBFAILURELIST

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

io_report TYPE REF TO /AWS1/CL_S3CJOBREPORT /AWS1/CL_S3CJOBREPORT

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

iv_creationtime TYPE /AWS1/S3CJOBCREATIONTIME /AWS1/S3CJOBCREATIONTIME

A timestamp indicating when this job was created.

iv_terminationdate TYPE /AWS1/S3CJOBTERMINATIONDATE /AWS1/S3CJOBTERMINATIONDATE

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

iv_rolearn TYPE /AWS1/S3CIAMROLEARN /AWS1/S3CIAMROLEARN

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

iv_suspendeddate TYPE /AWS1/S3CSUSPENDEDDATE /AWS1/S3CSUSPENDEDDATE

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

iv_suspendedcause TYPE /AWS1/S3CSUSPENDEDCAUSE /AWS1/S3CSUSPENDEDCAUSE

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.

io_manifestgenerator TYPE REF TO /AWS1/CL_S3CJOBMANIFESTGENER00 /AWS1/CL_S3CJOBMANIFESTGENER00

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

io_generatedmanifestdescri00 TYPE REF TO /AWS1/CL_S3CS3GENERATEDMANIF00 /AWS1/CL_S3CS3GENERATEDMANIF00

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

---

Queryable Attributes

JobId

The ID for the specified job.

Accessible with the following methods

Method	Description
GET_JOBID()	Getter for JOBID, with configurable default
ASK_JOBID()	Getter for JOBID w/ exceptions if field has no value
HAS_JOBID()	Determine if JOBID has a value

ConfirmationRequired

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.

Accessible with the following methods

Method	Description
GET_CONFIRMATIONREQUIRED()	Getter for CONFIRMATIONREQUIRED, with configurable default
ASK_CONFIRMATIONREQUIRED()	Getter for CONFIRMATIONREQUIRED w/ exceptions if field has n
HAS_CONFIRMATIONREQUIRED()	Determine if CONFIRMATIONREQUIRED has a value

Description

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

Accessible with the following methods

Method	Description
GET_DESCRIPTION()	Getter for DESCRIPTION, with configurable default
ASK_DESCRIPTION()	Getter for DESCRIPTION w/ exceptions if field has no value
HAS_DESCRIPTION()	Determine if DESCRIPTION has a value

JobArn

The Amazon Resource Name (ARN) for this job.

Accessible with the following methods

Method	Description
GET_JOBARN()	Getter for JOBARN, with configurable default
ASK_JOBARN()	Getter for JOBARN w/ exceptions if field has no value
HAS_JOBARN()	Determine if JOBARN has a value

Status

The current status of the specified job.

Accessible with the following methods

Method	Description
GET_STATUS()	Getter for STATUS, with configurable default
ASK_STATUS()	Getter for STATUS w/ exceptions if field has no value
HAS_STATUS()	Determine if STATUS has a value

Manifest

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

Accessible with the following methods

Method	Description
GET_MANIFEST()	Getter for MANIFEST

Operation

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

Accessible with the following methods

Method	Description
GET_OPERATION()	Getter for OPERATION

Priority

The priority of the specified job.

Accessible with the following methods

Method	Description
GET_PRIORITY()	Getter for PRIORITY

ProgressSummary

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.

Accessible with the following methods

Method	Description
GET_PROGRESSSUMMARY()	Getter for PROGRESSSUMMARY

StatusUpdateReason

The reason for updating the job.

Accessible with the following methods

Method	Description
GET_STATUSUPDATEREASON()	Getter for STATUSUPDATEREASON, with configurable default
ASK_STATUSUPDATEREASON()	Getter for STATUSUPDATEREASON w/ exceptions if field has no
HAS_STATUSUPDATEREASON()	Determine if STATUSUPDATEREASON has a value

FailureReasons

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

Accessible with the following methods

Method	Description
GET_FAILUREREASONS()	Getter for FAILUREREASONS, with configurable default
ASK_FAILUREREASONS()	Getter for FAILUREREASONS w/ exceptions if field has no valu
HAS_FAILUREREASONS()	Determine if FAILUREREASONS has a value

Report

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

Accessible with the following methods

Method	Description
GET_REPORT()	Getter for REPORT

CreationTime

A timestamp indicating when this job was created.

Accessible with the following methods

Method	Description
GET_CREATIONTIME()	Getter for CREATIONTIME, with configurable default
ASK_CREATIONTIME()	Getter for CREATIONTIME w/ exceptions if field has no value
HAS_CREATIONTIME()	Determine if CREATIONTIME has a value

TerminationDate

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

Accessible with the following methods

Method	Description
GET_TERMINATIONDATE()	Getter for TERMINATIONDATE, with configurable default
ASK_TERMINATIONDATE()	Getter for TERMINATIONDATE w/ exceptions if field has no val
HAS_TERMINATIONDATE()	Determine if TERMINATIONDATE has a value

RoleArn

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

Accessible with the following methods

Method	Description
GET_ROLEARN()	Getter for ROLEARN, with configurable default
ASK_ROLEARN()	Getter for ROLEARN w/ exceptions if field has no value
HAS_ROLEARN()	Determine if ROLEARN has a value

SuspendedDate

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

Accessible with the following methods

Method	Description
GET_SUSPENDEDDATE()	Getter for SUSPENDEDDATE, with configurable default
ASK_SUSPENDEDDATE()	Getter for SUSPENDEDDATE w/ exceptions if field has no value
HAS_SUSPENDEDDATE()	Determine if SUSPENDEDDATE has a value

SuspendedCause

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.

Accessible with the following methods

Method	Description
GET_SUSPENDEDCAUSE()	Getter for SUSPENDEDCAUSE, with configurable default
ASK_SUSPENDEDCAUSE()	Getter for SUSPENDEDCAUSE w/ exceptions if field has no valu
HAS_SUSPENDEDCAUSE()	Determine if SUSPENDEDCAUSE has a value

ManifestGenerator

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

Accessible with the following methods

Method	Description
GET_MANIFESTGENERATOR()	Getter for MANIFESTGENERATOR

GeneratedManifestDescriptor

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

Accessible with the following methods

Method	Description
GET_GENERATEDMANIFESTDESCR00()	Getter for GENERATEDMANIFESTDESCRIPTOR