Amazon EC2 Ec2 Verified Access Group API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Verified Access Group 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 Group
paths:
  /?Action=CreateVerifiedAccessGroup:
    post:
      operationId: CreateVerifiedAccessGroup
      summary: Create Verified Access Group
      description: An Amazon Web Services Verified Access group is a collection of Amazon Web Services Verified Access endpoints who's associated applications have similar security requirements. Each instance within a Verified Access group shares an Verified Access policy. For example, you can group all Verified Access instances associated with "sales" applications together and use one common Verified Access policy.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateVerifiedAccessGroupResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateVerifiedAccessGroup
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateVerifiedAccessGroupRequest'
      tags:
      - Verified Access Group
  /?Action=DeleteVerifiedAccessGroup:
    post:
      operationId: DeleteVerifiedAccessGroup
      summary: Delete Verified Access Group
      description: Delete an Amazon Web Services Verified Access group.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteVerifiedAccessGroupResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteVerifiedAccessGroup
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteVerifiedAccessGroupRequest'
      tags:
      - Verified Access Group
  /?Action=DescribeVerifiedAccessGroups:
    post:
      operationId: DescribeVerifiedAccessGroups
      summary: Describe Verified Access Groups
      description: Describes the specified Verified Access groups.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeVerifiedAccessGroupsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeVerifiedAccessGroups
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeVerifiedAccessGroupsRequest'
      tags:
      - Verified Access Group
  /?Action=ModifyVerifiedAccessGroup:
    post:
      operationId: ModifyVerifiedAccessGroup
      summary: Modify Verified Access Group
      description: Modifies the specified Amazon Web Services Verified Access group configuration.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyVerifiedAccessGroupResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyVerifiedAccessGroup
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/ModifyVerifiedAccessGroupRequest'
      tags:
      - Verified Access Group
components:
  schemas:
    VerifiedAccessSseSpecificationRequest:
      type: object
      properties:
        CustomerManagedKeyEnabled:
          type: boolean
          description: 'Enable or disable the use of customer managed KMS keys for server side encryption. Valid values: True | False'
        KmsKeyArn:
          type: string
          description: The ARN of the KMS key.
    DescribeVerifiedAccessGroupsResult:
      type: object
      properties:
        VerifiedAccessGroups:
          type: array
          items:
            $ref: '#/components/schemas/VerifiedAccessGroup'
          description: Details about the Verified Access groups.
        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.
    DeleteVerifiedAccessGroupRequest:
      type: object
      properties:
        VerifiedAccessGroupId:
          type: string
          description: The ID of the Verified Access group.
        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.
      required:
      - VerifiedAccessGroupId
    DescribeVerifiedAccessGroupsRequest:
      type: object
      properties:
        VerifiedAccessGroupIds:
          type: array
          items:
            type: string
          description: The ID of the Verified Access groups.
        VerifiedAccessInstanceId:
          type: string
          description: The ID of the Verified Access instance.
        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.
    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.'
    CreateVerifiedAccessGroupRequest:
      type: object
      properties:
        VerifiedAccessInstanceId:
          type: string
          description: The ID of the Verified Access instance.
        Description:
          type: string
          description: A description for the Verified Access group.
        PolicyDocument:
          type: string
          description: The Verified Access policy document.
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to assign to the Verified Access group.
        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.
        SseSpecification:
          $ref: '#/components/schemas/VerifiedAccessSseSpecificationRequest'
      required:
      - VerifiedAccessInstanceId
    CreateVerifiedAccessGroupResult:
      type: object
      properties:
        VerifiedAccessGroup:
          $ref: '#/components/schemas/VerifiedAccessGroup'
    VerifiedAccessGroup:
      type: object
      properties:
        VerifiedAccessGroupId:
          type: string
          description: The ID of the Verified Access group.
        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 group.
        Owner:
          type: string
          description: The Amazon Web Services account number that owns the group.
        VerifiedAccessGroupArn:
          type: string
          description: The ARN of the Verified Access group.
        CreationTime:
          type: string
          description: The creation time.
        LastUpdatedTime:
          type: string
          description: The last updated time.
        DeletionTime:
          type: string
          description: The deletion time.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags.
        SseSpecification:
          $ref: '#/components/schemas/VerifiedAccessSseSpecificationResponse'
    ModifyVerifiedAccessGroupResult:
      type: object
      properties:
        VerifiedAccessGroup:
          $ref: '#/components/schemas/VerifiedAccessGroup'
    DeleteVerifiedAccessGroupResult:
      type: object
      properties:
        VerifiedAccessGroup:
          $ref: '#/components/schemas/VerifiedAccessGroup'
    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.
    ModifyVerifiedAccessGroupRequest:
      type: object
      properties:
        VerifiedAccessGroupId:
          type: string
          description: The ID of the Verified Access group.
        VerifiedAccessInstanceId:
          type: string
          description: The ID of the Verified Access instance.
        Description:
          type: string
          description: A description for the Verified Access group.
        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.
      required:
      - VerifiedAccessGroupId
    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.
    VerifiedAccessSseSpecificationResponse:
      type: object
      properties:
        CustomerManagedKeyEnabled:
          type: boolean
          description: 'Indicates whether customer managed KMS keys are in use for server side encryption. Valid values: True | False'
        KmsKeyArn:
          type: string
          description: The ARN of the KMS key.
  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)