StartDashboardSnapshotJob - Amazon QuickSight
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.

  • 1 Paginated PDF

  • 1 Excel workbook that includes up to 5 table or pivot table visuals

  • 5 CSVs from table or pivot table visuals

The status of a submitted job can be polled with the DescribeDashboardSnapshotJob API. When you call the DescribeDashboardSnapshotJob API, check the JobStatus field in the response. Once the job reaches a COMPLETED or FAILED status, use the DescribeDashboardSnapshotJobResult API to obtain the URLs for the generated files. If the job fails, the DescribeDashboardSnapshotJobResult API returns detailed information about the error that occurred.

StartDashboardSnapshotJob API throttling

Amazon QuickSight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the StartDashboardSnapshotJob. By default, 12 jobs can run simlutaneously in one Amazon account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Amazon QuickSight throttles the API calls to maintin an optimal experience and reliability for all Amazon QuickSight users.

Common throttling scenarios

The following list provides information about the most commin throttling scenarios that can occur.

  • A large number of SnapshotExport API jobs are running simultaneously on an Amazon account. When a new StartDashboardSnapshotJob is created and there are already 12 jobs with the RUNNING status, the new job request fails and returns a LimitExceededException error. Wait for a current job to comlpete before you resubmit the new job.

  • A large number of API requests are submitted on an Amazon account. When a user makes more than 10 API calls to the Amazon QuickSight API in one second, a ThrottlingException is returned.

If your use case requires a higher throttling limit, contact your account admin or AmazonSupport to explore options to tailor a more optimal expereince for your account.

Best practices to handle throttling

If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Amazon QuickSight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example (12 minutes * 9 = 108 minutes). Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline.

The time that it takes to process a job can be impacted by the following factors:

  • The dataset type (Direct Query or SPICE).

  • The size of the dataset.

  • The complexity of the calculated fields that are used in the dashboard.

  • The number of visuals that are on a sheet.

  • The types of visuals that are on the sheet.

  • The number of formats and snapshots that are requested in the job configuration.

  • The size of the generated snapshots.

Request Syntax

POST /accounts/AwsAccountId/dashboards/DashboardId/snapshot-jobs HTTP/1.1 Content-type: application/json { "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", "UserConfiguration": { "AnonymousUsers": [ { "RowLevelPermissionTags": [ { "Key": "string", "Value": "string" } ] } ] } }

URI Request Parameters

The request uses the following URI parameters.


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

Length Constraints: Fixed length of 12.

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

Required: Yes


The ID of the dashboard that you want to start a snapshot job for.

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

Pattern: [\w\-]+

Required: Yes

Request Body

The request accepts the following data in JSON format.


A structure that describes the configuration of the dashboard snapshot.

Type: SnapshotConfiguration object

Required: Yes


An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a DescribeDashboardSnapshotJob while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.

Type: String

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

Pattern: [\w\-]+

Required: Yes


A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon QuickSight.

Type: SnapshotUserConfiguration object

Required: Yes

Response Syntax

HTTP/1.1 Status Content-type: application/json { "Arn": "string", "RequestId": "string", "SnapshotJobId": "string" }

Response Elements

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


The HTTP status of the request

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


The Amazon Resource Name (ARN) for the dashboard snapshot job.

Type: String


The Amazon request ID for this operation.

Type: String

Pattern: .*\S.*


The ID of the job. 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\-]+


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


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


An internal failure occurred.

HTTP Status Code: 500


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

HTTP Status Code: 400


A limit is exceeded.

HTTP Status Code: 409


The resource specified already exists.

HTTP Status Code: 409


One or more resources can't be found.

HTTP Status Code: 404


Access is throttled.

HTTP Status Code: 429


This error indicates that you are calling an embedding operation in Amazon QuickSight without the required pricing plan on your Amazon account. Before you can use embedding for anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You can do this on the Manage Amazon QuickSight page.

After capacity pricing is added, you can use the GetDashboardEmbedUrl API operation with the --identity-type ANONYMOUS option.

HTTP Status Code: 403


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

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: