Amazon EC2 Ec2 Transit Gateway Peering Attachment API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Transit Gateway Peering…
  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 Peering Attachment
paths:
  /?Action=AcceptTransitGatewayPeeringAttachment:
    post:
      operationId: AcceptTransitGatewayPeeringAttachment
      summary: Accept Transit Gateway Peering Attachment
      description: Accepts a transit gateway peering attachment request. The peering attachment must be in the pendingAcceptance state.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AcceptTransitGatewayPeeringAttachmentResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: AcceptTransitGatewayPeeringAttachment
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/AcceptTransitGatewayPeeringAttachmentRequest'
      tags:
      - Transit Gateway Peering Attachment
  /?Action=CreateTransitGatewayPeeringAttachment:
    post:
      operationId: CreateTransitGatewayPeeringAttachment
      summary: Create Transit Gateway Peering Attachment
      description: Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The peer transit gateway can be in your account or a different Amazon Web Services account. After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateTransitGatewayPeeringAttachmentResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateTransitGatewayPeeringAttachment
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateTransitGatewayPeeringAttachmentRequest'
      tags:
      - Transit Gateway Peering Attachment
  /?Action=DeleteTransitGatewayPeeringAttachment:
    post:
      operationId: DeleteTransitGatewayPeeringAttachment
      summary: Delete Transit Gateway Peering Attachment
      description: Deletes a transit gateway peering attachment.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteTransitGatewayPeeringAttachmentResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteTransitGatewayPeeringAttachment
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteTransitGatewayPeeringAttachmentRequest'
      tags:
      - Transit Gateway Peering Attachment
  /?Action=DescribeTransitGatewayPeeringAttachments:
    post:
      operationId: DescribeTransitGatewayPeeringAttachments
      summary: Describe Transit Gateway Peering Attachments
      description: Describes your transit gateway peering attachments.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeTransitGatewayPeeringAttachmentsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeTransitGatewayPeeringAttachments
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeTransitGatewayPeeringAttachmentsRequest'
      tags:
      - Transit Gateway Peering Attachment
  /?Action=RejectTransitGatewayPeeringAttachment:
    post:
      operationId: RejectTransitGatewayPeeringAttachment
      summary: Reject Transit Gateway Peering Attachment
      description: Rejects a transit gateway peering attachment request.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/RejectTransitGatewayPeeringAttachmentResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: RejectTransitGatewayPeeringAttachment
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/RejectTransitGatewayPeeringAttachmentRequest'
      tags:
      - Transit Gateway Peering Attachment
