Amazon WorkSpaces Workspaces Environments API

openapi: 3.1.0
info:
  title: Amazon WorkSpaces Environments API
  version: '2015-04-08'
  description: Generated from AWS's published Smithy model for Amazon WorkSpaces. 5 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://thinclient.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /environments:
    post:
      operationId: CreateEnvironment
      summary: Create Environment
      description: Creates an environment for your thin client devices.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateEnvironmentResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThinclientConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThinclientInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThinclientResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThinclientServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThinclientThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThinclientValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEnvironmentRequest'
      tags:
      - Environments
    get:
      operationId: ListEnvironments
      summary: List Environments
      description: Returns a list of environments.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEnvironmentsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThinclientInternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThinclientThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThinclientValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListEnvironmentsRequest'
      tags:
      - Environments
  /environments/{id}:
    delete:
      operationId: DeleteEnvironment
      summary: Delete Environment
      description: Deletes an environment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteEnvironmentResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThinclientConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThinclientInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThinclientResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThinclientThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThinclientValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteEnvironmentRequest'
      tags:
      - Environments
    get:
      operationId: GetEnvironment
      summary: Get Environment
      description: Returns information for an environment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEnvironmentResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThinclientInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThinclientResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThinclientThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThinclientValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetEnvironmentRequest'
      tags:
      - Environments
    patch:
      operationId: UpdateEnvironment
      summary: Update Environment
      description: Updates an environment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateEnvironmentResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThinclientConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThinclientInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThinclientResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThinclientThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThinclientValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEnvironmentRequest'
      tags:
      - Environments
