Amazon EC2 Ec2 Client Vpn Target Network API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Client Vpn Target Network 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 Target Network
paths:
  /?Action=AssociateClientVpnTargetNetwork:
    post:
      operationId: AssociateClientVpnTargetNetwork
      summary: Associate Client Vpn Target Network
      description: Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy. If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that's in a different VPC, you must first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that's associated with it.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AssociateClientVpnTargetNetworkResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: AssociateClientVpnTargetNetwork
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/AssociateClientVpnTargetNetworkRequest'
      tags:
      - Client Vpn Target Network
  /?Action=DescribeClientVpnTargetNetworks:
    post:
      operationId: DescribeClientVpnTargetNetworks
      summary: Describe Client Vpn Target Networks
      description: Describes the target networks associated with the specified Client VPN endpoint.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeClientVpnTargetNetworksResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeClientVpnTargetNetworks
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeClientVpnTargetNetworksRequest'
      tags:
      - Client Vpn Target Network
  /?Action=DisassociateClientVpnTargetNetwork:
    post:
      operationId: DisassociateClientVpnTargetNetwork
      summary: Disassociate Client Vpn Target Network
      description: 'Disassociates a target network from the specified Client VPN endpoint. When you disassociate the last target network from a Client VPN, the following happens: The route that was automatically added for the VPC is deleted All active client connections are terminated New client connections are disallowed The Client VPN endpoint''s status changes to pending-associate'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DisassociateClientVpnTargetNetworkResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DisassociateClientVpnTargetNetwork
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DisassociateClientVpnTargetNetworkRequest'
      tags:
      - Client Vpn Target Network
components:
  schemas:
    DescribeClientVpnTargetNetworksRequest:
      type: object
      properties:
        ClientVpnEndpointId:
          type: string
          description: The ID of the Client VPN endpoint.
        AssociationIds:
          type: array
          items:
            type: string
          description: The IDs of the target network associations.
        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.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: One or more filters. Filter names and values are case-sensitive. association-id - The ID of the association. target-network-id - The ID of the subnet specified as the target network. vpc-id - The ID of the VPC in which the target network is located.
        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
    DisassociateClientVpnTargetNetworkRequest:
      type: object
      properties:
        ClientVpnEndpointId:
          type: string
          description: The ID of the Client VPN endpoint from which to disassociate the target network.
        AssociationId:
          type: string
          description: The ID of the target network association.
        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
      - AssociationId
    TargetNetwork:
      type: object
      properties:
        AssociationId:
          type: string
          description: The ID of the association.
        VpcId:
          type: string
          description: The ID of the VPC in which the target network (subnet) is located.
        TargetNetworkId:
          type: string
          description: The ID of the subnet specified as the target network.
        ClientVpnEndpointId:
          type: string
          description: The ID of the Client VPN endpoint with which the target network is associated.
        Status:
          $ref: '#/components/schemas/AssociationStatus'
        SecurityGroups:
          type: array
          items:
            type: string
          description: The IDs of the security groups applied to the target network association.
        AvailabilityZones:
          type: array
          items:
            type: string
          description: The Availability Zone names for the target network association, if the Client VPN endpoint uses a Transit Gateway.
        AvailabilityZoneIds:
          type: array
          items:
            type: string
          description: The Availability Zone IDs for the target network association, if the Client VPN endpoint uses a Transit Gateway.
    AssociateClientVpnTargetNetworkResult:
      type: object
      properties:
        AssociationId:
          type: string
          description: The unique ID of the target network association.
        Status:
          $ref: '#/components/schemas/AssociationStatus'
    AssociateClientVpnTargetNetworkRequest:
      type: object
      properties:
        ClientVpnEndpointId:
          type: string
          description: The ID of the Client VPN endpoint.
        SubnetId:
          type: string
          description: The ID of the subnet to associate with the Client VPN endpoint. Required for VPC-based endpoints. For Transit Gateway-based endpoints, use AvailabilityZone or AvailabilityZoneId instead.
        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.
        AvailabilityZone:
          type: string
          description: The Availability Zone name for the Transit Gateway association. Required if when associating an Availability Zone with a Client VPN endpoint that uses a Transit Gateway. You cannot specify both SubnetId and AvailabilityZone.
        AvailabilityZoneId:
          type: string
          description: The Availability Zone ID for the Transit Gateway association. Required if when associating an Availability Zone with a Client VPN endpoint that uses a Transit Gateway. You cannot specify both AvailabilityZone and AvailabilityZoneId.
      required:
      - ClientVpnEndpointId
    AssociationStatus:
      type: object
      properties:
        Code:
          type: string
          enum:
          - associating
          - associated
          - association-failed
          - disassociating
          - disassociated
          description: The state of the target network association.
        Message:
          type: string
          description: A message about the status of the target network association, if applicable.
    DescribeClientVpnTargetNetworksResult:
      type: object
      properties:
        ClientVpnTargetNetworks:
          type: array
          items:
            $ref: '#/components/schemas/TargetNetwork'
          description: Information about the associated target networks.
        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.
    DisassociateClientVpnTargetNetworkResult:
      type: object
      properties:
        AssociationId:
          type: string
          description: The ID of the target network association.
        Status:
          $ref: '#/components/schemas/AssociationStatus'
  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)