components:
  schemas:
    PeeringTgwInfo:
      type: object
      properties:
        TransitGatewayId:
          type: string
          description: The ID of the transit gateway.
        CoreNetworkId:
          type: string
          description: The ID of the core network where the transit gateway peer is located.
        OwnerId:
          type: string
          description: The ID of the Amazon Web Services account that owns the transit gateway.
        Region:
          type: string
          description: The Region of the transit gateway.
    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.'
    TransitGatewayPeeringAttachmentOptions:
      type: object
      properties:
        DynamicRouting:
          type: string
          enum:
          - enable
          - disable
          description: Describes whether dynamic routing is enabled or disabled for the transit gateway peering attachment.
    TransitGatewayPeeringAttachment:
      type: object
      properties:
        TransitGatewayAttachmentId:
          type: string
          description: The ID of the transit gateway peering attachment.
        AccepterTransitGatewayAttachmentId:
          type: string
          description: The ID of the accepter transit gateway attachment.
        RequesterTgwInfo:
          $ref: '#/components/schemas/PeeringTgwInfo'
        AccepterTgwInfo:
          $ref: '#/components/schemas/PeeringTgwInfo'
        Options:
          $ref: '#/components/schemas/TransitGatewayPeeringAttachmentOptions'
        Status:
          $ref: '#/components/schemas/PeeringAttachmentStatus'
        State:
          type: string
          enum:
          - initiating
          - initiatingRequest
          - pendingAcceptance
          - rollingBack
          - pending
          - available
          - modifying
          - deleting
          - deleted
          - failed
          - rejected
          - rejecting
          - failing
          description: The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
        CreationTime:
          type: string
          format: date-time
          description: The time the transit gateway peering attachment was created.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags for the transit gateway peering attachment.
    CreateTransitGatewayPeeringAttachmentResult:
      type: object
      properties:
        TransitGatewayPeeringAttachment:
          $ref: '#/components/schemas/TransitGatewayPeeringAttachment'
    DeleteTransitGatewayPeeringAttachmentResult:
      type: object
      properties:
        TransitGatewayPeeringAttachment:
          $ref: '#/components/schemas/TransitGatewayPeeringAttachment'
    DescribeTransitGatewayPeeringAttachmentsRequest:
      type: object
      properties:
        TransitGatewayAttachmentIds:
          type: array
          items:
            type: string
          description: One or more IDs of the transit gateway peering attachments.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: 'One or more filters. The possible values are: transit-gateway-attachment-id - The ID of the transit gateway attachment. local-owner-id - The ID of your Amazon Web Services account. remote-owner-id - The ID of the Amazon Web Services account in the remote Region that owns the transit gateway. state - The state of the peering attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting). tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the fil'
        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.
    RejectTransitGatewayPeeringAttachmentRequest:
      type: object
      properties:
        TransitGatewayAttachmentId:
          type: string
          description: The ID of the transit gateway peering 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:
      - TransitGatewayAttachmentId
    DeleteTransitGatewayPeeringAttachmentRequest:
      type: object
      properties:
        TransitGatewayAttachmentId:
          type: string
          description: The ID of the transit gateway peering 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:
      - TransitGatewayAttachmentId
    AcceptTransitGatewayPeeringAttachmentResult:
      type: object
      properties:
        TransitGatewayPeeringAttachment:
          $ref: '#/components/schemas/TransitGatewayPeeringAttachment'
    AcceptTransitGatewayPeeringAttachmentRequest:
      type: object
      properties:
        TransitGatewayAttachmentId:
          type: string
          description: The ID of the transit gateway 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:
      - TransitGatewayAttachmentId
    CreateTransitGatewayPeeringAttachmentRequest:
      type: object
      properties:
        TransitGatewayId:
          type: string
          description: The ID of the transit gateway.
        PeerTransitGatewayId:
          type: string
          description: The ID of the peer transit gateway with which to create the peering attachment.
        PeerAccountId:
          type: string
          description: The ID of the Amazon Web Services account that owns the peer transit gateway.
        PeerRegion:
          type: string
          description: The Region where the peer transit gateway is located.
        Options:
          $ref: '#/components/schemas/CreateTransitGatewayPeeringAttachmentRequestOptions'
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to apply to the transit gateway peering 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:
      - TransitGatewayId
      - PeerTransitGatewayId
      - PeerAccountId
      - PeerRegion
    RejectTransitGatewayPeeringAttachmentResult:
      type: object
      properties:
        TransitGatewayPeeringAttachment:
          $ref: '#/components/schemas/TransitGatewayPeeringAttachment'
    DescribeTransitGatewayPeeringAttachmentsResult:
      type: object
      properties:
        TransitGatewayPeeringAttachments:
          type: array
          items:
            $ref: '#/components/schemas/TransitGatewayPeeringAttachment'
          description: The transit gateway peering attachments.
        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.
    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.
    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.
    PeeringAttachmentStatus:
      type: object
      properties:
        Code:
          type: string
          description: The status code.
        Message:
          type: string
          description: The status message, if applicable.
    CreateTransitGatewayPeeringAttachmentRequestOptions:
      type: object
      properties:
        DynamicRouting:
          type: string
          enum:
          - enable
          - disable
          description: Indicates whether dynamic routing is enabled or disabled.
  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)