Amazon EC2 Ec2 Route Server Endpoint API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Route Server Endpoint API
  version: '2016-11-15'
  description: Generated from AWS's published Smithy model for Amazon Elastic Compute Cloud. 3 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: Route Server Endpoint
paths:
  /?Action=CreateRouteServerEndpoint:
    post:
      operationId: CreateRouteServerEndpoint
      summary: Create Route Server Endpoint
      description: Creates a new endpoint for a route server in a specified subnet. A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateRouteServerEndpointResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateRouteServerEndpoint
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateRouteServerEndpointRequest'
      tags:
      - Route Server Endpoint
  /?Action=DeleteRouteServerEndpoint:
    post:
      operationId: DeleteRouteServerEndpoint
      summary: Delete Route Server Endpoint
      description: Deletes the specified route server endpoint. A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteRouteServerEndpointResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteRouteServerEndpoint
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteRouteServerEndpointRequest'
      tags:
      - Route Server Endpoint
  /?Action=DescribeRouteServerEndpoints:
    post:
      operationId: DescribeRouteServerEndpoints
      summary: Describe Route Server Endpoints
      description: Describes one or more route server endpoints. A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeRouteServerEndpointsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeRouteServerEndpoints
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeRouteServerEndpointsRequest'
      tags:
      - Route Server Endpoint
components:
  schemas:
    CreateRouteServerEndpointRequest:
      type: object
      properties:
        RouteServerId:
          type: string
          description: The ID of the route server for which to create an endpoint.
        SubnetId:
          type: string
          description: The ID of the subnet in which to create the route server endpoint.
        ClientToken:
          type: string
          description: Unique, case-sensitive identifier to ensure idempotency of the request.
        DryRun:
          type: boolean
          description: A check for 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.
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to apply to the route server endpoint during creation.
      required:
      - RouteServerId
      - SubnetId
    CreateRouteServerEndpointResult:
      type: object
      properties:
        RouteServerEndpoint:
          $ref: '#/components/schemas/RouteServerEndpoint'
    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.'
    DescribeRouteServerEndpointsRequest:
      type: object
      properties:
        RouteServerEndpointIds:
          type: array
          items:
            type: string
          description: The IDs of the route server endpoints to describe.
        NextToken:
          type: string
          description: The token for the next page of results.
        MaxResults:
          type: integer
          description: The maximum number of results to return with a single call.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: One or more filters to apply to the describe request.
        DryRun:
          type: boolean
          description: A check for 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.
    DeleteRouteServerEndpointResult:
      type: object
      properties:
        RouteServerEndpoint:
          $ref: '#/components/schemas/RouteServerEndpoint'
    RouteServerEndpoint:
      type: object
      properties:
        RouteServerId:
          type: string
          description: The ID of the route server associated with this endpoint.
        RouteServerEndpointId:
          type: string
          description: The unique identifier of the route server endpoint.
        VpcId:
          type: string
          description: The ID of the VPC containing the endpoint.
        SubnetId:
          type: string
          description: The ID of the subnet to place the route server endpoint into.
        EniId:
          type: string
          description: The ID of the Elastic network interface for the endpoint.
        EniAddress:
          type: string
          description: The IP address of the Elastic network interface for the endpoint.
        State:
          type: string
          enum:
          - pending
          - available
          - deleting
          - deleted
          - failing
          - failed
          - delete-failed
          description: The current state of the route server endpoint.
        FailureReason:
          type: string
          description: The reason for any failure in endpoint creation or operation.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Any tags assigned to the route server endpoint.
    DeleteRouteServerEndpointRequest:
      type: object
      properties:
        RouteServerEndpointId:
          type: string
          description: The ID of the route server endpoint to delete.
        DryRun:
          type: boolean
          description: A check for 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:
      - RouteServerEndpointId
    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.
    DescribeRouteServerEndpointsResult:
      type: object
      properties:
        RouteServerEndpoints:
          type: array
          items:
            $ref: '#/components/schemas/RouteServerEndpoint'
          description: Information about the described route server endpoints.
        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.
    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)