Amazon WorkSpaces #X Amz Target=WorkspacesService.DescribeWorkspaces API

openapi: 3.0.0
info:
  version: '2015-04-08'
  x-release: v4
  title: 'Amazon WorkSpaces #X Amz Target=WorkspacesService.AssociateConnectionAlias #X Amz Target=WorkspacesService.AssociateConnectionAlias #X Amz Target=WorkspacesService.DescribeWorkspaces API'
  description: <fullname>Amazon WorkSpaces Service</fullname> <p>Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows or Amazon Linux desktops for your users, known as <i>WorkSpaces</i>. WorkSpaces eliminates the need to procure and deploy hardware or install complex software. You can quickly add or remove users as your needs change. Users can access their virtual desktops from multiple devices or web browsers.</p> <p>This API Reference provides detailed information about the actions, data types, parameters, and errors of the WorkSpaces service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see <a href="https://docs.aws.amazon.com/general/latest/gr/wsp.html">WorkSpaces endpoints and quotas</a> in the <i>Amazon Web Services General Reference</i>.</p> <p>You can also manage your WorkSpaces resources using the WorkSpaces console, Command Line Interface (CLI), and SDKs. For more information about administering WorkSpaces, see the <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/">Amazon WorkSpaces Administration Guide</a>. For more information about using the Amazon WorkSpaces client application or web browser to access provisioned WorkSpaces, see the <a href="https://docs.aws.amazon.com/workspaces/latest/userguide/">Amazon WorkSpaces User Guide</a>. For more information about using the CLI to manage your WorkSpaces resources, see the <a href="https://docs.aws.amazon.com/cli/latest/reference/workspaces/index.html">WorkSpaces section of the CLI Reference</a>.</p>
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: workspaces
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/workspaces-2015-04-08.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://workspaces.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon WorkSpaces multi-region endpoint
- url: https://workspaces.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon WorkSpaces multi-region endpoint
- url: http://workspaces.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon WorkSpaces endpoint for China (Beijing) and China (Ningxia)
- url: https://workspaces.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon WorkSpaces endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=WorkspacesService.DescribeWorkspaces'
paths:
  /#X-Amz-Target=WorkspacesService.DescribeWorkspaces:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: DescribeWorkspaces
      description: <p>Describes the specified WorkSpaces.</p> <p>You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.</p>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeWorkspacesResult'
        '480':
          description: InvalidParameterValuesException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValuesException'
        '481':
          description: ResourceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceUnavailableException'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeWorkspacesRequest'
      parameters:
      - name: Limit
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: NextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - WorkspacesService.DescribeWorkspaces
      summary: Amazon WorkSpaces Describe Workspaces
      tags:
      - '#X Amz Target=WorkspacesService.DescribeWorkspaces'
