openapi: 3.1.0
info:
  title: Amazon QuickSight API
  description: >-
    The Amazon QuickSight API enables programmatic management of
    QuickSight resources including dashboards, datasets, data sources,
    analyses, templates, users, and groups. You can also embed analytics
    into your applications.
  version: '2018-04-01'
  contact:
    name: AWS Support
    url: https://aws.amazon.com/premiumsupport/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: https://a0.awsstatic.com/libra-css/images/logos/aws_logo_smile_1200x630.png
servers:
  - url: https://quicksight.{region}.amazonaws.com
    description: Amazon QuickSight regional endpoint
    variables:
      region:
        default: us-east-1
        description: AWS region
        enum:
          - us-east-1
          - us-east-2
          - us-west-2
          - eu-west-1
          - eu-west-2
          - eu-central-1
          - ap-northeast-1
          - ap-northeast-2
          - ap-southeast-1
          - ap-southeast-2
security:
  - sigv4: []
tags:
  - name: Dashboards
    description: Operations for creating and managing dashboards
  - name: Datasets
    description: Operations for managing datasets
paths:
  /accounts/{AwsAccountId}/dashboards:
    get:
      operationId: ListDashboards
      summary: Amazon QuickSight List dashboards
      description: Lists dashboards in an AWS account.
      tags:
        - Dashboards
      parameters:
        - name: AwsAccountId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Dashboards listed successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  DashboardSummaryList:
                    type: array
                    items:
                      $ref: '#/components/schemas/DashboardSummary'
  /accounts/{AwsAccountId}/dashboards/{DashboardId}:
    get:
      operationId: DescribeDashboard
      summary: Amazon QuickSight Describe a dashboard
      description: Provides a summary for a dashboard.
      tags:
        - Dashboards
      parameters:
        - name: AwsAccountId
          in: path
          required: true
          schema:
            type: string
        - name: DashboardId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Dashboard details retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dashboard'
  /accounts/{AwsAccountId}/data-sets:
    get:
      operationId: ListDataSets
      summary: Amazon QuickSight List datasets
      description: Lists all datasets in the current AWS account.
      tags:
        - Datasets
      parameters:
        - name: AwsAccountId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Datasets listed successfully
components:
  securitySchemes:
    sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4
  schemas:
    DashboardSummary:
      type: object
      properties:
        Arn:
          type: string
        DashboardId:
          type: string
        Name:
          type: string
        CreatedTime:
          type: string
          format: date-time
        LastUpdatedTime:
          type: string
          format: date-time
        PublishedVersionNumber:
          type: integer
        LastPublishedTime:
          type: string
          format: date-time
    Dashboard:
      type: object
      properties:
        DashboardId:
          type: string
        Arn:
          type: string
        Name:
          type: string
        Version:
          type: object
          properties:
            VersionNumber:
              type: integer
            Status:
              type: string
              enum:
                - CREATION_IN_PROGRESS
                - CREATION_SUCCESSFUL
                - CREATION_FAILED
                - UPDATE_IN_PROGRESS
                - UPDATE_SUCCESSFUL
                - UPDATE_FAILED
            CreatedTime:
              type: string
              format: date-time
        CreatedTime:
          type: string
          format: date-time
        LastPublishedTime:
          type: string
          format: date-time
        LastUpdatedTime:
          type: string
          format: date-time
    DataSetSummary:
      type: object
      properties:
        Arn:
          type: string
        DataSetId:
          type: string
        Name:
          type: string
        CreatedTime:
          type: string
          format: date-time
        LastUpdatedTime:
          type: string
          format: date-time
        ImportMode:
          type: string
          enum:
            - SPICE
            - DIRECT_QUERY