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.

For more information, see Scheduling and sending Amazon Quick Sight reports by email and Configuring email report settings for a Amazon Quick Sight dashboard in the Amazon Quick Sight User Guide.

See also: AWS API Documentation

Request Syntax

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 Quick Sight console in the Schedules pane of the dashboard that the schedule is configured for.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • Status (integer) –

      The HTTP status of the request

Exceptions