Amazon EC2 Ec2 Client Vpn Route API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Client Vpn Route 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: Client Vpn Route
paths:
  /?Action=CreateClientVpnRoute:
    post:
      operationId: CreateClientVpnRoute
      summary: Create Client Vpn Route
      description: Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateClientVpnRouteResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateClientVpnRoute
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateClientVpnRouteRequest'
      tags:
      - Client Vpn Route
  /?Action=DeleteClientVpnRoute:
    post:
      operationId: DeleteClientVpnRoute
      summary: Delete Client Vpn Route
      description: Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the CreateClientVpnRoute action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteClientVpnRouteResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteClientVpnRoute
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteClientVpnRouteRequest'
      tags:
      - Client Vpn Route
  /?Action=DescribeClientVpnRoutes:
    post:
      operationId: DescribeClientVpnRoutes
      summary: Describe Client Vpn Routes
      description: Describes the routes for the specified Client VPN endpoint.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeClientVpnRoutesResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeClientVpnRoutes
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeClientVpnRoutesRequest'
      tags:
      - Client Vpn Route
components:
  schemas:
    ClientVpnRoute:
      type: object
      properties:
        ClientVpnEndpointId:
          type: string
          description: The ID of the Client VPN endpoint with which the route is associated.
        DestinationCidr:
          type: string
          description: The IPv4 address range, in CIDR notation, of the route destination.
        TargetSubnet:
          type: string
          description: The ID of the subnet through which traffic is routed.
        Type:
          type: string
          description: The route type.
        Origin:
          type: string
          description: Indicates how the route was associated with the Client VPN endpoint. associate indicates that the route was automatically added when the target network was associated with the Client VPN endpoint. add-route indicates that the route was manually added using the CreateClientVpnRoute action.
        Status:
          $ref: '#/components/schemas/ClientVpnRouteStatus'
        Description:
          type: string
          description: A brief description of the route.
        TransitGatewayAttachmentId:
          type: string
          description: The ID of the Transit Gateway attachment, if the route targets a Transit Gateway.
    CreateClientVpnRouteRequest:
      type: object
      properties:
        ClientVpnEndpointId:
          type: string
          description: The ID of the Client VPN endpoint to which to add the route.
        DestinationCidrBlock:
          type: string
          description: 'The IPv4 address range, in CIDR notation, of the route destination. For example: To add a route for Internet access, enter 0.0.0.0/0 To add a route for a peered VPC, enter the peered VPC''s IPv4 CIDR range To add a route for an on-premises network, enter the Amazon Web Services Site-to-Site VPN connection''s IPv4 CIDR range To add a route for the local network, enter the client CIDR range'
        TargetVpcSubnetId:
          type: string
          description: The ID of the subnet through which you want to route traffic. The specified subnet must be an existing target network of the Client VPN endpoint. Alternatively, if you're adding a route for the local network, specify local. This parameter is required for VPC-based Client VPN endpoints. For Transit Gateway-based endpoints, this parameter is not required.
        Description:
          type: string
          description: A brief description of the route.
        ClientToken:
          type: string
          description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
        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:
      - ClientVpnEndpointId
      - DestinationCidrBlock
    DescribeClientVpnRoutesRequest:
      type: object
      properties:
        ClientVpnEndpointId:
          type: string
          description: The ID of the Client VPN endpoint.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: One or more filters. Filter names and values are case-sensitive. destination-cidr - The CIDR of the route destination. origin - How the route was associated with the Client VPN endpoint (associate | add-route). target-subnet - The ID of the subnet through which traffic is routed.
        MaxResults:
          type: integer
          description: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
        NextToken:
          type: string
          description: The token to retrieve 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:
      - ClientVpnEndpointId
    ClientVpnRouteStatus:
      type: object
      properties:
        Code:
          type: string
          enum:
          - creating
          - active
          - failed
          - deleting
          description: The state of the Client VPN endpoint route.
        Message:
          type: string
          description: A message about the status of the Client VPN endpoint route, if applicable.
    CreateClientVpnRouteResult:
      type: object
      properties:
        Status:
          $ref: '#/components/schemas/ClientVpnRouteStatus'
    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.
    DescribeClientVpnRoutesResult:
      type: object
      properties:
        Routes:
          type: array
          items:
            $ref: '#/components/schemas/ClientVpnRoute'
          description: Information about the Client VPN endpoint routes.
        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.
    DeleteClientVpnRouteRequest:
      type: object
      properties:
        ClientVpnEndpointId:
          type: string
          description: The ID of the Client VPN endpoint from which the route is to be deleted.
        TargetVpcSubnetId:
          type: string
          description: The ID of the target subnet used by the route.
        DestinationCidrBlock:
          type: string
          description: The IPv4 address range, in CIDR notation, of the route to be deleted.
        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:
      - ClientVpnEndpointId
      - DestinationCidrBlock
    DeleteClientVpnRouteResult:
      type: object
      properties:
        Status:
          $ref: '#/components/schemas/ClientVpnRouteStatus'
  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)