Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

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 <SnapshotjobId> has not reached a terminal state..

Request Syntax


GET /accounts/AwsAccountId/dashboards/DashboardId/snapshot-jobs/SnapshotJobId/result HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The ID of the AWS account that the dashboard snapshot job is executed in.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

DashboardId

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

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [\w\-]+

Required: Yes

SnapshotJobId

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

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [\w\-]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "Arn": "string",
   "CreatedTime": number,
   "ErrorInfo": { 
      "ErrorMessage": "string",
      "ErrorType": "string"
   },
   "JobStatus": "string",
   "LastUpdatedTime": number,
   "RequestId": "string",
   "Result": { 
      "AnonymousUsers": [ 
         { 
            "FileGroups": [ 
               { 
                  "Files": [ 
                     { 
                        "FormatType": "string",
                        "SheetSelections": [ 
                           { 
                              "SelectionScope": "string",
                              "SheetId": "string",
                              "VisualIds": [ "string" ]
                           }
                        ]
                     }
                  ],
                  "S3Results": [ 
                     { 
                        "ErrorInfo": [ 
                           { 
                              "ErrorMessage": "string",
                              "ErrorType": "string"
                           }
                        ],
                        "S3DestinationConfiguration": { 
                           "BucketConfiguration": { 
                              "BucketName": "string",
                              "BucketPrefix": "string",
                              "BucketRegion": "string"
                           }
                        },
                        "S3Uri": "string"
                     }
                  ]
               }
            ]
         }
      ]
   }
}

Response Elements

If the action is successful, the service sends back the following HTTP response.

Status: The HTTP status of the request

The following data is returned in JSON format by the service.

Arn

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.

Type: String

CreatedTime

The time that a snapshot job was created.

Type: Timestamp

ErrorInfo

Displays information for the error that caused a job to fail.

Type: SnapshotJobErrorInfo object

JobStatus

Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a COMPLETED or FAILED status.

Type: String

Valid Values: QUEUED | RUNNING | COMPLETED | FAILED

LastUpdatedTime

The time that a snapshot job status was last updated.

Type: Timestamp

RequestId

The AWS request ID for this operation.

Type: String

Pattern: .*\S.*

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.

Type: SnapshotJobResult object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.

HTTP Status Code: 401

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters has a value that isn't valid.

HTTP Status Code: 400

PreconditionNotMetException

One or more preconditions aren't met.

HTTP Status Code: 400

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ThrottlingException

Access is throttled.

HTTP Status Code: 429

UnsupportedUserEditionException

This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

HTTP Status Code: 403