/AWS1/CL_QSTDSCDASHBOARDSNAP03¶
DescribeDashboardSnapshotJobResultResponse
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_arn TYPE /AWS1/QSTARN /AWS1/QSTARN¶
The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a
StartDashboardSnapshotJobAPI call.
iv_jobstatus TYPE /AWS1/QSTSNAPSHOTJOBSTATUS /AWS1/QSTSNAPSHOTJOBSTATUS¶
Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a
COMPLETEDorFAILEDstatus.
iv_createdtime TYPE /AWS1/QSTTIMESTAMP /AWS1/QSTTIMESTAMP¶
The time that a snapshot job was created.
iv_lastupdatedtime TYPE /AWS1/QSTTIMESTAMP /AWS1/QSTTIMESTAMP¶
The time that a snapshot job status was last updated.
io_result TYPE REF TO /AWS1/CL_QSTSNAPSHOTJOBRESULT /AWS1/CL_QSTSNAPSHOTJOBRESULT¶
The result of the snapshot job. Jobs that have successfully completed will return the S3Uri where they are located. Jobs that have failedwill return information on the error that caused the job to fail.
io_errorinfo TYPE REF TO /AWS1/CL_QSTSNAPJOBERRORINFO /AWS1/CL_QSTSNAPJOBERRORINFO¶
Displays information for the error that caused a job to fail.
iv_requestid TYPE /AWS1/QSTNONEMPTYSTRING /AWS1/QSTNONEMPTYSTRING¶
The Amazon Web Services request ID for this operation.
iv_status TYPE /AWS1/QSTSTATUSCODE /AWS1/QSTSTATUSCODE¶
The HTTP status of the request
Queryable Attributes¶
Arn¶
The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a
StartDashboardSnapshotJobAPI call.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
JobStatus¶
Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a
COMPLETEDorFAILEDstatus.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_JOBSTATUS() |
Getter for JOBSTATUS, with configurable default |
ASK_JOBSTATUS() |
Getter for JOBSTATUS w/ exceptions if field has no value |
HAS_JOBSTATUS() |
Determine if JOBSTATUS has a value |
CreatedTime¶
The time that a snapshot job was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDTIME() |
Getter for CREATEDTIME, with configurable default |
ASK_CREATEDTIME() |
Getter for CREATEDTIME w/ exceptions if field has no value |
HAS_CREATEDTIME() |
Determine if CREATEDTIME has a value |
LastUpdatedTime¶
The time that a snapshot job status was last updated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTUPDATEDTIME() |
Getter for LASTUPDATEDTIME, with configurable default |
ASK_LASTUPDATEDTIME() |
Getter for LASTUPDATEDTIME w/ exceptions if field has no val |
HAS_LASTUPDATEDTIME() |
Determine if LASTUPDATEDTIME has a value |
Result¶
The result of the snapshot job. Jobs that have successfully completed will return the S3Uri where they are located. Jobs that have failedwill return information on the error that caused the job to fail.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESULT() |
Getter for RESULT |
ErrorInfo¶
Displays information for the error that caused a job to fail.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ERRORINFO() |
Getter for ERRORINFO |
RequestId¶
The Amazon Web Services request ID for this operation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REQUESTID() |
Getter for REQUESTID, with configurable default |
ASK_REQUESTID() |
Getter for REQUESTID w/ exceptions if field has no value |
HAS_REQUESTID() |
Determine if REQUESTID has a value |
Status¶
The HTTP status of the request
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS |