Amazon EC2 Ec2 Transit Gateway Prefix List Reference API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Transit Gateway Prefix List…
  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 Prefix List Reference
paths:
  /?Action=CreateTransitGatewayPrefixListReference:
    post:
      operationId: CreateTransitGatewayPrefixListReference
      summary: Create Transit Gateway Prefix List Reference
      description: Creates a reference (route) to a prefix list in a specified transit gateway route table.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateTransitGatewayPrefixListReferenceResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateTransitGatewayPrefixListReference
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateTransitGatewayPrefixListReferenceRequest'
      tags:
      - Transit Gateway Prefix List Reference
  /?Action=DeleteTransitGatewayPrefixListReference:
    post:
      operationId: DeleteTransitGatewayPrefixListReference
      summary: Delete Transit Gateway Prefix List Reference
      description: Deletes a reference (route) to a prefix list in a specified transit gateway route table.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteTransitGatewayPrefixListReferenceResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteTransitGatewayPrefixListReference
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteTransitGatewayPrefixListReferenceRequest'
      tags:
      - Transit Gateway Prefix List Reference
  /?Action=GetTransitGatewayPrefixListReferences:
    post:
      operationId: GetTransitGatewayPrefixListReferences
      summary: Get Transit Gateway Prefix List References
      description: Gets information about the prefix list references in a specified transit gateway route table.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GetTransitGatewayPrefixListReferencesResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: GetTransitGatewayPrefixListReferences
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/GetTransitGatewayPrefixListReferencesRequest'
      tags:
      - Transit Gateway Prefix List Reference
  /?Action=ModifyTransitGatewayPrefixListReference:
    post:
      operationId: ModifyTransitGatewayPrefixListReference
      summary: Modify Transit Gateway Prefix List Reference
      description: Modifies a reference (route) to a prefix list in a specified transit gateway route table.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyTransitGatewayPrefixListReferenceResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyTransitGatewayPrefixListReference
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/ModifyTransitGatewayPrefixListReferenceRequest'
      tags:
      - Transit Gateway Prefix List Reference
components:
  schemas:
    GetTransitGatewayPrefixListReferencesResult:
      type: object
      properties:
        TransitGatewayPrefixListReferences:
          type: array
          items:
            $ref: '#/components/schemas/TransitGatewayPrefixListReference'
          description: Information about the prefix list references.
        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.
    TransitGatewayPrefixListAttachment:
      type: object
      properties:
        TransitGatewayAttachmentId:
          type: string
          description: The ID of the attachment.
        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.
        ResourceId:
          type: string
          description: The ID of the resource.
    ModifyTransitGatewayPrefixListReferenceRequest:
      type: object
      properties:
        TransitGatewayRouteTableId:
          type: string
          description: The ID of the transit gateway route table.
        PrefixListId:
          type: string
          description: The ID of the prefix list.
        TransitGatewayAttachmentId:
          type: string
          description: The ID of the attachment to which traffic is routed.
        Blackhole:
          type: boolean
          description: Indicates whether to drop traffic that matches this route.
        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
      - PrefixListId
    TransitGatewayPrefixListReference:
      type: object
      properties:
        TransitGatewayRouteTableId:
          type: string
          description: The ID of the transit gateway route table.
        PrefixListId:
          type: string
          description: The ID of the prefix list.
        PrefixListOwnerId:
          type: string
          description: The ID of the prefix list owner.
        State:
          type: string
          enum:
          - pending
          - available
          - modifying
          - deleting
          description: The state of the prefix list reference.
        Blackhole:
          type: boolean
          description: Indicates whether traffic that matches this route is dropped.
        TransitGatewayAttachment:
          $ref: '#/components/schemas/TransitGatewayPrefixListAttachment'
    CreateTransitGatewayPrefixListReferenceRequest:
      type: object
      properties:
        TransitGatewayRouteTableId:
          type: string
          description: The ID of the transit gateway route table.
        PrefixListId:
          type: string
          description: The ID of the prefix list that is used for destination matches.
        TransitGatewayAttachmentId:
          type: string
          description: The ID of the attachment to which traffic is routed.
        Blackhole:
          type: boolean
          description: Indicates whether to drop traffic that matches this route.
        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
      - PrefixListId
    ModifyTransitGatewayPrefixListReferenceResult:
      type: object
      properties:
        TransitGatewayPrefixListReference:
          $ref: '#/components/schemas/TransitGatewayPrefixListReference'
    CreateTransitGatewayPrefixListReferenceResult:
      type: object
      properties:
        TransitGatewayPrefixListReference:
          $ref: '#/components/schemas/TransitGatewayPrefixListReference'
    DeleteTransitGatewayPrefixListReferenceResult:
      type: object
      properties:
        TransitGatewayPrefixListReference:
          $ref: '#/components/schemas/TransitGatewayPrefixListReference'
    DeleteTransitGatewayPrefixListReferenceRequest:
      type: object
      properties:
        TransitGatewayRouteTableId:
          type: string
          description: The ID of the route table.
        PrefixListId:
          type: string
          description: The ID of the prefix list.
        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
      - PrefixListId
    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.
    GetTransitGatewayPrefixListReferencesRequest:
      type: object
      properties:
        TransitGatewayRouteTableId:
          type: string
          description: The ID of the transit gateway route table.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: 'One or more filters. The possible values are: attachment.resource-id - The ID of the resource for the attachment. attachment.resource-type - The type of resource for the attachment. Valid values are vpc | vpn | direct-connect-gateway | peering. attachment.transit-gateway-attachment-id - The ID of the attachment. is-blackhole - Whether traffic matching the route is blocked (true | false). prefix-list-id - The ID of the prefix list. prefix-list-owner-id - The ID of the owner of the prefix list. state - The state of the prefix list reference (pending | available | modifying | deleting).'
        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:
      - TransitGatewayRouteTableId
  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)