Amazon WorkSpaces Workspaces Devices API

The Workspaces Devices API from Amazon WorkSpaces — 2 operation(s) for workspaces devices.

GitHub OpenAPI

Operations 4

DELETE /devices/{id} Delete Device #
GET /devices/{id} Get Device #
PATCH /devices/{id} Update Device #
GET /devices List Devices #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-workspaces:amazon-workspaces-devices-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-workspaces-devices-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon WorkSpaces Devices API
  version: '2015-04-08'
  description: Generated from AWS's published Smithy model for Amazon WorkSpaces. 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://thinclient.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /devices/{id}:
    delete:
      operationId: DeleteDevice
      summary: Delete Device
      description: Deletes a thin client device.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteDeviceResponse'
        '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/DeleteDeviceRequest'
      tags:
      - Devices
    get:
      operationId: GetDevice
      summary: Get Device
      description: Returns information for a thin client device.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDeviceResponse'
        '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/GetDeviceRequest'
      tags:
      - Devices
    patch:
      operationId: UpdateDevice
      summary: Update Device
      description: Updates a thin client device.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateDeviceResponse'
        '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/UpdateDeviceRequest'
      tags:
      - Devices
  /devices:
    get:
      operationId: ListDevices
      summary: List Devices
      description: Returns a list of thin client devices.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDevicesResponse'
        '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/ListDevicesRequest'
      tags:
      - Devices
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
    DeleteDeviceRequest:
      type: object
      properties:
        id:
          type: string
          description: The ID of the device 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
    DeleteDeviceResponse:
      type: object
      properties: {}
    Device:
      type: object
      properties:
        id:
          type: string
          description: The ID of the device.
        serialNumber:
          type: string
          description: The hardware serial number of the device.
        name:
          type: string
          description: The name of the device.
        model:
          type: string
          description: The model number of the device.
        environmentId:
          type: string
          description: The ID of the environment the device is associated with.
        status:
          type: string
          enum:
          - REGISTERED
          - DEREGISTERING
          - DEREGISTERED
          - ARCHIVED
          description: The status of the device.
        currentSoftwareSetId:
          type: string
          description: The ID of the software set currently installed on the device.
        currentSoftwareSetVersion:
          type: string
          description: The version of the software set currently installed on the device.
        desiredSoftwareSetId:
          type: string
          description: The ID of the software set which the device has been set to.
        pendingSoftwareSetId:
          type: string
          description: The ID of the software set that is pending to be installed on the device.
        pendingSoftwareSetVersion:
          type: string
          description: The version of the software set that is pending to be installed on the device.
        softwareSetUpdateSchedule:
          type: string
          enum:
          - USE_MAINTENANCE_WINDOW
          - APPLY_IMMEDIATELY
          description: An option to define if software updates should be applied within a maintenance window.
        softwareSetComplianceStatus:
          type: string
          enum:
          - NONE
          - COMPLIANT
          - NOT_COMPLIANT
          description: Describes if the software currently installed on the device is a supported version.
        softwareSetUpdateStatus:
          type: string
          enum:
          - AVAILABLE
          - IN_PROGRESS
          - UP_TO_DATE
          description: Describes if the device has a supported version of software installed.
        lastConnectedAt:
          type: string
          format: date-time
          description: The timestamp of the most recent session on the device.
        lastPostureAt:
          type: string
          format: date-time
          description: The timestamp of the most recent check-in of the device.
        createdAt:
          type: string
          format: date-time
          description: The timestamp of when the device 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 device.
        kmsKeyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the device.
        lastUserId:
          type: string
          description: The user ID of the most recent session on the device.
    DeviceSummary:
      type: object
      properties:
        id:
          type: string
          description: The ID of the device.
        serialNumber:
          type: string
          description: The hardware serial number of the device.
        name:
          type: string
          description: The name of the device.
        model:
          type: string
          description: The model number of the device.
        environmentId:
          type: string
          description: The ID of the environment the device is associated with.
        status:
          type: string
          enum:
          - REGISTERED
          - DEREGISTERING
          - DEREGISTERED
          - ARCHIVED
          description: The status of the device.
        currentSoftwareSetId:
          type: string
          description: The ID of the software set currently installed on the device.
        desiredSoftwareSetId:
          type: string
          description: The ID of the software set which the device has been set to.
        pendingSoftwareSetId:
          type: string
          description: The ID of the software set that is pending to be installed on the device.
        softwareSetUpdateSchedule:
          type: string
          enum:
          - USE_MAINTENANCE_WINDOW
          - APPLY_IMMEDIATELY
          description: An option to define if software updates should be applied within a maintenance window.
        lastConnectedAt:
          type: string
          format: date-time
          description: The timestamp of the most recent session on the device.
        lastPostureAt:
          type: string
          format: date-time
          description: The timestamp of the most recent check-in of the device.
        createdAt:
          type: string
          format: date-time
          description: The timestamp of when the device 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 device.
        lastUserId:
          type: string
          description: The user ID of the most recent session on the device.
    GetDeviceRequest:
      type: object
      properties:
        id:
          type: string
          description: The ID of the device for which to return information.
      required:
      - id
    GetDeviceResponse:
      type: object
      properties:
        device:
          $ref: '#/components/schemas/Device'
    ListDevicesRequest:
      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.
    ListDevicesResponse:
      type: object
      properties:
        devices:
          type: array
          items:
            $ref: '#/components/schemas/DeviceSummary'
          description: Describes devices.
        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.
    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.
    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
    UpdateDeviceRequest:
      type: object
      properties:
        id:
          type: string
          description: The ID of the device to update.
        name:
          type: string
          description: The name of the device to update.
        desiredSoftwareSetId:
          type: string
          description: The ID of the software set to apply.
        softwareSetUpdateSchedule:
          type: string
          enum:
          - USE_MAINTENANCE_WINDOW
          - APPLY_IMMEDIATELY
          description: An option to define if software updates should be applied within a maintenance window.
      required:
      - id
    UpdateDeviceResponse:
      type: object
      properties:
        device:
          $ref: '#/components/schemas/DeviceSummary'
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)