Amazon EC2 Ec2 Transit Gateway Policy Table Entry API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Transit Gateway Policy Table…
  version: '2016-11-15'
  description: Generated from AWS's published Smithy model for Amazon Elastic Compute Cloud. 4 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 Policy Table Entry
paths:
  /?Action=CreateTransitGatewayPolicyTableEntry:
    post:
      operationId: CreateTransitGatewayPolicyTableEntry
      summary: Create Transit Gateway Policy Table Entry
      description: Creates an entry in a transit gateway policy table to route matching traffic to a specified route table.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateTransitGatewayPolicyTableEntryResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateTransitGatewayPolicyTableEntry
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateTransitGatewayPolicyTableEntryRequest'
      tags:
      - Transit Gateway Policy Table Entry
  /?Action=DeleteTransitGatewayPolicyTableEntry:
    post:
      operationId: DeleteTransitGatewayPolicyTableEntry
      summary: Delete Transit Gateway Policy Table Entry
      description: Deletes the specified transit gateway policy table entry.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteTransitGatewayPolicyTableEntryResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteTransitGatewayPolicyTableEntry
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteTransitGatewayPolicyTableEntryRequest'
      tags:
      - Transit Gateway Policy Table Entry
  /?Action=GetTransitGatewayPolicyTableEntries:
    post:
      operationId: GetTransitGatewayPolicyTableEntries
      summary: Get Transit Gateway Policy Table Entries
      description: Returns a list of transit gateway policy table entries.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GetTransitGatewayPolicyTableEntriesResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: GetTransitGatewayPolicyTableEntries
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/GetTransitGatewayPolicyTableEntriesRequest'
      tags:
      - Transit Gateway Policy Table Entry
  /?Action=ModifyTransitGatewayPolicyTableEntry:
    post:
      operationId: ModifyTransitGatewayPolicyTableEntry
      summary: Modify Transit Gateway Policy Table Entry
      description: Modifies the specified transit gateway policy table entry.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyTransitGatewayPolicyTableEntryResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyTransitGatewayPolicyTableEntry
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/ModifyTransitGatewayPolicyTableEntryRequest'
      tags:
      - Transit Gateway Policy Table Entry
components:
  schemas:
    CreateTransitGatewayPolicyTableEntryRequest:
      type: object
      properties:
        TransitGatewayPolicyTableId:
          type: string
          description: The ID of the transit gateway policy table.
        PolicyRuleNumber:
          type: string
          description: The rule number for the policy table entry. Lower rule numbers are evaluated first and take precedence.
        PolicyRule:
          $ref: '#/components/schemas/TransitGatewayRequestPolicyRule'
        TargetRouteTableId:
          type: string
          description: The ID of the transit gateway route table to use for traffic matching this rule.
        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:
      - TransitGatewayPolicyTableId
      - PolicyRuleNumber
      - TargetRouteTableId
    TransitGatewayRequestPolicyRuleMetaData:
      type: object
      properties:
        MetaDataKey:
          type: string
          description: The key of the metadata pair for the policy rule.
        MetaDataValue:
          type: string
          description: The value of the metadata pair for the policy rule.
    GetTransitGatewayPolicyTableEntriesResult:
      type: object
      properties:
        TransitGatewayPolicyTableEntries:
          type: array
          items:
            $ref: '#/components/schemas/TransitGatewayPolicyTableEntry'
          description: The entries for the transit gateway policy table.
        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.
    TransitGatewayPolicyTableEntry:
      type: object
      properties:
        PolicyRuleNumber:
          type: string
          description: The rule number for the transit gateway policy table entry.
        PolicyRule:
          $ref: '#/components/schemas/TransitGatewayPolicyRule'
        TargetRouteTableId:
          type: string
          description: The ID of the target route table.
        State:
          type: string
          enum:
          - active
          - deleted
          description: The state of the transit gateway policy table entry.
    DeleteTransitGatewayPolicyTableEntryRequest:
      type: object
      properties:
        TransitGatewayPolicyTableId:
          type: string
          description: The ID of the transit gateway policy table.
        PolicyRuleNumber:
          type: string
          description: The rule number of the policy table entry to delete.
        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:
      - TransitGatewayPolicyTableId
      - PolicyRuleNumber
    TransitGatewayRequestPolicyRule:
      type: object
      properties:
        SourceCidrBlock:
          type: string
          description: The source CIDR block for the policy rule.
        SourcePortRange:
          type: string
          description: The source port or port range for the policy rule. You can specify a port range only when Protocol is 6 (TCP) or 17 (UDP); for all other protocols, this value must be *.
        DestinationCidrBlock:
          type: string
          description: The destination CIDR block for the policy rule.
        DestinationPortRange:
          type: string
          description: The destination port or port range for the policy rule. You can specify a port range only when Protocol is 6 (TCP) or 17 (UDP); for all other protocols, this value must be *.
        Protocol:
          type: string
          description: The protocol for the policy rule. Valid values are 1 (ICMP), 6 (TCP), 17 (UDP), 47 (GRE), or * for all protocols.
        MetaData:
          $ref: '#/components/schemas/TransitGatewayRequestPolicyRuleMetaData'
    TransitGatewayPolicyRule:
      type: object
      properties:
        SourceCidrBlock:
          type: string
          description: The source CIDR block for the transit gateway policy rule.
        SourcePortRange:
          type: string
          description: The source port or port range for the transit gateway policy rule.
        DestinationCidrBlock:
          type: string
          description: The destination CIDR block for the transit gateway policy rule.
        DestinationPortRange:
          type: string
          description: The destination port or port range for the transit gateway policy rule.
        Protocol:
          type: string
          description: The protocol used by the transit gateway policy rule.
        MetaData:
          $ref: '#/components/schemas/TransitGatewayPolicyRuleMetaData'
    DeleteTransitGatewayPolicyTableEntryResult:
      type: object
      properties:
        TransitGatewayPolicyTableEntry:
          $ref: '#/components/schemas/TransitGatewayPolicyTableEntry'
    ModifyTransitGatewayPolicyTableEntryResult:
      type: object
      properties:
        TransitGatewayPolicyTableEntry:
          $ref: '#/components/schemas/TransitGatewayPolicyTableEntry'
    GetTransitGatewayPolicyTableEntriesRequest:
      type: object
      properties:
        TransitGatewayPolicyTableId:
          type: string
          description: The ID of the transit gateway policy table.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: 'One or more filters. The possible values are: policy-rule-number - The rule number for the transit gateway policy table entry. target-route-table-id - The ID of the target route table. policy-rule.source-ip - The source CIDR block for the policy rule. policy-rule.destination-ip - The destination CIDR block for the policy rule. policy-rule.source-port - The source port or port range for the policy rule. policy-rule.destination-port - The destination port or port range for the policy rule. policy-rule.protocol - The protocol for the policy rule. policy-rule.meta-data.key - The metadata key for t'
        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.
      required:
      - TransitGatewayPolicyTableId
    CreateTransitGatewayPolicyTableEntryResult:
      type: object
      properties:
        TransitGatewayPolicyTableEntry:
          $ref: '#/components/schemas/TransitGatewayPolicyTableEntry'
    TransitGatewayPolicyRuleMetaData:
      type: object
      properties:
        MetaDataKey:
          type: string
          description: The key name for the transit gateway policy rule meta data tag.
        MetaDataValue:
          type: string
          description: The value of the key for the transit gateway policy rule meta data tag.
    ModifyTransitGatewayPolicyTableEntryRequest:
      type: object
      properties:
        TransitGatewayPolicyTableId:
          type: string
          description: The ID of the transit gateway policy table.
        PolicyRuleNumber:
          type: string
          description: The rule number of the policy table entry to modify.
        PolicyRule:
          $ref: '#/components/schemas/TransitGatewayRequestPolicyRule'
        TargetRouteTableId:
          type: string
          description: The ID of the transit gateway route table to use for traffic matching this rule.
        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:
      - TransitGatewayPolicyTableId
      - PolicyRuleNumber
    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.
  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)