Amazon EC2 Ec2 Transit Gateway Route Table API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Transit Gateway Route Table API
  version: '2016-11-15'
  description: Generated from AWS's published Smithy model for Amazon Elastic Compute Cloud. 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://ec2.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Transit Gateway Route Table
paths:
  /?Action=AssociateTransitGatewayRouteTable:
    post:
      operationId: AssociateTransitGatewayRouteTable
      summary: Associate Transit Gateway Route Table
      description: Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AssociateTransitGatewayRouteTableResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: AssociateTransitGatewayRouteTable
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/AssociateTransitGatewayRouteTableRequest'
      tags:
      - Transit Gateway Route Table
  /?Action=CreateTransitGatewayRouteTable:
    post:
      operationId: CreateTransitGatewayRouteTable
      summary: Create Transit Gateway Route Table
      description: Creates a route table for the specified transit gateway.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateTransitGatewayRouteTableResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateTransitGatewayRouteTable
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateTransitGatewayRouteTableRequest'
      tags:
      - Transit Gateway Route Table
  /?Action=DeleteTransitGatewayRouteTable:
    post:
      operationId: DeleteTransitGatewayRouteTable
      summary: Delete Transit Gateway Route Table
      description: Deletes the specified transit gateway route table. Before you can delete a transit gateway route table, you must disassociate all attachments from it by using DisassociateTransitGatewayRouteTable and wait for the disassociations to complete. You can't delete a transit gateway route table that is the default association route table or default propagation route table for the transit gateway. To change the default route tables, use ModifyTransitGateway.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteTransitGatewayRouteTableResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteTransitGatewayRouteTable
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteTransitGatewayRouteTableRequest'
      tags:
      - Transit Gateway Route Table
  /?Action=DescribeTransitGatewayRouteTables:
    post:
      operationId: DescribeTransitGatewayRouteTables
      summary: Describe Transit Gateway Route Tables
      description: Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeTransitGatewayRouteTablesResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeTransitGatewayRouteTables
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeTransitGatewayRouteTablesRequest'
      tags:
      - Transit Gateway Route Table
  /?Action=DisassociateTransitGatewayRouteTable:
    post:
      operationId: DisassociateTransitGatewayRouteTable
      summary: Disassociate Transit Gateway Route Table
      description: Disassociates a resource attachment from a transit gateway route table.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DisassociateTransitGatewayRouteTableResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DisassociateTransitGatewayRouteTable
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DisassociateTransitGatewayRouteTableRequest'
      tags:
      - Transit Gateway Route Table
