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

DescribeDashboardSnapshotJob

Describes an existing snapshot job.

Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see JobStatus.

Request Syntax


GET /accounts/AwsAccountId/dashboards/DashboardId/snapshot-jobs/SnapshotJobId 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 200
Content-type: application/json

{
   "Arn": "string",
   "AwsAccountId": "string",
   "CreatedTime": number,
   "DashboardId": "string",
   "JobStatus": "string",
   "LastUpdatedTime": number,
   "RequestId": "string",
   "SnapshotConfiguration": { 
      "DestinationConfiguration": { 
         "S3Destinations": [ 
            { 
               "BucketConfiguration": { 
                  "BucketName": "string",
                  "BucketPrefix": "string",
                  "BucketRegion": "string"
               }
            }
         ]
      },
      "FileGroups": [ 
         { 
            "Files": [ 
               { 
                  "FormatType": "string",
                  "SheetSelections": [ 
                     { 
                        "SelectionScope": "string",
                        "SheetId": "string",
                        "VisualIds": [ "string" ]
                     }
                  ]
               }
            ]
         }
      ],
      "Parameters": { 
         "DateTimeParameters": [ 
            { 
               "Name": "string",
               "Values": [ number ]
            }
         ],
         "DecimalParameters": [ 
            { 
               "Name": "string",
               "Values": [ number ]
            }
         ],
         "IntegerParameters": [ 
            { 
               "Name": "string",
               "Values": [ number ]
            }
         ],
         "StringParameters": [ 
            { 
               "Name": "string",
               "Values": [ "string" ]
            }
         ]
      }
   },
   "SnapshotJobId": "string",
   "Status": number,
   "UserConfiguration": { 
      "AnonymousUsers": [ 
         { 
            "RowLevelPermissionTagKeys": [ "string" ]
         }
      ]
   }
}

Response Elements

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

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

AwsAccountId

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

Type: String

Length Constraints: Fixed length of 12.

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

CreatedTime

The time that the snapshot job was created.

Type: Timestamp

DashboardId

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

Type: String

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

Pattern: [\w\-]+

JobStatus

Indicates the status of a job. The status updates as the job executes. This shows one of the following values.

COMPLETED - The job was completed successfully.
FAILED - The job failed to execute.
QUEUED - The job is queued and hasn't started yet.
RUNNING - The job is still running.

Type: String

Valid Values: QUEUED | RUNNING | COMPLETED | FAILED

LastUpdatedTime

The time that the snapshot job status was last updated.

Type: Timestamp

RequestId

The AWS request ID for this operation.

Type: String

Pattern: .*\S.*

SnapshotConfiguration

The snapshot configuration of the job. This information is provided when you make a StartDashboardSnapshotJob API call.

Type: SnapshotConfiguration object

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.

Type: String

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

Pattern: [\w\-]+

Status

The HTTP status of the request

Type: Integer

UserConfiguration

The user configuration for the snapshot job. This information is provided when you make a StartDashboardSnapshotJob API call.

Type: SnapshotUserConfigurationRedacted 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

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