How to get SnapshotJobId for using snapshot apis

Question & Answer
, , ,
1

For this api,

response = client.describe_dashboard_snapshot_job(
    AwsAccountId='string',
    DashboardId='string',
    SnapshotJobId='string'
)

From where do I get this SnapshotJobId?

I tried getting it from the Schedules pane by clicking ‘Details’

image
image512×257 30.8 KB

but when I use it to make this api call, it is throwing an error:
botocore.errorfactory.ResourceNotFoundException: An error occurred (ResourceNotFoundException) when calling the DescribeDashboardSnapshotJobResult operation: Requested dashboard snapshot job could not be found.

2

Hi @lakshmisruthi and welcome to the QuickSight community!
To get the SnapshotJobId, you will need to use the start_dashboard_snapshot_job API to create one:

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/quicksight/client/start_dashboard_snapshot_job.html

Let me know if you have any additional questions!

3

Hi @Brett ,

Thankyou for your response.

My purpose is to pause and unpause snapshot email schedules via API (dependent on another task), which, until now, we have been doing manually on UI. As far as I’ve seen I could not find any API for that. (If there is please let me know). So I am searching for ways to start the email schedule via API.

I found this start_dashboard_snapshot_job_schedule which is able to send the email.

response = client.start_dashboard_snapshot_job_schedule(
    AwsAccountId='string',
    DashboardId='string',
    ScheduleId='string'
)

Now, I need to get the status of this API call. For that should I use describe_dashboard_snapshot_job_result? If yes, where do I get the SnapshotId for this?
If not please let me know what I should use to get the status…