components:
  schemas:
    WorkspaceProperties:
      type: object
      properties:
        RunningMode:
          allOf:
          - $ref: '#/components/schemas/RunningMode'
          - description: <p>The running mode. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html">Manage the WorkSpace Running Mode</a>.</p> <note> <p>The <code>MANUAL</code> value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see <a href="http://aws.amazon.com/workspaces/core/">Amazon WorkSpaces Core</a>.</p> </note>
        RunningModeAutoStopTimeoutInMinutes:
          allOf:
          - $ref: '#/components/schemas/RunningModeAutoStopTimeoutInMinutes'
          - description: The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
        RootVolumeSizeGib:
          allOf:
          - $ref: '#/components/schemas/RootVolumeSizeGib'
          - description: The size of the root volume. For important information about how to modify the size of the root and user volumes, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html">Modify a WorkSpace</a>.
        UserVolumeSizeGib:
          allOf:
          - $ref: '#/components/schemas/UserVolumeSizeGib'
          - description: The size of the user storage. For important information about how to modify the size of the root and user volumes, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html">Modify a WorkSpace</a>.
        ComputeTypeName:
          allOf:
          - $ref: '#/components/schemas/Compute'
          - description: The compute type. For more information, see <a href="http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles">Amazon WorkSpaces Bundles</a>.
        Protocols:
          allOf:
          - $ref: '#/components/schemas/ProtocolList'
          - description: <p>The protocol. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-protocols.html"> Protocols for Amazon WorkSpaces</a>.</p> <note> <ul> <li> <p>Only available for WorkSpaces created with PCoIP bundles.</p> </li> <li> <p>The <code>Protocols</code> property is case sensitive. Ensure you use <code>PCOIP</code> or <code>WSP</code>.</p> </li> <li> <p>Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).</p> </li> </ul> </note>
      description: Describes a WorkSpace.
    UserVolumeSizeGib:
      type: integer
    BundleId:
      type: string
      pattern: ^wsb-[0-9a-z]{8,63}$
    Protocol:
      type: string
      enum:
      - PCOIP
      - WSP
    ModificationState:
      type: object
      properties:
        Resource:
          allOf:
          - $ref: '#/components/schemas/ModificationResourceEnum'
          - description: The resource.
        State:
          allOf:
          - $ref: '#/components/schemas/ModificationStateEnum'
          - description: The modification state.
      description: Describes a WorkSpace modification.
    DescribeWorkspacesResult:
      type: object
      properties:
        Workspaces:
          allOf:
          - $ref: '#/components/schemas/WorkspaceList'
          - description: <p>Information about the WorkSpaces.</p> <p>Because <a>CreateWorkspaces</a> is an asynchronous operation, some of the returned information could be incomplete.</p>
        NextToken:
          allOf:
          - $ref: '#/components/schemas/PaginationToken'
          - description: 'The token to use to retrieve the next page of results. This value is null when there are no more results to return. '
    WorkspaceList:
      type: array
      items:
        $ref: '#/components/schemas/Workspace'
    Region:
      type: string
      pattern: ^[-0-9a-z]{1,31}$
      minLength: 1
      maxLength: 31
    Workspace:
      type: object
      properties:
        WorkspaceId:
          allOf:
          - $ref: '#/components/schemas/WorkspaceId'
          - description: The identifier of the WorkSpace.
        DirectoryId:
          allOf:
          - $ref: '#/components/schemas/DirectoryId'
          - description: The identifier of the Directory Service directory for the WorkSpace.
        UserName:
          allOf:
          - $ref: '#/components/schemas/UserName'
          - description: The user for the WorkSpace.
        IpAddress:
          allOf:
          - $ref: '#/components/schemas/IpAddress'
          - description: The IP address of the WorkSpace.
        State:
          allOf:
          - $ref: '#/components/schemas/WorkspaceState'
          - description: <p>The operational state of the WorkSpace.</p> <note> <p>After a WorkSpace is terminated, the <code>TERMINATED</code> state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html"> DescribeWorkSpaces</a>. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.</p> </note>
        BundleId:
          allOf:
          - $ref: '#/components/schemas/BundleId'
          - description: The identifier of the bundle used to create the WorkSpace.
        SubnetId:
          allOf:
          - $ref: '#/components/schemas/SubnetId'
          - description: The identifier of the subnet for the WorkSpace.
        ErrorMessage:
          allOf:
          - $ref: '#/components/schemas/Description'
          - description: The text of the error message that is returned if the WorkSpace cannot be created.
        ErrorCode:
          allOf:
          - $ref: '#/components/schemas/WorkspaceErrorCode'
          - description: The error code that is returned if the WorkSpace cannot be created.
        ComputerName:
          allOf:
          - $ref: '#/components/schemas/ComputerName'
          - description: 'The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/launch-workspaces-tutorials.html"> Launch a WorkSpace</a>. '
        VolumeEncryptionKey:
          allOf:
          - $ref: '#/components/schemas/VolumeEncryptionKey'
          - description: The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
        UserVolumeEncryptionEnabled:
          allOf:
          - $ref: '#/components/schemas/BooleanObject'
          - description: Indicates whether the data stored on the user volume is encrypted.
        RootVolumeEncryptionEnabled:
          allOf:
          - $ref: '#/components/schemas/BooleanObject'
          - description: Indicates whether the data stored on the root volume is encrypted.
        WorkspaceProperties:
          allOf:
          - $ref: '#/components/schemas/WorkspaceProperties'
          - description: The properties of the WorkSpace.
        ModificationStates:
          allOf:
          - $ref: '#/components/schemas/ModificationStateList'
          - description: The modification states of the WorkSpace.
        RelatedWorkspaces:
          allOf:
          - $ref: '#/components/schemas/RelatedWorkspaces'
          - description: The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
      description: Describes a WorkSpace.
    PaginationToken:
      type: string
      minLength: 1
      maxLength: 2048
    StandbyWorkspaceRelationshipType:
      type: string
      enum:
      - PRIMARY
      - STANDBY
    WorkspaceId:
      type: string
      pattern: ^ws-[0-9a-z]{8,63}$
    Limit:
      type: integer
      minimum: 1
      maximum: 25
    RelatedWorkspaceProperties:
      type: object
      properties:
        WorkspaceId:
          allOf:
          - $ref: '#/components/schemas/WorkspaceId'
          - description: The identifier of the related WorkSpace.
        Region:
          allOf:
          - $ref: '#/components/schemas/Region'
          - description: The Region of the related WorkSpace.
        State:
          allOf:
          - $ref: '#/components/schemas/WorkspaceState'
          - description: Indicates the state of the WorkSpace.
        Type:
          allOf:
          - $ref: '#/components/schemas/StandbyWorkspaceRelationshipType'
          - description: Indicates the type of WorkSpace.
      description: Describes the related WorkSpace. The related WorkSpace could be a standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
    WorkspaceState:
      type: string
      enum:
      - PENDING
      - AVAILABLE
      - IMPAIRED
      - UNHEALTHY
      - REBOOTING
      - STARTING
      - REBUILDING
      - RESTORING
      - MAINTENANCE
      - ADMIN_MAINTENANCE
      - TERMINATING
      - TERMINATED
      - SUSPENDED
      - UPDATING
      - STOPPING
      - STOPPED
      - ERROR
    SubnetId:
      type: string
      pattern: ^(subnet-([0-9a-f]{8}|[0-9a-f]{17}))$
      minLength: 15
      maxLength: 24
    ProtocolList:
      type: array
      items:
        $ref: '#/components/schemas/Protocol'
    VolumeEncryptionKey:
      type: string
    DirectoryId:
      type: string
      pattern: ^d-[0-9a-f]{8,63}$
      minLength: 10
      maxLength: 65
    ModificationResourceEnum:
      type: string
      enum:
      - ROOT_VOLUME
      - USER_VOLUME
      - COMPUTE_TYPE
    InvalidParameterValuesException: {}
    Compute:
      type: string
      enum:
      - VALUE
      - STANDARD
      - PERFORMANCE
      - POWER
      - GRAPHICS
      - POWERPRO
      - GRAPHICSPRO
      - GRAPHICS_G4DN
      - GRAPHICSPRO_G4DN
    WorkspaceErrorCode:
      type: string
    ModificationStateEnum:
      type: string
      enum:
      - UPDATE_INITIATED
      - UPDATE_IN_PROGRESS
    RootVolumeSizeGib:
      type: integer
    IpAddress:
      type: string
    ResourceUnavailableException: {}
    RelatedWorkspaces:
      type: array
      items:
        $ref: '#/components/schemas/RelatedWorkspaceProperties'
    RunningMode:
      type: string
      enum:
      - AUTO_STOP
      - ALWAYS_ON
      - MANUAL
    RunningModeAutoStopTimeoutInMinutes:
      type: integer
    Description:
      type: string
    WorkspaceIdList:
      type: array
      items:
        $ref: '#/components/schemas/WorkspaceId'
      minItems: 1
      maxItems: 25
    ModificationStateList:
      type: array
      items:
        $ref: '#/components/schemas/ModificationState'
    ComputerName:
      type: string
    DescribeWorkspacesRequest:
      type: object
      title: DescribeWorkspacesRequest
      properties:
        WorkspaceIds:
          allOf:
          - $ref: '#/components/schemas/WorkspaceIdList'
          - description: <p>The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter.</p> <p>Because the <a>CreateWorkspaces</a> operation is asynchronous, the identifier it returns is not immediately available. If you immediately call <a>DescribeWorkspaces</a> with this identifier, no information is returned.</p>
        DirectoryId:
          allOf:
          - $ref: '#/components/schemas/DirectoryId'
          - description: The identifier of the directory. In addition, you can optionally specify a specific directory user (see <code>UserName</code>). You cannot combine this parameter with any other filter.
        UserName:
          allOf:
          - $ref: '#/components/schemas/UserName'
          - description: The name of the directory user. You must specify this parameter with <code>DirectoryId</code>.
        BundleId:
          allOf:
          - $ref: '#/components/schemas/BundleId'
          - description: The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.
        Limit:
          allOf:
          - $ref: '#/components/schemas/Limit'
          - description: The maximum number of items to return.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/PaginationToken'
          - description: If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results.
    BooleanObject:
      type: boolean
    UserName:
      type: string
      minLength: 1
      maxLength: 63
  parameters:
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/workspaces/
x-hasEquivalentPaths: true