StartDashboardSnapshotJob

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.

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

Quick Sight 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 AWS 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, Quick Sight throttles the API calls to maintin an optimal experience and reliability for all Quick Sight users.

Common throttling scenarios

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

If your use case requires a higher throttling limit, contact your account admin or AWSSupport 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 Quick Sight 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:

Registered user support

You can generate snapshots for registered Quick Sight users by using the Snapshot Job APIs with identity-enhanced IAM role session credentials. This approach allows you to create snapshots on behalf of specific Quick Sight users while respecting their row-level security (RLS), column-level security (CLS), dynamic default parameters and dashboard parameter/filter settings.

To generate snapshots for registered Quick Sight users, you need to:

Identity-enhanced credentials are credentials that contain information about the end user (e.g., registered Quick Sight user).

If your Quick Sight users are backed by AWS Identity Center, then you need to set up a trusted token issuer. Then, getting identity-enhanced IAM credentials for a Quick Sight user will look like the following:

For more details, see IdC documentation on Identity-enhanced IAM role sessions.

To obtain Identity-enhanced credentials for Quick Sight native users, IAM federated users, or Active Directory users, follow the steps below:

After obtaining the identity-enhanced IAM role session credentials, you can use them to start a job, describe the job and describe job result. You can use the same credentials as long as they haven't expired. All API requests made with these credentials are considered to be made by the impersonated Quick Sight user.

Possible error scenarios

The request fails with an Access Denied error in the following scenarios:

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.

Request Body

The request accepts the following data in JSON format.

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 following data is returned in JSON format by the service.

Errors

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

See Also

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