Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StartDashboardSnapshotJobSchedule

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 QuickSight reports by email and Configuring email report settings for a Amazon QuickSight dashboard in the Amazon QuickSight User Guide.

Request Syntax


POST /accounts/AwsAccountId/dashboards/DashboardId/schedules/ScheduleId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

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

Length Constraints: Fixed length of 12.

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

Required: Yes

DashboardId

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

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

Pattern: [\w\-]+

Required: Yes

ScheduleId

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.

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

Pattern: [\w\-]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "RequestId": "string"
}

Response Elements

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

Status: The HTTP status of the request

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

RequestId

The AWS request ID for this operation.

Type: String

Pattern: .*\S.*

Errors

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

AccessDeniedException

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

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidParameterValueException

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

HTTP Status Code: 400

LimitExceededException

A limit is exceeded.

HTTP Status Code: 409

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ThrottlingException

Access is throttled.

HTTP Status Code: 429

UnsupportedUserEditionException

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