Amazon QuickSight

Amazon QuickSight Quicksight Vpc Connections API

The Quicksight Vpc Connections API from Amazon QuickSight — 2 operation(s) for quicksight vpc connections.

Documentation GitHub OpenAPI

Business capability

IT Infrastructure Management BC-600.50

Operations 5

POST /accounts/{AwsAccountId}/vpc-connections Create VPCConnection #

GET /accounts/{AwsAccountId}/vpc-connections List VPCConnections #

DELETE /accounts/{AwsAccountId}/vpc-connections/{VPCConnectionId} Delete VPCConnection #

GET /accounts/{AwsAccountId}/vpc-connections/{VPCConnectionId} Describe VPCConnection #

PUT /accounts/{AwsAccountId}/vpc-connections/{VPCConnectionId} Update VPCConnection #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/amazon-quicksight/openapi/amazon-quicksight-vpc-connections-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-vpc-connections-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 Vpc Connections 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}/vpc-connections:
    post:
      operationId: CreateVPCConnection
      summary: Create VPCConnection
      description: Creates a new VPC connection.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateVPCConnectionResponse'
        '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'
        '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/CreateVPCConnectionRequest'
      tags:
      - Vpc Connections
    get:
      operationId: ListVPCConnections
      summary: List VPCConnections
      description: Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services
        account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListVPCConnectionsResponse'
        '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'
        '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/ListVPCConnectionsRequest'
      tags:
      - Vpc Connections
  /accounts/{AwsAccountId}/vpc-connections/{VPCConnectionId}:
    delete:
      operationId: DeleteVPCConnection
      summary: Delete VPCConnection
      description: Deletes a VPC connection.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteVPCConnectionResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          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'
        '403':
          description: UnsupportedUserEditionException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedUserEditionException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteVPCConnectionRequest'
      tags:
      - Vpc Connections
    get:
      operationId: DescribeVPCConnection
      summary: Describe VPCConnection
      description: Describes a VPC connection.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeVPCConnectionResponse'
        '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'
        '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/DescribeVPCConnectionRequest'
      tags:
      - Vpc Connections
    put:
      operationId: UpdateVPCConnection
      summary: Update VPCConnection
      description: Updates a VPC connection.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateVPCConnectionResponse'
        '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'
        '403':
          description: UnsupportedUserEditionException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedUserEditionException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateVPCConnectionRequest'
      tags:
      - Vpc Connections
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.
    CreateVPCConnectionRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The Amazon Web Services account ID of the account where you want to create a new VPC connection.
        VPCConnectionId:
          type: string
          description: The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web
            Services Region in an Amazon Web Services account.
        Name:
          type: string
          description: The display name for the VPC connection.
        SubnetIds:
          type: array
          items:
            type: string
          description: A list of subnet IDs for the VPC connection.
        SecurityGroupIds:
          type: array
          items:
            type: string
          description: A list of security group IDs for the VPC connection.
        DnsResolvers:
          type: array
          items:
            type: string
          description: A list of IP addresses of DNS resolver endpoints for the VPC connection.
        RoleArn:
          type: string
          description: The IAM role to associate with the VPC connection.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A map of the key-value pairs for the resource tag or tags assigned to the VPC connection.
      required:
      - AwsAccountId
      - VPCConnectionId
      - Name
      - SubnetIds
      - SecurityGroupIds
      - RoleArn
    CreateVPCConnectionResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the VPC connection.
        VPCConnectionId:
          type: string
          description: The ID for the VPC connection that you're creating. This ID is unique per Amazon Web Services Region
            for each Amazon Web Services account.
        CreationStatus:
          type: string
          enum:
          - CREATION_IN_PROGRESS
          - CREATION_SUCCESSFUL
          - CREATION_FAILED
          - UPDATE_IN_PROGRESS
          - UPDATE_SUCCESSFUL
          - UPDATE_FAILED
          - DELETION_IN_PROGRESS
          - DELETION_FAILED
          - DELETED
          description: The status of the creation of the VPC connection.
        AvailabilityStatus:
          type: string
          enum:
          - AVAILABLE
          - UNAVAILABLE
          - PARTIALLY_AVAILABLE
          description: The availability status of the VPC connection.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
    DeleteVPCConnectionRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The Amazon Web Services account ID of the account where you want to delete a VPC connection.
        VPCConnectionId:
          type: string
          description: The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web
            Services Region in an Amazon Web Services account.
      required:
      - AwsAccountId
      - VPCConnectionId
    DeleteVPCConnectionResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the deleted VPC connection.
        VPCConnectionId:
          type: string
          description: The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web
            Services Region in an Amazon Web Services account.
        DeletionStatus:
          type: string
          enum:
          - CREATION_IN_PROGRESS
          - CREATION_SUCCESSFUL
          - CREATION_FAILED
          - UPDATE_IN_PROGRESS
          - UPDATE_SUCCESSFUL
          - UPDATE_FAILED
          - DELETION_IN_PROGRESS
          - DELETION_FAILED
          - DELETED
          description: The deletion status of the VPC connection.
        AvailabilityStatus:
          type: string
          enum:
          - AVAILABLE
          - UNAVAILABLE
          - PARTIALLY_AVAILABLE
          description: The availability status of the VPC connection.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
    DescribeVPCConnectionRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The Amazon Web Services account ID of the account that contains the VPC connection that you want described.
        VPCConnectionId:
          type: string
          description: The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web
            Services Region in an Amazon Web Services account.
      required:
      - AwsAccountId
      - VPCConnectionId
    DescribeVPCConnectionResponse:
      type: object
      properties:
        VPCConnection:
          $ref: '#/components/schemas/VPCConnection'
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
    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.
    ListVPCConnectionsRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The Amazon Web Services account ID of the account that contains the VPC connections that you want to
            list.
        NextToken:
          type: string
          description: The token for the next set of results, or null if there are no more results.
        MaxResults:
          type: integer
          description: The maximum number of results to be returned per request.
      required:
      - AwsAccountId
    ListVPCConnectionsResponse:
      type: object
      properties:
        VPCConnectionSummaries:
          type: array
          items:
            $ref: '#/components/schemas/VPCConnectionSummary'
          description: A VPCConnectionSummaries object that returns a summary of VPC connection objects.
        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.
    NetworkInterface:
      type: object
      properties:
        SubnetId:
          type: string
          description: The subnet ID associated with the network interface.
        AvailabilityZone:
          type: string
          description: The availability zone that the network interface resides in.
        ErrorMessage:
          type: string
          description: An error message.
        Status:
          type: string
          enum:
          - CREATING
          - AVAILABLE
          - CREATION_FAILED
          - UPDATING
          - UPDATE_FAILED
          - DELETING
          - DELETED
          - DELETION_FAILED
          - DELETION_SCHEDULED
          - ATTACHMENT_FAILED_ROLLBACK_FAILED
          description: The status of the network interface.
        NetworkInterfaceId:
          type: string
          description: The network interface ID.
    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.
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: Tag key.
        Value:
          type: string
          description: Tag value.
      required:
      - Key
      - Value
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    UnsupportedUserEditionException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    UpdateVPCConnectionRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The Amazon Web Services account ID of the account that contains the VPC connection that you want to
            update.
        VPCConnectionId:
          type: string
          description: The ID of the VPC connection that you're updating. This ID is a unique identifier for each Amazon Web
            Services Region in an Amazon Web Services account.
        Name:
          type: string
          description: The display name for the VPC connection.
        SubnetIds:
          type: array
          items:
            type: string
          description: A list of subnet IDs for the VPC connection.
        SecurityGroupIds:
          type: array
          items:
            type: string
          description: A list of security group IDs for the VPC connection.
        DnsResolvers:
          type: array
          items:
            type: string
          description: A list of IP addresses of DNS resolver endpoints for the VPC connection.
        RoleArn:
          type: string
          description: An IAM role associated with the VPC connection.
      required:
      - AwsAccountId
      - VPCConnectionId
      - Name
      - SubnetIds
      - SecurityGroupIds
      - RoleArn
    UpdateVPCConnectionResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the VPC connection.
        VPCConnectionId:
          type: string
          description: The ID of the VPC connection that you are updating. This ID is a unique identifier for each Amazon
            Web Services Region in anAmazon Web Services account.
        UpdateStatus:
          type: string
          enum:
          - CREATION_IN_PROGRESS
          - CREATION_SUCCESSFUL
          - CREATION_FAILED
          - UPDATE_IN_PROGRESS
          - UPDATE_SUCCESSFUL
          - UPDATE_FAILED
          - DELETION_IN_PROGRESS
          - DELETION_FAILED
          - DELETED
          description: The update status of the VPC connection's last update.
        AvailabilityStatus:
          type: string
          enum:
          - AVAILABLE
          - UNAVAILABLE
          - PARTIALLY_AVAILABLE
          description: The availability status of the VPC connection.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
    VPCConnection:
      type: object
      properties:
        VPCConnectionId:
          type: string
          description: The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web
            Services Region in an Amazon Web Services account.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the VPC connection.
        Name:
          type: string
          description: The display name for the VPC connection.
        VPCId:
          type: string
          description: The Amazon EC2 VPC ID associated with the VPC connection.
        SecurityGroupIds:
          type: array
          items:
            type: string
          description: The Amazon EC2 security group IDs associated with the VPC connection.
        DnsResolvers:
          type: array
          items:
            type: string
          description: A list of IP addresses of DNS resolver endpoints for the VPC connection.
        Status:
          type: string
          enum:
          - CREATION_IN_PROGRESS
          - CREATION_SUCCESSFUL
          - CREATION_FAILED
          - UPDATE_IN_PROGRESS
          - UPDATE_SUCCESSFUL
          - UPDATE_FAILED
          - DELETION_IN_PROGRESS
          - DELETION_FAILED
          - DELETED
          description: The status of the VPC connection.
        AvailabilityStatus:
          type: string
          enum:
          - AVAILABLE
          - UNAVAILABLE
          - PARTIALLY_AVAILABLE
          description: The availability status of the VPC connection.
        NetworkInterfaces:
          type: array
          items:
            $ref: '#/components/schemas/NetworkInterface'
          description: A list of network interfaces.
        RoleArn:
          type: string
          description: The ARN of the IAM role associated with the VPC connection.
        CreatedTime:
          type: string
          format: date-time
          description: The time that the VPC connection was created.
        LastUpdatedTime:
          type: string
          format: date-time
          description: The time that the VPC connection was last updated.
    VPCConnectionSummary:
      type: object
      properties:
        VPCConnectionId:
          type: string
          description: The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web
            Services Region in an Amazon Web Services account.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the VPC connection.
        Name:
          type: string
          description: The display name for the VPC connection.
        VPCId:
          type: string
          description: The Amazon EC2 VPC ID associated with the VPC connection.
        SecurityGroupIds:
          type: array
          items:
            type: string
          description: The Amazon EC2 security group IDs associated with the VPC connection.
        DnsResolvers:
          type: array
          items:
            type: string
          description: A list of IP addresses of DNS resolver endpoints for the VPC connection.
        Status:
          type: string
          enum:
          - CREATION_IN_PROGRESS
          - CREATION_SUCCESSFUL
          - CREATION_FAILED
          - UPDATE_IN_PROGRESS
          - UPDATE_SUCCESSFUL
          - UPDATE_FAILED
          - DELETION_IN_PROGRESS
          - DELETION_FAILED
          - DELETED
          description: The status of the VPC connection.
        AvailabilityStatus:
          type: string
          enum:
          - AVAILABLE
          - UNAVAILABLE
          - PARTIALLY_AVAILABLE
          description: The availability status of the VPC connection.
        NetworkInterfaces:
          type: array
          items:
            $ref: '#/components/schemas/NetworkInterface'
          description: A list of network interfaces.
        RoleArn:
          type: string
          description: The ARN of the IAM role associated with the VPC connection.
        CreatedTime:
          type: string
          format: date-time
          description: The time that the VPC connection was created.
        LastUpdatedTime:
          type: string
          format: date-time
          description: The time that the VPC connection was last updated.
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)