Amazon EC2 Ec2 Client Vpn Endpoint Authorization Policy API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Client Vpn Endpoint…
  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 Endpoint Authorization Policy
paths:
  /?Action=DeleteClientVpnEndpointAuthorizationPolicy:
    post:
      operationId: DeleteClientVpnEndpointAuthorizationPolicy
      summary: Delete Client Vpn Endpoint Authorization Policy
      description: Deletes the authorization policy for a Client VPN endpoint.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteClientVpnEndpointAuthorizationPolicyResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteClientVpnEndpointAuthorizationPolicy
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteClientVpnEndpointAuthorizationPolicyRequest'
      tags:
      - Client Vpn Endpoint Authorization Policy
  /?Action=GetClientVpnEndpointAuthorizationPolicy:
    post:
      operationId: GetClientVpnEndpointAuthorizationPolicy
      summary: Get Client Vpn Endpoint Authorization Policy
      description: Describes the authorization policy for a Client VPN endpoint.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GetClientVpnEndpointAuthorizationPolicyResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: GetClientVpnEndpointAuthorizationPolicy
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/GetClientVpnEndpointAuthorizationPolicyRequest'
      tags:
      - Client Vpn Endpoint Authorization Policy
  /?Action=ModifyClientVpnEndpointAuthorizationPolicy:
    post:
      operationId: ModifyClientVpnEndpointAuthorizationPolicy
      summary: Modify Client Vpn Endpoint Authorization Policy
      description: Creates or updates the authorization policy for a Client VPN endpoint. A Client VPN endpoint can have one authorization policy. If a policy already exists for the endpoint, the values that you specify replace the corresponding values in the existing policy, and values that you do not specify remain unchanged.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyClientVpnEndpointAuthorizationPolicyResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyClientVpnEndpointAuthorizationPolicy
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/ModifyClientVpnEndpointAuthorizationPolicyRequest'
      tags:
      - Client Vpn Endpoint Authorization Policy
components:
  schemas:
    ModifyClientVpnEndpointAuthorizationPolicyResult:
      type: object
      properties:
        Status:
          type: string
          enum:
          - creating
          - updating
          - active
          - failed
          - deleting
          description: The current state of the authorization policy.
    DeleteClientVpnEndpointAuthorizationPolicyRequest:
      type: object
      properties:
        ClientVpnEndpointId:
          type: string
          description: The ID of the Client VPN endpoint.
        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
    GetClientVpnEndpointAuthorizationPolicyResult:
      type: object
      properties:
        ClientVpnEndpointId:
          type: string
          description: The ID of the Client VPN endpoint.
        PolicyDocument:
          type: string
          description: The authorization policy document, written in the Cedar policy language.
        Description:
          type: string
          description: A brief description of the authorization policy.
        ShadowMode:
          type: string
          enum:
          - enabled
          - disabled
          description: 'Specifies whether the authorization policy is evaluated in shadow mode. Possible values include: enabled - The authorization policy is evaluated and the results are logged, but access is not enforced. disabled - The authorization policy is enforced.'
        Status:
          type: string
          enum:
          - creating
          - updating
          - active
          - failed
          - deleting
          description: The current state of the authorization policy.
    DeleteClientVpnEndpointAuthorizationPolicyResult:
      type: object
      properties:
        Status:
          type: string
          enum:
          - creating
          - updating
          - active
          - failed
          - deleting
          description: The current state of the authorization policy.
    GetClientVpnEndpointAuthorizationPolicyRequest:
      type: object
      properties:
        ClientVpnEndpointId:
          type: string
          description: The ID of the Client VPN endpoint.
        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
    ModifyClientVpnEndpointAuthorizationPolicyRequest:
      type: object
      properties:
        ClientVpnEndpointId:
          type: string
          description: The ID of the Client VPN endpoint.
        PolicyDocument:
          type: string
          description: The authorization policy document, written in the Cedar policy language. This parameter is required when you create the authorization policy for a Client VPN endpoint that does not already have one.
        Description:
          type: string
          description: A brief description of the authorization policy.
        ShadowMode:
          type: string
          enum:
          - enabled
          - disabled
          description: 'Specifies whether the authorization policy is evaluated in shadow mode. Possible values include: enabled - The authorization policy is evaluated and the results are logged, but access is not enforced. disabled - The authorization policy is enforced. The default value is disabled.'
        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
  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)