Amazon VPC Internet Gateways API

Operations for managing internet gateways that connect VPCs to the internet

OpenAPI Specification

amazon-vpc-internet-gateways-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon VPC Internet Gateways API
  description: Amazon Virtual Private Cloud (VPC) lets you provision a logically isolated section of the AWS Cloud where you can launch AWS resources in a virtual network that you define. VPC operations are part of the Amazon EC2 API and use the EC2 query-based API pattern.
  version: '2016-11-15'
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  termsOfService: https://aws.amazon.com/service-terms/
servers:
- url: https://ec2.{region}.amazonaws.com
  description: Amazon EC2 Regional Endpoint (VPC operations)
  variables:
    region:
      default: us-east-1
      description: AWS Region
security:
- sigv4Auth: []
tags:
- name: Internet Gateways
  description: Operations for managing internet gateways that connect VPCs to the internet
paths:
  /?Action=CreateInternetGateway:
    get:
      operationId: createInternetGateway
      summary: Amazon VPC Create an Internet Gateway
      description: Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using AttachInternetGateway.
      tags:
      - Internet Gateways
      parameters: []
      responses:
        '200':
          description: Successfully created internet gateway
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/CreateInternetGatewayResponse'
        '400':
          description: Invalid request parameters
        '401':
          description: Authentication failure
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=AttachInternetGateway:
    get:
      operationId: attachInternetGateway
      summary: Amazon VPC Attach an Internet Gateway to a VPC
      description: Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC.
      tags:
      - Internet Gateways
      parameters:
      - name: InternetGatewayId
        in: query
        required: true
        description: The ID of the internet gateway
        schema:
          type: string
        example: example-id
      - name: VpcId
        in: query
        required: true
        description: The ID of the VPC
        schema:
          type: string
        example: example-id
      responses:
        '200':
          description: Successfully attached internet gateway
        '400':
          description: Invalid request parameters
        '401':
          description: Authentication failure
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    InternetGateway:
      type: object
      description: Describes an internet gateway
      properties:
        internetGatewayId:
          type: string
          description: The ID of the internet gateway
        attachments:
          type: array
          description: Any VPCs attached to the internet gateway
          items:
            type: object
            properties:
              state:
                type: string
                description: The current state of the attachment
                enum:
                - attaching
                - attached
                - detaching
                - detached
              vpcId:
                type: string
                description: The ID of the VPC
        ownerId:
          type: string
          description: The ID of the AWS account that owns the internet gateway
        tags:
          type: array
          description: Any tags assigned to the internet gateway
          items:
            $ref: '#/components/schemas/Tag'
    CreateInternetGatewayResponse:
      type: object
      description: Response from the CreateInternetGateway action
      properties:
        internetGateway:
          $ref: '#/components/schemas/InternetGateway'
    Tag:
      type: object
      description: Describes a tag
      properties:
        key:
          type: string
          description: The key of the tag
        value:
          type: string
          description: The value of the tag
  securitySchemes:
    sigv4Auth:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication
externalDocs:
  description: Amazon VPC API Reference
  url: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/OperationList-query-vpc.html