Amazon QuickSight

Amazon QuickSight Quicksight Ingestions API

The Quicksight Ingestions API from Amazon QuickSight — 2 operation(s) for quicksight ingestions.

Documentation GitHub OpenAPI

Operations 4

DELETE /accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId} Cancel Ingestion #

PUT /accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId} Create Ingestion #

GET /accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId} Describe Ingestion #

GET /accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions List Ingestions #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/amazon-quicksight/openapi/amazon-quicksight-ingestions-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-ingestions-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 Ingestions API
  version: '2018-04-01'
  description: Generated from AWS's published Smithy model for Amazon QuickSight. 4 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}/ingestions/{IngestionId}:
    delete:
      operationId: CancelIngestion
      summary: Cancel Ingestion
      description: Cancels an ongoing ingestion of data into SPICE.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelIngestionResponse'
        '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: ResourceExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceExistsException'
        '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/CancelIngestionRequest'
      tags:
      - Ingestions
    put:
      operationId: CreateIngestion
      summary: Create Ingestion
      description: Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise
        edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times
        in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time. Any ingestions
        operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How
        do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge
        Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateIngestionResponse'
        '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; 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/CreateIngestionRequest'
      tags:
      - Ingestions
    get:
      operationId: DescribeIngestion
      summary: Describe Ingestion
      description: Describes a SPICE ingestion.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeIngestionResponse'
        '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: ResourceExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceExistsException'
        '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/DescribeIngestionRequest'
      tags:
      - Ingestions
  /accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions:
    get:
      operationId: ListIngestions
      summary: List Ingestions
      description: Lists the history of SPICE ingestions for a dataset. Limited to 5 TPS per user and 25 TPS per account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListIngestionsResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidNextTokenException; InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
        '409':
          description: ResourceExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceExistsException'
        '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/ListIngestionsRequest'
      tags:
      - Ingestions
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.
    CancelIngestionRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The Amazon Web Services account ID.
        DataSetId:
          type: string
          description: The ID of the dataset used in the ingestion.
        IngestionId:
          type: string
          description: An ID for the ingestion.
      required:
      - AwsAccountId
      - DataSetId
      - IngestionId
    CancelIngestionResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) for the data ingestion.
        IngestionId:
          type: string
          description: An ID for the ingestion.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
    CreateIngestionRequest:
      type: object
      properties:
        DataSetId:
          type: string
          description: The ID of the dataset used in the ingestion.
        IngestionId:
          type: string
          description: An ID for the ingestion.
        AwsAccountId:
          type: string
          description: The Amazon Web Services account ID.
        IngestionType:
          type: string
          enum:
          - INCREMENTAL_REFRESH
          - FULL_REFRESH
          description: The type of ingestion that you want to create.
      required:
      - DataSetId
      - IngestionId
      - AwsAccountId
    CreateIngestionResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) for the data ingestion.
        IngestionId:
          type: string
          description: An ID for the ingestion.
        IngestionStatus:
          type: string
          enum:
          - INITIALIZED
          - QUEUED
          - RUNNING
          - FAILED
          - COMPLETED
          - CANCELLED
          description: The ingestion status.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
    DescribeIngestionRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The Amazon Web Services account ID.
        DataSetId:
          type: string
          description: The ID of the dataset used in the ingestion.
        IngestionId:
          type: string
          description: An ID for the ingestion.
      required:
      - AwsAccountId
      - DataSetId
      - IngestionId
    DescribeIngestionResponse:
      type: object
      properties:
        Ingestion:
          $ref: '#/components/schemas/Ingestion'
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
    ErrorInfo:
      type: object
      properties:
        Type:
          type: string
          enum:
          - FAILURE_TO_ASSUME_ROLE
          - INGESTION_SUPERSEDED
          - INGESTION_CANCELED
          - DATA_SET_DELETED
          - DATA_SET_NOT_SPICE
          - S3_UPLOADED_FILE_DELETED
          - S3_MANIFEST_ERROR
          - DATA_TOLERANCE_EXCEPTION
          - SPICE_TABLE_NOT_FOUND
          - DATA_SET_SIZE_LIMIT_EXCEEDED
          - ROW_SIZE_LIMIT_EXCEEDED
          - ACCOUNT_CAPACITY_LIMIT_EXCEEDED
          - CUSTOMER_ERROR
          - DATA_SOURCE_NOT_FOUND
          - IAM_ROLE_NOT_AVAILABLE
          - CONNECTION_FAILURE
          - SQL_TABLE_NOT_FOUND
          - PERMISSION_DENIED
          - SSL_CERTIFICATE_VALIDATION_FAILURE
          - OAUTH_TOKEN_FAILURE
          - SOURCE_API_LIMIT_EXCEEDED_FAILURE
          - PASSWORD_AUTHENTICATION_FAILURE
          - SQL_SCHEMA_MISMATCH_ERROR
          - INVALID_DATE_FORMAT
          - INVALID_DATAPREP_SYNTAX
          - SOURCE_RESOURCE_LIMIT_EXCEEDED
          - SQL_INVALID_PARAMETER_VALUE
          - QUERY_TIMEOUT
          - SQL_NUMERIC_OVERFLOW
          - UNRESOLVABLE_HOST
          - UNROUTABLE_HOST
          - SQL_EXCEPTION
          - S3_FILE_INACCESSIBLE
          - IOT_FILE_NOT_FOUND
          - IOT_DATA_SET_FILE_EMPTY
          - INVALID_DATA_SOURCE_CONFIG
          - DATA_SOURCE_AUTH_FAILED
          - DATA_SOURCE_CONNECTION_FAILED
          - FAILURE_TO_PROCESS_JSON_FILE
          - INTERNAL_SERVICE_ERROR
          - REFRESH_SUPPRESSED_BY_EDIT
          - PERMISSION_NOT_FOUND
          - ELASTICSEARCH_CURSOR_NOT_ENABLED
          - CURSOR_NOT_ENABLED
          - DUPLICATE_COLUMN_NAMES_FOUND
          description: Error type.
        Message:
          type: string
          description: Error message.
    Ingestion:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the resource.
        IngestionId:
          type: string
          description: Ingestion ID.
        IngestionStatus:
          type: string
          enum:
          - INITIALIZED
          - QUEUED
          - RUNNING
          - FAILED
          - COMPLETED
          - CANCELLED
          description: Ingestion status.
        ErrorInfo:
          $ref: '#/components/schemas/ErrorInfo'
        RowInfo:
          $ref: '#/components/schemas/RowInfo'
        QueueInfo:
          $ref: '#/components/schemas/QueueInfo'
        CreatedTime:
          type: string
          format: date-time
          description: The time that this ingestion started.
        IngestionTimeInSeconds:
          type: integer
          description: The time that this ingestion took, measured in seconds.
        IngestionSizeInBytes:
          type: integer
          description: The size of the data ingested, in bytes.
        RequestSource:
          type: string
          enum:
          - MANUAL
          - SCHEDULED
          description: Event source for this ingestion.
        RequestType:
          type: string
          enum:
          - INITIAL_INGESTION
          - EDIT
          - INCREMENTAL_REFRESH
          - FULL_REFRESH
          description: Type of this ingestion.
      required:
      - Arn
      - IngestionStatus
      - CreatedTime
    InternalFailureException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    InvalidNextTokenException:
      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.
    ListIngestionsRequest:
      type: object
      properties:
        DataSetId:
          type: string
          description: The ID of the dataset used in the ingestion.
        NextToken:
          type: string
          description: The token for the next set of results, or null if there are no more results.
        AwsAccountId:
          type: string
          description: The Amazon Web Services account ID.
        MaxResults:
          type: integer
          description: The maximum number of results to be returned per request.
      required:
      - DataSetId
      - AwsAccountId
    ListIngestionsResponse:
      type: object
      properties:
        Ingestions:
          type: array
          items:
            $ref: '#/components/schemas/Ingestion'
          description: A list of the ingestions.
        NextToken:
          type: string
          description: The token for the next set of results, or null if there are no more results.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
    QueueInfo:
      type: object
      properties:
        WaitingOnIngestion:
          type: string
          description: The ID of the queued ingestion.
        QueuedIngestion:
          type: string
          description: The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing ingestion to complete.
      required:
      - WaitingOnIngestion
      - QueuedIngestion
    ResourceExistsException:
      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.
    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.
    RowInfo:
      type: object
      properties:
        RowsIngested:
          type: integer
          description: The number of rows that were ingested.
        RowsDropped:
          type: integer
          description: The number of rows that were not ingested.
        TotalRowsInDataset:
          type: integer
          description: The total number of rows in the dataset.
    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)