components:
  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: thinclient
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    CreateEnvironmentRequest:
      type: object
      properties:
        name:
          type: string
          description: The name for the environment.
        desktopArn:
          type: string
          description: The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser,
            or AppStream 2.0.
        desktopEndpoint:
          type: string
          description: The URL for the identity provider login (only for environments that use AppStream 2.0).
        softwareSetUpdateSchedule:
          type: string
          enum:
          - USE_MAINTENANCE_WINDOW
          - APPLY_IMMEDIATELY
          description: An option to define if software updates should be applied within a maintenance window.
        maintenanceWindow:
          $ref: '#/components/schemas/MaintenanceWindow'
        softwareSetUpdateMode:
          type: string
          enum:
          - USE_LATEST
          - USE_DESIRED
          description: An option to define which software updates to apply.
        desiredSoftwareSetId:
          type: string
          description: The ID of the software set to apply.
        kmsKeyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Key Management Service key to use to encrypt the environment.
        clientToken:
          type: string
          description: Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
            This lets you safely retry the request without accidentally performing the same operation a second time. Passing
            the same value to a later call to an operation requires that you also pass the same value for all other parameters.
            We recommend that you use a UUID type of value. If you don't provide this value, then Amazon Web Services generates
            a random one for you. If you retry the operation with the same ClientToken, but with different parameters, the
            retry fails with an IdempotentParameter
        tags:
          type: object
          additionalProperties:
            type: string
          description: A map of the key-value pairs of the tag or tags to assign to the resource.
        deviceCreationTags:
          type: object
          additionalProperties:
            type: string
          description: A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.
      required:
      - desktopArn
    CreateEnvironmentResponse:
      type: object
      properties:
        environment:
          $ref: '#/components/schemas/EnvironmentSummary'
    DeleteEnvironmentRequest:
      type: object
      properties:
        id:
          type: string
          description: The ID of the environment to delete.
        clientToken:
          type: string
          description: Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
            This lets you safely retry the request without accidentally performing the same operation a second time. Passing
            the same value to a later call to an operation requires that you also pass the same value for all other parameters.
            We recommend that you use a UUID type of value. If you don't provide this value, then Amazon Web Services generates
            a random one for you. If you retry the operation with the same ClientToken, but with different parameters, the
            retry fails with an IdempotentParameter
      required:
      - id
    DeleteEnvironmentResponse:
      type: object
      properties: {}
    Environment:
      type: object
      properties:
        id:
          type: string
          description: The ID of the environment.
        name:
          type: string
          description: The name of the environment.
        desktopArn:
          type: string
          description: The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser,
            or AppStream 2.0.
        desktopEndpoint:
          type: string
          description: The URL for the identity provider login (only for environments that use AppStream 2.0).
        desktopType:
          type: string
          enum:
          - workspaces
          - appstream
          - workspaces-web
          description: The type of streaming desktop for the environment.
        activationCode:
          type: string
          description: The activation code to register a device to the environment.
        registeredDevicesCount:
          type: integer
          description: The number of devices registered to the environment.
        softwareSetUpdateSchedule:
          type: string
          enum:
          - USE_MAINTENANCE_WINDOW
          - APPLY_IMMEDIATELY
          description: An option to define if software updates should be applied within a maintenance window.
        maintenanceWindow:
          $ref: '#/components/schemas/MaintenanceWindow'
        softwareSetUpdateMode:
          type: string
          enum:
          - USE_LATEST
          - USE_DESIRED
          description: An option to define which software updates to apply.
        desiredSoftwareSetId:
          type: string
          description: The ID of the software set to apply.
        pendingSoftwareSetId:
          type: string
          description: The ID of the software set that is pending to be installed.
        pendingSoftwareSetVersion:
          type: string
          description: The version of the software set that is pending to be installed.
        softwareSetComplianceStatus:
          type: string
          enum:
          - NO_REGISTERED_DEVICES
          - COMPLIANT
          - NOT_COMPLIANT
          description: Describes if the software currently installed on all devices in the environment is a supported version.
        createdAt:
          type: string
          format: date-time
          description: The timestamp of when the environment was created.
        updatedAt:
          type: string
          format: date-time
          description: The timestamp of when the device was updated.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the environment.
        kmsKeyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the environment.
        deviceCreationTags:
          type: object
          additionalProperties:
            type: string
          description: The tag keys and optional values for the newly created devices for this environment.
    EnvironmentSummary:
      type: object
      properties:
        id:
          type: string
          description: The ID of the environment.
        name:
          type: string
          description: The name of the environment.
        desktopArn:
          type: string
          description: The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser,
            or AppStream 2.0.
        desktopEndpoint:
          type: string
          description: The URL for the identity provider login (only for environments that use AppStream 2.0).
        desktopType:
          type: string
          enum:
          - workspaces
          - appstream
          - workspaces-web
          description: The type of streaming desktop for the environment.
        activationCode:
          type: string
          description: The activation code to register a device to the environment.
        softwareSetUpdateSchedule:
          type: string
          enum:
          - USE_MAINTENANCE_WINDOW
          - APPLY_IMMEDIATELY
          description: An option to define if software updates should be applied within a maintenance window.
        maintenanceWindow:
          $ref: '#/components/schemas/MaintenanceWindow'
        softwareSetUpdateMode:
          type: string
          enum:
          - USE_LATEST
          - USE_DESIRED
          description: An option to define which software updates to apply.
        desiredSoftwareSetId:
          type: string
          description: The ID of the software set to apply.
        pendingSoftwareSetId:
          type: string
          description: The ID of the software set that is pending to be installed.
        createdAt:
          type: string
          format: date-time
          description: The timestamp of when the environment was created.
        updatedAt:
          type: string
          format: date-time
          description: The timestamp of when the device was updated.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the environment.
    GetEnvironmentRequest:
      type: object
      properties:
        id:
          type: string
          description: The ID of the environment for which to return information.
      required:
      - id
    GetEnvironmentResponse:
      type: object
      properties:
        environment:
          $ref: '#/components/schemas/Environment'
    ListEnvironmentsRequest:
      type: object
      properties:
        nextToken:
          type: string
          description: If nextToken is returned, there are more results available. The value of nextToken is a unique pagination
            token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments
            unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP
            400 InvalidToken error.
        maxResults:
          type: integer
          description: The maximum number of results that are returned per call. You can use nextToken to obtain further pages
            of results. This is only an upper limit. The actual number of results returned per call might be fewer than the
            specified maximum.
    ListEnvironmentsResponse:
      type: object
      properties:
        environments:
          type: array
          items:
            $ref: '#/components/schemas/EnvironmentSummary'
          description: Describes environments.
        nextToken:
          type: string
          description: If nextToken is returned, there are more results available. The value of nextToken is a unique pagination
            token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments
            unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP
            400 InvalidToken error.
    MaintenanceWindow:
      type: object
      properties:
        type:
          type: string
          enum:
          - SYSTEM
          - CUSTOM
          description: An option to select the default or custom maintenance window.
        startTimeHour:
          type: integer
          description: The hour for the maintenance window start (00-23).
        startTimeMinute:
          type: integer
          description: The minutes past the hour for the maintenance window start (00-59).
        endTimeHour:
          type: integer
          description: The hour for the maintenance window end (00-23).
        endTimeMinute:
          type: integer
          description: The minutes for the maintenance window end (00-59).
        daysOfTheWeek:
          type: array
          items:
            type: string
            enum:
            - MONDAY
            - TUESDAY
            - WEDNESDAY
            - THURSDAY
            - FRIDAY
            - SATURDAY
            - SUNDAY
          description: The days of the week during which the maintenance window is open.
        applyTimeOf:
          type: string
          enum:
          - UTC
          - DEVICE
          description: The option to set the maintenance window during the device local time or Universal Coordinated Time
            (UTC).
      required:
      - type
    ThinclientConflictException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The ID of the resource associated with the request.
        resourceType:
          type: string
          description: The type of the resource associated with the request.
    ThinclientInternalServerException:
      type: object
      properties:
        message:
          type: string
        retryAfterSeconds:
          type: integer
          description: The number of seconds to wait before retrying the next request.
    ThinclientResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The ID of the resource associated with the request.
        resourceType:
          type: string
          description: The type of the resource associated with the request.
    ThinclientServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The ID of the resource that exceeds the service quota.
        resourceType:
          type: string
          description: The type of the resource that exceeds the service quota.
        serviceCode:
          type: string
          description: The code for the service in Service Quotas.
        quotaCode:
          type: string
          description: The code for the quota in Service Quotas.
    ThinclientThrottlingException:
      type: object
      properties:
        message:
          type: string
        serviceCode:
          type: string
          description: The code for the service in Service Quotas.
        quotaCode:
          type: string
          description: The code for the quota in Service Quotas.
        retryAfterSeconds:
          type: integer
          description: The number of seconds to wait before retrying the next request.
    ThinclientValidationException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          enum:
          - unknownOperation
          - cannotParse
          - fieldValidationFailed
          - other
          description: The reason for the exception.
        fieldList:
          type: array
          items:
            $ref: '#/components/schemas/ThinclientValidationExceptionField'
          description: A list of fields that didn't validate.
    ThinclientValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The name of the exception.
        message:
          type: string
          description: A message that describes the reason for the exception.
      required:
      - name
      - message
    UpdateEnvironmentRequest:
      type: object
      properties:
        id:
          type: string
          description: The ID of the environment to update.
        name:
          type: string
          description: The name of the environment to update.
        desktopArn:
          type: string
          description: The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser,
            or AppStream 2.0.
        desktopEndpoint:
          type: string
          description: The URL for the identity provider login (only for environments that use AppStream 2.0).
        softwareSetUpdateSchedule:
          type: string
          enum:
          - USE_MAINTENANCE_WINDOW
          - APPLY_IMMEDIATELY
          description: An option to define if software updates should be applied within a maintenance window.
        maintenanceWindow:
          $ref: '#/components/schemas/MaintenanceWindow'
        softwareSetUpdateMode:
          type: string
          enum:
          - USE_LATEST
          - USE_DESIRED
          description: An option to define which software updates to apply.
        desiredSoftwareSetId:
          type: string
          description: The ID of the software set to apply.
        deviceCreationTags:
          type: object
          additionalProperties:
            type: string
          description: A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.
      required:
      - id
    UpdateEnvironmentResponse:
      type: object
      properties:
        environment:
          $ref: '#/components/schemas/EnvironmentSummary'
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/workspaces-thin-client/service/2023-08-22/workspaces-thin-client-2023-08-22.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)