Amazon QuickSight Quicksight Schedules API
The Quicksight Schedules API from Amazon QuickSight — 3 operation(s) for quicksight schedules.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-quicksight:amazon-quicksight-schedules-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.1.0
info:
title: Amazon QuickSight Schedules API
version: '2018-04-01'
description: Generated from AWS's published Smithy model for Amazon QuickSight. 6 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://quicksight.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
paths:
/accounts/{AwsAccountId}/topics/{TopicId}/schedules:
post:
operationId: CreateTopicRefreshSchedule
summary: Create Topic Refresh Schedule
description: Creates a topic refresh schedule.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTopicRefreshScheduleResponse'
'401':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException; LimitExceededException; ResourceExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'400':
description: InvalidParameterValueException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValueException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTopicRefreshScheduleRequest'
tags:
- Schedules
get:
operationId: ListTopicRefreshSchedules
summary: List Topic Refresh Schedules
description: Lists all of the refresh schedules for a topic.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListTopicRefreshSchedulesResponse'
'401':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException; LimitExceededException; ResourceExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'400':
description: InvalidParameterValueException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValueException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListTopicRefreshSchedulesRequest'
tags:
- Schedules
/accounts/{AwsAccountId}/topics/{TopicId}/schedules/{DatasetId}:
delete:
operationId: DeleteTopicRefreshSchedule
summary: Delete Topic Refresh Schedule
description: Deletes a topic refresh schedule.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteTopicRefreshScheduleResponse'
'401':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException; LimitExceededException; ResourceExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'400':
description: InvalidParameterValueException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValueException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteTopicRefreshScheduleRequest'
tags:
- Schedules
get:
operationId: DescribeTopicRefreshSchedule
summary: Describe Topic Refresh Schedule
description: Deletes a topic refresh schedule.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeTopicRefreshScheduleResponse'
'401':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException; LimitExceededException; ResourceExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'400':
description: InvalidParameterValueException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValueException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeTopicRefreshScheduleRequest'
tags:
- Schedules
put:
operationId: UpdateTopicRefreshSchedule
summary: Update Topic Refresh Schedule
description: Updates a topic refresh schedule.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTopicRefreshScheduleResponse'
'401':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException; LimitExceededException; ResourceExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'400':
description: InvalidParameterValueException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValueException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTopicRefreshScheduleRequest'
tags:
- Schedules
/accounts/{AwsAccountId}/dashboards/{DashboardId}/schedules/{ScheduleId}:
post:
operationId: StartDashboardSnapshotJobSchedule
summary: Start Dashboard Snapshot Job Schedule
description: 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartDashboardSnapshotJobScheduleResponse'
'401':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'400':
description: InvalidParameterValueException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValueException'
'409':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'403':
description: UnsupportedUserEditionException
content:
application/json:
schema:
$ref: '#/components/schemas/UnsupportedUserEditionException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StartDashboardSnapshotJobScheduleRequest'
tags:
- Schedules
components:
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: quicksight
schemas:
AccessDeniedException:
type: object
properties:
Message:
type: string
RequestId:
type: string
description: The Amazon Web Services request ID for this request.
ConflictException:
type: object
properties:
Message:
type: string
RequestId:
type: string
description: The Amazon Web Services request ID for this request.
CreateTopicRefreshScheduleRequest:
type: object
properties:
AwsAccountId:
type: string
description: The ID of the Amazon Web Services account that contains the topic you're creating a refresh schedule
for.
TopicId:
type: string
description: The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each
Amazon Web Services account.
DatasetArn:
type: string
description: The Amazon Resource Name (ARN) of the dataset.
DatasetName:
type: string
description: The name of the dataset.
RefreshSchedule:
$ref: '#/components/schemas/TopicRefreshSchedule'
required:
- AwsAccountId
- TopicId
- DatasetArn
- RefreshSchedule
CreateTopicRefreshScheduleResponse:
type: object
properties:
TopicId:
type: string
description: The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each
Amazon Web Services account.
TopicArn:
type: string
description: The Amazon Resource Name (ARN) of the topic.
DatasetArn:
type: string
description: The Amazon Resource Name (ARN) of the dataset.
Status:
type: integer
description: The HTTP status of the request.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
DeleteTopicRefreshScheduleRequest:
type: object
properties:
AwsAccountId:
type: string
description: The Amazon Web Services account ID.
TopicId:
type: string
description: The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each
Amazon Web Services account.
DatasetId:
type: string
description: The ID of the dataset.
required:
- AwsAccountId
- TopicId
- DatasetId
DeleteTopicRefreshScheduleResponse:
type: object
properties:
TopicId:
type: string
description: The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each
Amazon Web Services account.
TopicArn:
type: string
description: The Amazon Resource Name (ARN) of the topic.
DatasetArn:
type: string
description: The Amazon Resource Name (ARN) of the dataset.
Status:
type: integer
description: The HTTP status of the request.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
DescribeTopicRefreshScheduleRequest:
type: object
properties:
AwsAccountId:
type: string
description: The Amazon Web Services account ID.
TopicId:
type: string
description: The ID of the topic that contains the refresh schedule that you want to describe. This ID is unique
per Amazon Web Services Region for each Amazon Web Services account.
DatasetId:
type: string
description: The ID of the dataset.
required:
- AwsAccountId
- TopicId
- DatasetId
DescribeTopicRefreshScheduleResponse:
type: object
properties:
TopicId:
type: string
description: The ID of the topic that contains the refresh schedule that you want to describe. This ID is unique
per Amazon Web Services Region for each Amazon Web Services account.
TopicArn:
type: string
description: The Amazon Resource Name (ARN) of the topic.
DatasetArn:
type: string
description: The Amazon Resource Name (ARN) of the dataset.
RefreshSchedule:
$ref: '#/components/schemas/TopicRefreshSchedule'
Status:
type: integer
description: The HTTP status of the request.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
InternalFailureException:
type: object
properties:
Message:
type: string
RequestId:
type: string
description: The Amazon Web Services request ID for this request.
InvalidParameterValueException:
type: object
properties:
Message:
type: string
RequestId:
type: string
description: The Amazon Web Services request ID for this request.
LimitExceededException:
type: object
properties:
Message:
type: string
ResourceType:
type: string
enum:
- USER
- GROUP
- NAMESPACE
- ACCOUNT_SETTINGS
- IAMPOLICY_ASSIGNMENT
- DATA_SOURCE
- DATA_SET
- VPC_CONNECTION
- INGESTION
description: Limit exceeded.
RequestId:
type: string
description: The Amazon Web Services request ID for this request.
ListTopicRefreshSchedulesRequest:
type: object
properties:
AwsAccountId:
type: string
description: The ID of the Amazon Web Services account that contains the topic whose refresh schedule you want described.
TopicId:
type: string
description: The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for
each Amazon Web Services account.
required:
- AwsAccountId
- TopicId
ListTopicRefreshSchedulesResponse:
type: object
properties:
TopicId:
type: string
description: The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for
each Amazon Web Services account.
TopicArn:
type: string
description: The Amazon Resource Name (ARN) of the topic.
RefreshSchedules:
type: array
items:
$ref: '#/components/schemas/TopicRefreshScheduleSummary'
description: The list of topic refresh schedules.
Status:
type: integer
description: The HTTP status of the request.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
ResourceNotFoundException:
type: object
properties:
Message:
type: string
ResourceType:
type: string
enum:
- USER
- GROUP
- NAMESPACE
- ACCOUNT_SETTINGS
- IAMPOLICY_ASSIGNMENT
- DATA_SOURCE
- DATA_SET
- VPC_CONNECTION
- INGESTION
description: The resource type for this request.
RequestId:
type: string
description: The Amazon Web Services request ID for this request.
StartDashboardSnapshotJobScheduleRequest:
type: object
properties:
AwsAccountId:
type: string
description: The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
DashboardId:
type: string
description: The ID of the dashboard that you want to start a snapshot job schedule for.
ScheduleId:
type: string
description: 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.
required:
- AwsAccountId
- DashboardId
- ScheduleId
StartDashboardSnapshotJobScheduleResponse:
type: object
properties:
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
Status:
type: integer
description: The HTTP status of the request
ThrottlingException:
type: object
properties:
Message:
type: string
RequestId:
type: string
description: The Amazon Web Services request ID for this request.
TopicRefreshSchedule:
type: object
properties:
IsEnabled:
type: boolean
description: A Boolean value that controls whether to schedule is enabled.
BasedOnSpiceSchedule:
type: boolean
description: A Boolean value that controls whether to schedule runs at the same schedule that is specified in SPICE
dataset.
StartingAt:
type: string
format: date-time
description: The starting date and time for the refresh schedule.
Timezone:
type: string
description: The timezone that you want the refresh schedule to use.
RepeatAt:
type: string
description: The time of day when the refresh should run, for example, Monday-Sunday.
TopicScheduleType:
type: string
enum:
- HOURLY
- DAILY
- WEEKLY
- MONTHLY
description: The type of refresh schedule. Valid values for this structure are HOURLY, DAILY, WEEKLY, and MONTHLY.
required:
- IsEnabled
- BasedOnSpiceSchedule
TopicRefreshScheduleSummary:
type: object
properties:
DatasetId:
type: string
description: The ID of the dataset.
DatasetArn:
type: string
description: The Amazon Resource Name (ARN) of the dataset.
DatasetName:
type: string
description: The name of the dataset.
RefreshSchedule:
$ref: '#/components/schemas/TopicRefreshSchedule'
UnsupportedUserEditionException:
type: object
properties:
Message:
type: string
RequestId:
type: string
description: The Amazon Web Services request ID for this request.
UpdateTopicRefreshScheduleRequest:
type: object
properties:
AwsAccountId:
type: string
description: The ID of the Amazon Web Services account that contains the topic whose refresh schedule you want to
update.
TopicId:
type: string
description: The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each
Amazon Web Services account.
DatasetId:
type: string
description: The ID of the dataset.
RefreshSchedule:
$ref: '#/components/schemas/TopicRefreshSchedule'
required:
- AwsAccountId
- TopicId
- DatasetId
- RefreshSchedule
UpdateTopicRefreshScheduleResponse:
type: object
properties:
TopicId:
type: string
description: The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each
Amazon Web Services account.
TopicArn:
type: string
description: The Amazon Resource Name (ARN) of the topic.
DatasetArn:
type: string
description: The Amazon Resource Name (ARN) of the dataset.
Status:
type: integer
description: The HTTP status of the request.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/quicksight/service/2018-04-01/quicksight-2018-04-01.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)