Amazon Transit Gateway Transit Gateways API

The Transit Gateways API from Amazon Transit Gateway — 3 operation(s) for transit gateways.

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

amazon-transit-gateway-transit-gateways-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Transit Gateway Route Tables Transit Gateways API
  description: Amazon Transit Gateway connects VPCs and on-premises networks through a central hub. This API provides operations for creating and managing transit gateways, VPC attachments, route tables, peering connections, and multicast domains via the EC2 API.
  version: '2016-11-15'
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/transit-gateway/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  termsOfService: https://aws.amazon.com/service-terms/
  x-logo:
    url: https://a0.awsstatic.com/libra-css/images/logos/aws_logo_smile_1200x630.png
servers:
- url: https://ec2.{region}.amazonaws.com
  description: Amazon EC2 regional endpoint (Transit Gateway operations)
  variables:
    region:
      default: us-east-1
      description: AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-north-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-southeast-1
      - ap-southeast-2
      - ap-south-1
      - sa-east-1
      - ca-central-1
security:
- aws_sig_v4: []
tags:
- name: Transit Gateways
paths:
  /?Action=CreateTransitGateway:
    get:
      operationId: CreateTransitGateway
      summary: Amazon Transit Gateway Create a Transit Gateway
      description: Creates a transit gateway to interconnect VPCs and on-premises networks.
      tags:
      - Transit Gateways
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - CreateTransitGateway
        example: CreateTransitGateway
      - name: Description
        in: query
        schema:
          type: string
        example: example
      - name: Options.AmazonSideAsn
        in: query
        schema:
          type: integer
          format: int64
        example: 1
      - name: Options.AutoAcceptSharedAttachments
        in: query
        schema:
          type: string
          enum:
          - enable
          - disable
        example: enable
      responses:
        '200':
          description: Successful response.
          content:
            text/xml:
              schema:
                type: object
                properties:
                  transitGateway:
                    $ref: '#/components/schemas/TransitGateway'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=DescribeTransitGateways:
    get:
      operationId: DescribeTransitGateways
      summary: Amazon Transit Gateway Describe Transit Gateways
      description: Describes one or more transit gateways.
      tags:
      - Transit Gateways
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
        example: example
      - name: TransitGatewayId
        in: query
        schema:
          type: array
          items:
            type: string
        example: example-id
      - name: MaxResults
        in: query
        schema:
          type: integer
        example: 1
      responses:
        '200':
          description: Successful response.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /?Action=DeleteTransitGateway:
    get:
      operationId: DeleteTransitGateway
      summary: Amazon Transit Gateway Delete a Transit Gateway
      description: Deletes the specified transit gateway.
      tags:
      - Transit Gateways
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
        example: example
      - name: TransitGatewayId
        in: query
        required: true
        schema:
          type: string
        example: example-id
      responses:
        '200':
          description: Successful response.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    TransitGateway:
      type: object
      properties:
        TransitGatewayId:
          type: string
          description: The ID of the transit gateway.
        TransitGatewayArn:
          type: string
          description: The Amazon Resource Name (ARN) of the transit gateway.
        State:
          type: string
          enum:
          - pending
          - available
          - modifying
          - deleting
          - deleted
        OwnerId:
          type: string
        Description:
          type: string
        CreationTime:
          type: string
          format: date-time
  securitySchemes:
    aws_sig_v4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication.
externalDocs:
  description: Amazon Transit Gateway API Reference
  url: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/OperationList-query-tgw.html