Skip to content

/AWS1/CL_QST=>DESCRDASHBOARDSNAPJOBRESULT()

About DescribeDashboardSnapshotJobResult

Describes the result of an existing snapshot job that has finished running.

A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a DescribeDashboardSnapshotJob API call.

If the job has not finished running, this operation returns a message that says Dashboard Snapshot Job with id has not reached a terminal state..

Method Signature

IMPORTING

Required arguments:

IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID /AWS1/QSTAWSACCOUNTID

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

IV_DASHBOARDID TYPE /AWS1/QSTSHORTRESTRICTIVERES00 /AWS1/QSTSHORTRESTRICTIVERES00

The ID of the dashboard that you have started a snapshot job for.

IV_SNAPSHOTJOBID TYPE /AWS1/QSTSHORTRESTRICTIVERES00 /AWS1/QSTSHORTRESTRICTIVERES00

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_QSTDSCDASHBOARDSNAP03 /AWS1/CL_QSTDSCDASHBOARDSNAP03