QuickSight / Client / start_dashboard_snapshot_job_schedule

start_dashboard_snapshot_job_schedule#

QuickSight.Client.start_dashboard_snapshot_job_schedule(**kwargs)#

Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email.

Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a 202 HTTP status code.

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

Parameters:

AwsAccountId (string) –
[REQUIRED]

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
DashboardId (string) –
[REQUIRED]

The ID of the dashboard that you want to start a snapshot job schedule for.
ScheduleId (string) –
[REQUIRED]

The ID of the schedule that you want to start a snapshot job schedule for. The schedule ID can be found in the Amazon QuickSight console in the Schedules pane of the dashboard that the schedule is configured for.

Return type:

dict

Returns:

{
    'RequestId': 'string',
    'Status': 123
}