Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeWorkspacesPools

Note

End of support notice: On December 31, 2027, AWS 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.

Request Syntax


{
   "Filters": [ 
      { 
         "Name": "string",
         "Operator": "string",
         "Values": [ "string" ]
      }
   ],
   "Limit": number,
   "NextToken": "string",
   "PoolIds": [ "string" ]
}

Request Parameters

The request accepts the following data in JSON format.

Filters

The filter conditions for the WorkSpaces Pool to return.

Type: Array of DescribeWorkspacesPoolsFilter objects

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Required: No

Limit

The maximum number of items to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 25.

Required: No

NextToken

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

PoolIds

The identifier of the WorkSpaces Pools.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Pattern: ^wspool-[0-9a-z]{9}$

Required: No

Response Syntax


{
   "NextToken": "string",
   "WorkspacesPools": [ 
      { 
         "ApplicationSettings": { 
            "S3BucketName": "string",
            "SettingsGroup": "string",
            "Status": "string"
         },
         "BundleId": "string",
         "CapacityStatus": { 
            "ActiveUserSessions": number,
            "ActualUserSessions": number,
            "AvailableUserSessions": number,
            "DesiredUserSessions": number
         },
         "CreatedAt": number,
         "Description": "string",
         "DirectoryId": "string",
         "Errors": [ 
            { 
               "ErrorCode": "string",
               "ErrorMessage": "string"
            }
         ],
         "PoolArn": "string",
         "PoolId": "string",
         "PoolName": "string",
         "RunningMode": "string",
         "State": "string",
         "TimeoutSettings": { 
            "DisconnectTimeoutInSeconds": number,
            "IdleDisconnectTimeoutInSeconds": number,
            "MaxUserDurationInSeconds": number
         }
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

WorkspacesPools

Information about the WorkSpaces Pools.

Type: Array of WorkspacesPool objects

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400

InvalidParameterValuesException

One or more parameter values are not valid.

message: The exception error message.

HTTP Status Code: 400

ResourceNotFoundException

The resource could not be found.

message: The resource could not be found.
ResourceId: The ID of the resource that could not be found.

HTTP Status Code: 400