components:
  schemas:
    DeleteTransitGatewayRouteTableRequest:
      type: object
      properties:
        TransitGatewayRouteTableId:
          type: string
          description: The ID of the transit gateway route table.
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
      required:
      - TransitGatewayRouteTableId
    DescribeTransitGatewayRouteTablesRequest:
      type: object
      properties:
        TransitGatewayRouteTableIds:
          type: array
          items:
            type: string
          description: The IDs of the transit gateway route tables.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: 'One or more filters. The possible values are: default-association-route-table - Indicates whether this is the default association route table for the transit gateway (true | false). default-propagation-route-table - Indicates whether this is the default propagation route table for the transit gateway (true | false). state - The state of the route table (available | deleting | deleted | pending). transit-gateway-id - The ID of the transit gateway. transit-gateway-route-table-id - The ID of the transit gateway route table.'
        MaxResults:
          type: integer
          description: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
        NextToken:
          type: string
          description: The token for the next page of results.
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
    AssociateTransitGatewayRouteTableResult:
      type: object
      properties:
        Association:
          $ref: '#/components/schemas/TransitGatewayAssociation'
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: 'The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.'
        Value:
          type: string
          description: 'The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.'
    DeleteTransitGatewayRouteTableResult:
      type: object
      properties:
        TransitGatewayRouteTable:
          $ref: '#/components/schemas/TransitGatewayRouteTable'
    DisassociateTransitGatewayRouteTableRequest:
      type: object
      properties:
        TransitGatewayRouteTableId:
          type: string
          description: The ID of the transit gateway route table.
        TransitGatewayAttachmentId:
          type: string
          description: The ID of the attachment.
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
      required:
      - TransitGatewayRouteTableId
      - TransitGatewayAttachmentId
    TransitGatewayAssociation:
      type: object
      properties:
        TransitGatewayRouteTableId:
          type: string
          description: The ID of the transit gateway route table.
        TransitGatewayAttachmentId:
          type: string
          description: The ID of the attachment.
        ResourceId:
          type: string
          description: The ID of the resource.
        ResourceType:
          type: string
          enum:
          - vpc
          - vpn
          - vpn-concentrator
          - direct-connect-gateway
          - connect
          - peering
          - tgw-peering
          - network-function
          - client-vpn
          description: The resource type. Note that the tgw-peering resource type has been deprecated.
        State:
          type: string
          enum:
          - associating
          - associated
          - disassociating
          - disassociated
          description: The state of the association.
    DisassociateTransitGatewayRouteTableResult:
      type: object
      properties:
        Association:
          $ref: '#/components/schemas/TransitGatewayAssociation'
    Filter:
      type: object
      properties:
        Name:
          type: string
          description: The name of the filter. Filter names are case-sensitive.
        Values:
          type: array
          items:
            type: string
          description: The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
    CreateTransitGatewayRouteTableResult:
      type: object
      properties:
        TransitGatewayRouteTable:
          $ref: '#/components/schemas/TransitGatewayRouteTable'
    TagSpecification:
      type: object
      properties:
        ResourceType:
          type: string
          enum:
          - capacity-reservation
          - client-vpn-endpoint
          - customer-gateway
          - carrier-gateway
          - coip-pool
          - declarative-policies-report
          - dedicated-host
          - dhcp-options
          - egress-only-internet-gateway
          - elastic-ip
          - elastic-gpu
          - export-image-task
          - export-instance-task
          - fleet
          - fpga-image
          - host-reservation
          - image
          - image-usage-report
          - import-image-task
          - import-snapshot-task
          - instance
          - instance-event-window
          - internet-gateway
          - ipam
          - ipam-pool
          - ipam-scope
          - ipv4pool-ec2
          - ipv6pool-ec2
          - key-pair
          - launch-template
          - local-gateway
          - local-gateway-route-table
          - local-gateway-virtual-interface
          - local-gateway-virtual-interface-group
          - local-gateway-route-table-vpc-association
          - local-gateway-route-table-virtual-interface-group-association
          - natgateway
          - network-acl
          - network-interface
          - network-insights-analysis
          - network-insights-path
          - network-insights-access-scope
          - network-insights-access-scope-analysis
          - outpost-lag
          - placement-group
          - prefix-list
          - replace-root-volume-task
          - reserved-instances
          - route-table
          - security-group
          - security-group-rule
          - service-link-virtual-interface
          - snapshot
          - spot-fleet-request
          - spot-instances-request
          - subnet
          - subnet-cidr-reservation
          - traffic-mirror-filter
          - traffic-mirror-session
          - traffic-mirror-target
          - transit-gateway
          - transit-gateway-attachment
          - transit-gateway-connect-peer
          - transit-gateway-multicast-domain
          - transit-gateway-policy-table
          - transit-gateway-metering-policy
          - transit-gateway-route-table
          - transit-gateway-route-table-announcement
          - volume
          - vpc
          - vpc-endpoint
          - vpc-endpoint-connection
          - vpc-endpoint-service
          - vpc-endpoint-service-permission
          - vpc-peering-connection
          - vpn-connection
          - vpn-gateway
          - vpc-flow-log
          - capacity-reservation-fleet
          - traffic-mirror-filter-rule
          - vpc-endpoint-connection-device-type
          - verified-access-instance
          - verified-access-group
          - verified-access-endpoint
          - verified-access-policy
          - verified-access-trust-provider
          - vpn-connection-device-type
          - vpc-block-public-access-exclusion
          - vpc-encryption-control
          - route-server
          - route-server-endpoint
          - route-server-peer
          - ipam-resource-discovery
          - ipam-resource-discovery-association
          - instance-connect-endpoint
          - verified-access-endpoint-target
          - ipam-external-resource-verification-token
          - capacity-block
          - mac-modification-task
          - ipam-prefix-list-resolver
          - ipam-policy
          - ipam-prefix-list-resolver-target
          - ipam-internet-registry-association
          - secondary-interface
          - secondary-network
          - secondary-subnet
          - capacity-manager-data-export
          - vpn-concentrator
          - ipam-pool-allocation
          - capacity-reservation-cancellation-quote
          - application-status-check
          - capacity-reservation-modification-quote
          description: The type of resource to tag on creation.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags to apply to the resource.
    AssociateTransitGatewayRouteTableRequest:
      type: object
      properties:
        TransitGatewayRouteTableId:
          type: string
          description: The ID of the transit gateway route table.
        TransitGatewayAttachmentId:
          type: string
          description: The ID of the attachment.
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
      required:
      - TransitGatewayRouteTableId
      - TransitGatewayAttachmentId
    TransitGatewayRouteTable:
      type: object
      properties:
        TransitGatewayRouteTableId:
          type: string
          description: The ID of the transit gateway route table.
        TransitGatewayId:
          type: string
          description: The ID of the transit gateway.
        State:
          type: string
          enum:
          - pending
          - available
          - deleting
          - deleted
          description: The state of the transit gateway route table.
        DefaultAssociationRouteTable:
          type: boolean
          description: Indicates whether this is the default association route table for the transit gateway.
        DefaultPropagationRouteTable:
          type: boolean
          description: Indicates whether this is the default propagation route table for the transit gateway.
        CreationTime:
          type: string
          format: date-time
          description: The creation time.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Any tags assigned to the route table.
    DescribeTransitGatewayRouteTablesResult:
      type: object
      properties:
        TransitGatewayRouteTables:
          type: array
          items:
            $ref: '#/components/schemas/TransitGatewayRouteTable'
          description: Information about the transit gateway route tables.
        NextToken:
          type: string
          description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
    CreateTransitGatewayRouteTableRequest:
      type: object
      properties:
        TransitGatewayId:
          type: string
          description: The ID of the transit gateway.
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to apply to the transit gateway route table.
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
      required:
      - TransitGatewayId
  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: ec2
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/ec2/service/2016-11-15/ec2-2016-11-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)