Amazon WorkSpaces Workspaces Workspaces Pool API

openapi: 3.1.0
info:
  title: Amazon WorkSpaces Workspaces Pool 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://workspaces.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateWorkspacesPool:
    post:
      operationId: CreateWorkspacesPool
      summary: Create Workspaces Pool
      description: 'End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces
        Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon
        WorkSpaces Pools resources. For more information, see Amazon WorkSpaces Pools end of support. Creates a pool of WorkSpaces.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateWorkspacesPoolResult'
        '400':
          description: AccessDeniedException; InvalidParameterValuesException; OperationNotSupportedException; ResourceAlreadyExistsException;
            ResourceLimitExceededException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - WorkspacesService.CreateWorkspacesPool
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateWorkspacesPoolRequest'
      tags:
      - Workspaces Pool
  /#DescribeWorkspacesPools:
    post:
      operationId: DescribeWorkspacesPools
      summary: Describe Workspaces Pools
      description: 'End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces
        Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon
        WorkSpaces Pools resources. For more information, see Amazon WorkSpaces Pools end of support. Describes the specified
        WorkSpaces Pools.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeWorkspacesPoolsResult'
        '400':
          description: AccessDeniedException; InvalidParameterValuesException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - WorkspacesService.DescribeWorkspacesPools
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeWorkspacesPoolsRequest'
      tags:
      - Workspaces Pool
  /#StartWorkspacesPool:
    post:
      operationId: StartWorkspacesPool
      summary: Start Workspaces Pool
      description: 'End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces
        Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon
        WorkSpaces Pools resources. For more information, see Amazon WorkSpaces Pools end of support. Starts the specified
        pool. You cannot start a pool unless it has a running mode of AutoStop and a state of STOPPED.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StartWorkspacesPoolResult'
        '400':
          description: AccessDeniedException; InvalidParameterValuesException; InvalidResourceStateException; OperationInProgressException;
            OperationNotSupportedException; ResourceLimitExceededException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - WorkspacesService.StartWorkspacesPool
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StartWorkspacesPoolRequest'
      tags:
      - Workspaces Pool
  /#StopWorkspacesPool:
    post:
      operationId: StopWorkspacesPool
      summary: Stop Workspaces Pool
      description: 'End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces
        Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon
        WorkSpaces Pools resources. For more information, see Amazon WorkSpaces Pools end of support. Stops the specified
        pool. You cannot stop a WorkSpace pool unless it has a running mode of AutoStop and a state of AVAILABLE, IMPAIRED,
        UNHEALTHY, or ERROR.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StopWorkspacesPoolResult'
        '400':
          description: AccessDeniedException; InvalidParameterValuesException; InvalidResourceStateException; OperationInProgressException;
            ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - WorkspacesService.StopWorkspacesPool
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StopWorkspacesPoolRequest'
      tags:
      - Workspaces Pool
  /#UpdateWorkspacesPool:
    post:
      operationId: UpdateWorkspacesPool
      summary: Update Workspaces Pool
      description: 'End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces
        Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon
        WorkSpaces Pools resources. For more information, see Amazon WorkSpaces Pools end of support. Updates the specified
        pool.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateWorkspacesPoolResult'
        '400':
          description: AccessDeniedException; InvalidParameterValuesException; InvalidResourceStateException; OperationInProgressException;
            OperationNotSupportedException; ResourceLimitExceededException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - WorkspacesService.UpdateWorkspacesPool
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateWorkspacesPoolRequest'
      tags:
      - Workspaces Pool
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: workspaces
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    ApplicationSettingsRequest:
      type: object
      properties:
        Status:
          type: string
          enum:
          - DISABLED
          - ENABLED
          description: Enables or disables persistent application settings for users during their pool sessions.
        SettingsGroup:
          type: string
          description: The path prefix for the S3 bucket where users’ persistent application settings are stored. You can
            allow the same persistent application settings to be used across multiple pools by specifying the same settings
            group for each pool.
      required:
      - Status
    ApplicationSettingsResponse:
      type: object
      properties:
        Status:
          type: string
          enum:
          - DISABLED
          - ENABLED
          description: Specifies whether persistent application settings are enabled for users during their pool sessions.
        SettingsGroup:
          type: string
          description: The path prefix for the S3 bucket where users’ persistent application settings are stored.
        S3BucketName:
          type: string
          description: The S3 bucket where users’ persistent application settings are stored. When persistent application
            settings are enabled for the first time for an account in an Amazon Web Services Region, an S3 bucket is created.
            The bucket is unique to the Amazon Web Services account and the Region.
      required:
      - Status
    Capacity:
      type: object
      properties:
        DesiredUserSessions:
          type: integer
          description: The desired number of user sessions for the WorkSpaces in the pool.
      required:
      - DesiredUserSessions
    CapacityStatus:
      type: object
      properties:
        AvailableUserSessions:
          type: integer
          description: The number of user sessions currently available for streaming from your pool. AvailableUserSessions
            = ActualUserSessions - ActiveUserSessions
        DesiredUserSessions:
          type: integer
          description: The total number of sessions slots that are either running or pending. This represents the total number
            of concurrent streaming sessions your pool can support in a steady state.
        ActualUserSessions:
          type: integer
          description: The total number of user sessions that are available for streaming or are currently streaming in your
            pool. ActualUserSessions = AvailableUserSessions + ActiveUserSessions
        ActiveUserSessions:
          type: integer
          description: The number of user sessions currently being used for your pool.
      required:
      - AvailableUserSessions
      - DesiredUserSessions
      - ActualUserSessions
      - ActiveUserSessions
    CreateWorkspacesPoolRequest:
      type: object
      properties:
        PoolName:
          type: string
          description: The name of the pool.
        Description:
          type: string
          description: The pool description.
        BundleId:
          type: string
          description: The identifier of the bundle for the pool.
        DirectoryId:
          type: string
          description: The identifier of the directory for the pool.
        Capacity:
          $ref: '#/components/schemas/Capacity'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags for the pool.
        ApplicationSettings:
          $ref: '#/components/schemas/ApplicationSettingsRequest'
        TimeoutSettings:
          $ref: '#/components/schemas/TimeoutSettings'
        RunningMode:
          type: string
          enum:
          - AUTO_STOP
          - ALWAYS_ON
          description: The running mode for the pool.
      required:
      - PoolName
      - Description
      - BundleId
      - DirectoryId
      - Capacity
    CreateWorkspacesPoolResult:
      type: object
      properties:
        WorkspacesPool:
          $ref: '#/components/schemas/WorkspacesPool'
    DescribeWorkspacesPoolsFilter:
      type: object
      properties:
        Name:
          type: string
          enum:
          - PoolName
          description: The name of the pool to filter.
        Values:
          type: array
          items:
            type: string
          description: The values for filtering WorkSpaces Pools.
        Operator:
          type: string
          enum:
          - EQUALS
          - NOTEQUALS
          - CONTAINS
          - NOTCONTAINS
          description: The operator values for filtering WorkSpaces Pools.
      required:
      - Name
      - Values
      - Operator
    DescribeWorkspacesPoolsRequest:
      type: object
      properties:
        PoolIds:
          type: array
          items:
            type: string
          description: The identifier of the WorkSpaces Pools.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/DescribeWorkspacesPoolsFilter'
          description: The filter conditions for the WorkSpaces Pool to return.
        Limit:
          type: integer
          description: The maximum number of items to return.
        NextToken:
          type: string
          description: If you received a NextToken from a previous call that was paginated, provide this token to receive
            the next set of results.
    DescribeWorkspacesPoolsResult:
      type: object
      properties:
        WorkspacesPools:
          type: array
          items:
            $ref: '#/components/schemas/WorkspacesPool'
          description: Information about the WorkSpaces Pools.
        NextToken:
          type: string
          description: If you received a NextToken from a previous call that was paginated, provide this token to receive
            the next set of results.
    StartWorkspacesPoolRequest:
      type: object
      properties:
        PoolId:
          type: string
          description: The identifier of the pool.
      required:
      - PoolId
    StartWorkspacesPoolResult:
      type: object
      properties: {}
    StopWorkspacesPoolRequest:
      type: object
      properties:
        PoolId:
          type: string
          description: The identifier of the pool.
      required:
      - PoolId
    StopWorkspacesPoolResult:
      type: object
      properties: {}
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The key of the tag.
        Value:
          type: string
          description: The value of the tag.
      required:
      - Key
    TimeoutSettings:
      type: object
      properties:
        DisconnectTimeoutInSeconds:
          type: integer
          description: Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect.
            If users try to reconnect to the streaming session after a disconnection or network interruption within the time
            set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming
            instance.
        IdleDisconnectTimeoutInSeconds:
          type: integer
          description: The amount of time in seconds a connection will stay active while idle.
        MaxUserDurationInSeconds:
          type: integer
          description: Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users
            are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save
            any open documents before being disconnected. After this time elapses, the instance is terminated and replaced
            by a new instance.
    UpdateWorkspacesPoolRequest:
      type: object
      properties:
        PoolId:
          type: string
          description: The identifier of the specified pool to update.
        Description:
          type: string
          description: Describes the specified pool to update.
        BundleId:
          type: string
          description: The identifier of the bundle.
        DirectoryId:
          type: string
          description: The identifier of the directory.
        Capacity:
          $ref: '#/components/schemas/Capacity'
        ApplicationSettings:
          $ref: '#/components/schemas/ApplicationSettingsRequest'
        TimeoutSettings:
          $ref: '#/components/schemas/TimeoutSettings'
        RunningMode:
          type: string
          enum:
          - AUTO_STOP
          - ALWAYS_ON
          description: The desired running mode for the pool. The running mode can only be updated when the pool is in a stopped
            state.
      required:
      - PoolId
    UpdateWorkspacesPoolResult:
      type: object
      properties:
        WorkspacesPool:
          $ref: '#/components/schemas/WorkspacesPool'
    WorkspacesPool:
      type: object
      properties:
        PoolId:
          type: string
          description: The identifier of a pool.
        PoolArn:
          type: string
          description: The Amazon Resource Name (ARN) for the pool.
        CapacityStatus:
          $ref: '#/components/schemas/CapacityStatus'
        PoolName:
          type: string
          description: The name of the pool.
        Description:
          type: string
          description: The description of the pool.
        State:
          type: string
          enum:
          - CREATING
          - DELETING
          - RUNNING
          - STARTING
          - STOPPED
          - STOPPING
          - UPDATING
          description: The current state of the pool.
        CreatedAt:
          type: string
          format: date-time
          description: The time the pool was created.
        BundleId:
          type: string
          description: The identifier of the bundle used by the pool.
        DirectoryId:
          type: string
          description: The identifier of the directory used by the pool.
        Errors:
          type: array
          items:
            $ref: '#/components/schemas/WorkspacesPoolError'
          description: The pool errors.
        ApplicationSettings:
          $ref: '#/components/schemas/ApplicationSettingsResponse'
        TimeoutSettings:
          $ref: '#/components/schemas/TimeoutSettings'
        RunningMode:
          type: string
          enum:
          - AUTO_STOP
          - ALWAYS_ON
          description: The running mode of the pool.
      required:
      - PoolId
      - PoolArn
      - CapacityStatus
      - PoolName
      - State
      - CreatedAt
      - BundleId
      - DirectoryId
      - RunningMode
    WorkspacesPoolError:
      type: object
      properties:
        ErrorCode:
          type: string
          enum:
          - IAM_SERVICE_ROLE_IS_MISSING
          - IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION
          - IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION
          - IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION
          - NETWORK_INTERFACE_LIMIT_EXCEEDED
          - INTERNAL_SERVICE_ERROR
          - MACHINE_ROLE_IS_MISSING
          - STS_DISABLED_IN_REGION
          - SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES
          - IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION
          - SUBNET_NOT_FOUND
          - IMAGE_NOT_FOUND
          - INVALID_SUBNET_CONFIGURATION
          - SECURITY_GROUPS_NOT_FOUND
          - IGW_NOT_ATTACHED
          - IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION
          - WORKSPACES_POOL_STOPPED
          - WORKSPACES_POOL_INSTANCE_PROVISIONING_FAILURE
          - DOMAIN_JOIN_ERROR_FILE_NOT_FOUND
          - DOMAIN_JOIN_ERROR_ACCESS_DENIED
          - DOMAIN_JOIN_ERROR_LOGON_FAILURE
          - DOMAIN_JOIN_ERROR_INVALID_PARAMETER
          - DOMAIN_JOIN_ERROR_MORE_DATA
          - DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN
          - DOMAIN_JOIN_ERROR_NOT_SUPPORTED
          - DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME
          - DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED
          - DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED
          - DOMAIN_JOIN_NERR_PASSWORD_EXPIRED
          - DOMAIN_JOIN_INTERNAL_SERVICE_ERROR
          - DOMAIN_JOIN_ERROR_SECRET_ACTION_PERMISSION_IS_MISSING
          - DOMAIN_JOIN_ERROR_SECRET_DECRYPTION_FAILURE
          - DOMAIN_JOIN_ERROR_SECRET_STATE_INVALID
          - DOMAIN_JOIN_ERROR_SECRET_NOT_FOUND
          - DOMAIN_JOIN_ERROR_SECRET_VALUE_KEY_NOT_FOUND
          - DOMAIN_JOIN_ERROR_SECRET_INVALID
          - BUNDLE_NOT_FOUND
          - DIRECTORY_NOT_FOUND
          - INSUFFICIENT_PERMISSIONS_ERROR
          - DEFAULT_OU_IS_MISSING
          description: The error code.
        ErrorMessage:
          type: string
          description: The error message.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/workspaces/service/2015-04-08/workspaces-2015-04-08.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)