Amazon QuickSight

Amazon QuickSight Quicksight Refresh Schedules API

The Quicksight Refresh Schedules API from Amazon QuickSight — 2 operation(s) for quicksight refresh schedules.

Documentation GitHub OpenAPI

Operations 5

POST /accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules Create Refresh Schedule #

GET /accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules List Refresh Schedules #

PUT /accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules Update Refresh Schedule #

DELETE /accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId} Delete Refresh Schedule #

GET /accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId} Describe Refresh Schedule #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/amazon-quicksight/openapi/amazon-quicksight-refresh-schedules-api-openapi.yml

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.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-quicksight:amazon-quicksight-refresh-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.1.0
info:
  title: Amazon QuickSight Refresh Schedules API
  version: '2018-04-01'
  description: Generated from AWS's published Smithy model for Amazon QuickSight. 5 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}/data-sets/{DataSetId}/refresh-schedules:
    post:
      operationId: CreateRefreshSchedule
      summary: Create Refresh Schedule
      description: Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateRefreshScheduleResponse'
        '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; PreconditionNotMetException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '409':
          description: LimitExceededException; ResourceExistsException
          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'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRefreshScheduleRequest'
      tags:
      - Refresh Schedules
    get:
      operationId: ListRefreshSchedules
      summary: List Refresh Schedules
      description: Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListRefreshSchedulesResponse'
        '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'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListRefreshSchedulesRequest'
      tags:
      - Refresh Schedules
    put:
      operationId: UpdateRefreshSchedule
      summary: Update Refresh Schedule
      description: Updates a refresh schedule for a dataset.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateRefreshScheduleResponse'
        '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; PreconditionNotMetException
          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'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRefreshScheduleRequest'
      tags:
      - Refresh Schedules
  /accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId}:
    delete:
      operationId: DeleteRefreshSchedule
      summary: Delete Refresh Schedule
      description: Deletes a refresh schedule from a dataset.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteRefreshScheduleResponse'
        '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'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteRefreshScheduleRequest'
      tags:
      - Refresh Schedules
    get:
      operationId: DescribeRefreshSchedule
      summary: Describe Refresh Schedule
      description: Provides a summary of a refresh schedule.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeRefreshScheduleResponse'
        '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'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeRefreshScheduleRequest'
      tags:
      - Refresh 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.
    CreateRefreshScheduleRequest:
      type: object
      properties:
        DataSetId:
          type: string
          description: The ID of the dataset.
        AwsAccountId:
          type: string
          description: The Amazon Web Services account ID.
        Schedule:
          $ref: '#/components/schemas/RefreshSchedule'
      required:
      - DataSetId
      - AwsAccountId
      - Schedule
    CreateRefreshScheduleResponse:
      type: object
      properties:
        Status:
          type: integer
          description: The HTTP status of the request.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        ScheduleId:
          type: string
          description: The ID of the refresh schedule.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) for the refresh schedule.
    DeleteRefreshScheduleRequest:
      type: object
      properties:
        DataSetId:
          type: string
          description: The ID of the dataset.
        AwsAccountId:
          type: string
          description: The Amazon Web Services account ID.
        ScheduleId:
          type: string
          description: The ID of the refresh schedule.
      required:
      - DataSetId
      - AwsAccountId
      - ScheduleId
    DeleteRefreshScheduleResponse:
      type: object
      properties:
        Status:
          type: integer
          description: The HTTP status of the request.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        ScheduleId:
          type: string
          description: The ID of the refresh schedule.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) for the refresh schedule.
    DescribeRefreshScheduleRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The Amazon Web Services account ID.
        DataSetId:
          type: string
          description: The ID of the dataset.
        ScheduleId:
          type: string
          description: The ID of the refresh schedule.
      required:
      - AwsAccountId
      - DataSetId
      - ScheduleId
    DescribeRefreshScheduleResponse:
      type: object
      properties:
        RefreshSchedule:
          $ref: '#/components/schemas/RefreshSchedule'
        Status:
          type: integer
          description: The HTTP status of the request.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) for the refresh schedule.
    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.
    ListRefreshSchedulesRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The Amazon Web Services account ID.
        DataSetId:
          type: string
          description: The ID of the dataset.
      required:
      - AwsAccountId
      - DataSetId
    ListRefreshSchedulesResponse:
      type: object
      properties:
        RefreshSchedules:
          type: array
          items:
            $ref: '#/components/schemas/RefreshSchedule'
          description: The list of refresh schedules for 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.
    RefreshFrequency:
      type: object
      properties:
        Interval:
          type: string
          enum:
          - MINUTE15
          - MINUTE30
          - HOURLY
          - DAILY
          - WEEKLY
          - MONTHLY
          description: 'The interval between scheduled refreshes. Valid values are as follows: MINUTE15: The dataset refreshes
            every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one
            schedule per dataset. MINUTE30:The dataset refreshes every 30 minutes. This value is only supported for incremental
            refreshes. This interval can only be used for one schedule per dataset. HOURLY: The dataset refreshes every hour.
            This interval can only be used for one schedule per dataset. DAILY: The dataset refreshes every day. WEEKLY: The
            dataset refreshes every week. MONTHLY: Th'
        RefreshOnDay:
          $ref: '#/components/schemas/ScheduleRefreshOnEntity'
        Timezone:
          type: string
          description: The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding
            ID found on java.util.time.getAvailableIDs().
        TimeOfTheDay:
          type: string
          description: The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This
            field is not required for schedules that refresh hourly.
      required:
      - Interval
    RefreshSchedule:
      type: object
      properties:
        ScheduleId:
          type: string
          description: An identifier for the refresh schedule.
        ScheduleFrequency:
          $ref: '#/components/schemas/RefreshFrequency'
        StartAfterDateTime:
          type: string
          format: date-time
          description: Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.
        RefreshType:
          type: string
          enum:
          - INCREMENTAL_REFRESH
          - FULL_REFRESH
          description: 'The type of refresh that a datset undergoes. Valid values are as follows: FULL_REFRESH: A complete
            refresh of a dataset. INCREMENTAL_REFRESH: A partial refresh of some rows of a dataset, based on the time window
            specified. For more information on full and incremental refreshes, see Refreshing SPICE data in the Amazon Quick
            Suite User Guide.'
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) for the refresh schedule.
      required:
      - ScheduleId
      - ScheduleFrequency
      - RefreshType
    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.
    ScheduleRefreshOnEntity:
      type: object
      properties:
        DayOfWeek:
          type: string
          enum:
          - SUNDAY
          - MONDAY
          - TUESDAY
          - WEDNESDAY
          - THURSDAY
          - FRIDAY
          - SATURDAY
          description: The day of the week that you want to schedule a refresh on.
        DayOfMonth:
          type: string
          description: The day of the month that you want to schedule refresh on.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    UpdateRefreshScheduleRequest:
      type: object
      properties:
        DataSetId:
          type: string
          description: The ID of the dataset.
        AwsAccountId:
          type: string
          description: The Amazon Web Services account ID.
        Schedule:
          $ref: '#/components/schemas/RefreshSchedule'
      required:
      - DataSetId
      - AwsAccountId
      - Schedule
    UpdateRefreshScheduleResponse:
      type: object
      properties:
        Status:
          type: integer
          description: The HTTP status of the request.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        ScheduleId:
          type: string
          description: The ID of the refresh schedule.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) for the refresh schedule.
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)