Amazon VPN AWS VPN API (Amazon EC2 Query API Subset) API

The AWS VPN API (Amazon EC2 Query API Subset) API from Amazon VPN — 1 operation(s) for aws vpn api (amazon ec2 query api subset).

OpenAPI Specification

amazon-vpn-aws-vpn-api-amazon-ec2-query-api-subset-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS VPN API (Amazon EC2 Query API subset) AWS VPN API (Amazon EC2 Query API Subset) AWS VPN API (Amazon EC2 Query API Subset) AWS VPN API (Amazon EC2 Query API Subset) API
  version: '2016-11-15'
  description: 'AWS Site-to-Site VPN and Client VPN operations exposed through the

    Amazon EC2 Query API. Manage VPN connections, customer gateways,

    virtual private gateways, and Client VPN endpoints between

    on-premises networks, remote users, and Amazon VPC.

    All requests use HTTP POST with form-encoded query parameters

    (`Action=<Name>`) against the regional EC2 endpoint, signed with

    AWS Signature Version 4 (SigV4).

    '
  contact:
    name: Amazon Web Services
    url: https://docs.aws.amazon.com/vpn/latest/s2svpn/
servers:
- url: https://ec2.{region}.amazonaws.com
  description: Amazon EC2 regional endpoint
  variables:
    region:
      default: us-east-1
      description: AWS region identifier.
security:
- SigV4: []
tags:
- name: AWS VPN API (Amazon EC2 Query API Subset)
paths:
  /:
    post:
      summary: Invoke an EC2 VPN action
      description: 'All AWS VPN operations are invoked by POSTing form-encoded

        parameters with `Action=<OperationName>` and `Version=2016-11-15`

        to the regional EC2 endpoint.

        '
      operationId: invokeVpnAction
      parameters:
      - in: query
        name: Action
        required: true
        schema:
          type: string
          enum:
          - CreateVpnConnection
          - DescribeVpnConnections
          - DeleteVpnConnection
          - ModifyVpnConnection
          - ModifyVpnConnectionOptions
          - ModifyVpnTunnelCertificate
          - ModifyVpnTunnelOptions
          - CreateVpnConnectionRoute
          - DeleteVpnConnectionRoute
          - CreateCustomerGateway
          - DescribeCustomerGateways
          - DeleteCustomerGateway
          - CreateVpnGateway
          - DescribeVpnGateways
          - DeleteVpnGateway
          - AttachVpnGateway
          - DetachVpnGateway
          - EnableVgwRoutePropagation
          - DisableVgwRoutePropagation
          - CreateClientVpnEndpoint
          - DescribeClientVpnEndpoints
          - DeleteClientVpnEndpoint
          - ModifyClientVpnEndpoint
          - AssociateClientVpnTargetNetwork
          - DisassociateClientVpnTargetNetwork
          - AuthorizeClientVpnIngress
          - RevokeClientVpnIngress
          - ImportClientVpnClientCertificateRevocationList
          - ExportClientVpnClientCertificateRevocationList
          - CreateClientVpnRoute
          - DeleteClientVpnRoute
          - DescribeClientVpnConnections
          - TerminateClientVpnConnections
      - in: query
        name: Version
        required: true
        schema:
          type: string
          enum:
          - '2016-11-15'
      requestBody:
        required: false
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              description: Action-specific parameters.
      responses:
        '200':
          description: Action-specific XML response.
          content:
            text/xml:
              schema:
                type: object
        '400':
          description: Client error.
        '500':
          description: Server error.
      tags:
      - AWS VPN API (Amazon EC2 Query API Subset)
components:
  securitySchemes:
    SigV4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4 signed request.