Amazon QuickSight

Amazon QuickSight Quicksight Refresh Properties API

The Quicksight Refresh Properties API from Amazon QuickSight — 1 operation(s) for quicksight refresh properties.

Documentation GitHub OpenAPI

Operations 3

DELETE /accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties Delete Data Set Refresh Properties #

GET /accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties Describe Data Set Refresh Properties #

PUT /accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties Put Data Set Refresh Properties #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/amazon-quicksight/openapi/amazon-quicksight-refresh-properties-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-properties-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 Properties API
  version: '2018-04-01'
  description: Generated from AWS's published Smithy model for Amazon QuickSight. 3 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-properties:
    delete:
      operationId: DeleteDataSetRefreshProperties
      summary: Delete Data Set Refresh Properties
      description: Deletes the dataset refresh properties of the dataset.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteDataSetRefreshPropertiesResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException; LimitExceededException
          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/DeleteDataSetRefreshPropertiesRequest'
      tags:
      - Refresh Properties
    get:
      operationId: DescribeDataSetRefreshProperties
      summary: Describe Data Set Refresh Properties
      description: Describes the refresh properties of a dataset.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeDataSetRefreshPropertiesResponse'
        '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/DescribeDataSetRefreshPropertiesRequest'
      tags:
      - Refresh Properties
    put:
      operationId: PutDataSetRefreshProperties
      summary: Put Data Set Refresh Properties
      description: Creates or updates the dataset refresh properties for the dataset.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutDataSetRefreshPropertiesResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException; LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidParameterValueException; PreconditionNotMetException
          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/PutDataSetRefreshPropertiesRequest'
      tags:
      - Refresh Properties
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.
    DataSetRefreshProperties:
      type: object
      properties:
        RefreshConfiguration:
          $ref: '#/components/schemas/RefreshConfiguration'
        FailureConfiguration:
          $ref: '#/components/schemas/RefreshFailureConfiguration'
    DeleteDataSetRefreshPropertiesRequest:
      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
    DeleteDataSetRefreshPropertiesResponse:
      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.
    DescribeDataSetRefreshPropertiesRequest:
      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
    DescribeDataSetRefreshPropertiesResponse:
      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.
        DataSetRefreshProperties:
          $ref: '#/components/schemas/DataSetRefreshProperties'
    IncrementalRefresh:
      type: object
      properties:
        LookbackWindow:
          $ref: '#/components/schemas/LookbackWindow'
      required:
      - LookbackWindow
    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.
    LookbackWindow:
      type: object
      properties:
        ColumnName:
          type: string
          description: The name of the lookback window column.
        Size:
          type: integer
          description: The lookback window column size.
        SizeUnit:
          type: string
          enum:
          - HOUR
          - DAY
          - WEEK
          description: The size unit that is used for the lookback window column. Valid values for this structure are HOUR,
            DAY, and WEEK.
      required:
      - ColumnName
      - Size
      - SizeUnit
    PutDataSetRefreshPropertiesRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The Amazon Web Services account ID.
        DataSetId:
          type: string
          description: The ID of the dataset.
        DataSetRefreshProperties:
          $ref: '#/components/schemas/DataSetRefreshProperties'
      required:
      - AwsAccountId
      - DataSetId
      - DataSetRefreshProperties
    PutDataSetRefreshPropertiesResponse:
      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.
    RefreshConfiguration:
      type: object
      properties:
        IncrementalRefresh:
          $ref: '#/components/schemas/IncrementalRefresh'
      required:
      - IncrementalRefresh
    RefreshFailureConfiguration:
      type: object
      properties:
        EmailAlert:
          $ref: '#/components/schemas/RefreshFailureEmailAlert'
    RefreshFailureEmailAlert:
      type: object
      properties:
        AlertStatus:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: The status value that determines if email alerts are sent.
    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.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
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)