Amazon EC2 Ec2 Verified Access Instance API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Verified Access Instance API
  version: '2016-11-15'
  description: Generated from AWS's published Smithy model for Amazon Elastic Compute Cloud. 4 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: Verified Access Instance
paths:
  /?Action=CreateVerifiedAccessInstance:
    post:
      operationId: CreateVerifiedAccessInstance
      summary: Create Verified Access Instance
      description: An Amazon Web Services Verified Access instance is a regional entity that evaluates application requests and grants access only when your security requirements are met.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateVerifiedAccessInstanceResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateVerifiedAccessInstance
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateVerifiedAccessInstanceRequest'
      tags:
      - Verified Access Instance
  /?Action=DeleteVerifiedAccessInstance:
    post:
      operationId: DeleteVerifiedAccessInstance
      summary: Delete Verified Access Instance
      description: Delete an Amazon Web Services Verified Access instance.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteVerifiedAccessInstanceResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteVerifiedAccessInstance
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteVerifiedAccessInstanceRequest'
      tags:
      - Verified Access Instance
  /?Action=DescribeVerifiedAccessInstances:
    post:
      operationId: DescribeVerifiedAccessInstances
      summary: Describe Verified Access Instances
      description: Describes the specified Amazon Web Services Verified Access instances.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeVerifiedAccessInstancesResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeVerifiedAccessInstances
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeVerifiedAccessInstancesRequest'
      tags:
      - Verified Access Instance
  /?Action=ModifyVerifiedAccessInstance:
    post:
      operationId: ModifyVerifiedAccessInstance
      summary: Modify Verified Access Instance
      description: Modifies the configuration of the specified Amazon Web Services Verified Access instance.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyVerifiedAccessInstanceResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyVerifiedAccessInstance
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/ModifyVerifiedAccessInstanceRequest'
      tags:
      - Verified Access Instance
components:
  schemas:
    DescribeVerifiedAccessInstancesResult:
      type: object
      properties:
        VerifiedAccessInstances:
          type: array
          items:
            $ref: '#/components/schemas/VerifiedAccessInstance'
          description: Details about the Verified Access instances.
        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.
    DeleteVerifiedAccessInstanceRequest:
      type: object
      properties:
        VerifiedAccessInstanceId:
          type: string
          description: The ID of the Verified Access instance.
        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.
        ClientToken:
          type: string
          description: A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring idempotency.
      required:
      - VerifiedAccessInstanceId
    VerifiedAccessTrustProviderCondensed:
      type: object
      properties:
        VerifiedAccessTrustProviderId:
          type: string
          description: The ID of the trust provider.
        Description:
          type: string
          description: The description of trust provider.
        TrustProviderType:
          type: string
          enum:
          - user
          - device
          description: The type of trust provider (user- or device-based).
        UserTrustProviderType:
          type: string
          enum:
          - iam-identity-center
          - oidc
          description: The type of user-based trust provider.
        DeviceTrustProviderType:
          type: string
          enum:
          - jamf
          - crowdstrike
          - jumpcloud
          description: The type of device-based trust provider.
    ModifyVerifiedAccessInstanceResult:
      type: object
      properties:
        VerifiedAccessInstance:
          $ref: '#/components/schemas/VerifiedAccessInstance'
    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.'
    VerifiedAccessInstanceCustomSubDomain:
      type: object
      properties:
        SubDomain:
          type: string
          description: The subdomain.
        Nameservers:
          type: array
          items:
            type: string
          description: The name servers.
    DescribeVerifiedAccessInstancesRequest:
      type: object
      properties:
        VerifiedAccessInstanceIds:
          type: array
          items:
            type: string
          description: The IDs of the Verified Access instances.
        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.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: One or more filters. Filter names and values are case-sensitive.
        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.
    CreateVerifiedAccessInstanceRequest:
      type: object
      properties:
        Description:
          type: string
          description: A description for the Verified Access instance.
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to assign to the Verified Access instance.
        ClientToken:
          type: string
          description: A unique, case-sensitive token that you provide to ensure idempotency of your modification 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.
        FIPSEnabled:
          type: boolean
          description: Enable or disable support for Federal Information Processing Standards (FIPS) on the instance.
        CidrEndpointsCustomSubDomain:
          type: string
          description: The custom subdomain.
    CreateVerifiedAccessInstanceResult:
      type: object
      properties:
        VerifiedAccessInstance:
          $ref: '#/components/schemas/VerifiedAccessInstance'
    DeleteVerifiedAccessInstanceResult:
      type: object
      properties:
        VerifiedAccessInstance:
          $ref: '#/components/schemas/VerifiedAccessInstance'
    VerifiedAccessInstance:
      type: object
      properties:
        VerifiedAccessInstanceId:
          type: string
          description: The ID of the Amazon Web Services Verified Access instance.
        Description:
          type: string
          description: A description for the Amazon Web Services Verified Access instance.
        VerifiedAccessTrustProviders:
          type: array
          items:
            $ref: '#/components/schemas/VerifiedAccessTrustProviderCondensed'
          description: The IDs of the Amazon Web Services Verified Access trust providers.
        CreationTime:
          type: string
          description: The creation time.
        LastUpdatedTime:
          type: string
          description: The last updated time.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags.
        FipsEnabled:
          type: boolean
          description: Indicates whether support for Federal Information Processing Standards (FIPS) is enabled on the instance.
        CidrEndpointsCustomSubDomain:
          $ref: '#/components/schemas/VerifiedAccessInstanceCustomSubDomain'
    ModifyVerifiedAccessInstanceRequest:
      type: object
      properties:
        VerifiedAccessInstanceId:
          type: string
          description: The ID of the Verified Access instance.
        Description:
          type: string
          description: A description for the Verified Access instance.
        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.
        ClientToken:
          type: string
          description: A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring idempotency.
        CidrEndpointsCustomSubDomain:
          type: string
          description: The custom subdomain.
      required:
      - VerifiedAccessInstanceId
    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.
    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.
  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)