Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeWorkspacesPoolSessions

Retrieves a list that describes the streaming sessions for a specified pool.

Request Syntax


{
   "Limit": number,
   "NextToken": "string",
   "PoolId": "string",
   "UserId": "string"
}

Request Parameters

The request accepts the following data in JSON format.

Limit

The maximum number of items to return.

Type: Integer

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

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

PoolId

The identifier of the pool.

Type: String

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

Required: Yes

UserId

The identifier of the user.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 128.

Required: No

Response Syntax


{
   "NextToken": "string",
   "Sessions": [ 
      { 
         "AuthenticationType": "string",
         "ConnectionState": "string",
         "ExpirationTime": number,
         "InstanceId": "string",
         "NetworkAccessConfiguration": { 
            "EniId": "string",
            "EniPrivateIpAddress": "string"
         },
         "PoolId": "string",
         "SessionId": "string",
         "StartTime": number,
         "UserId": "string"
      }
   ]
}

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.

Sessions

Describes the pool sessions.

Type: Array of WorkspacesPoolSession objects

Errors

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

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400

InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400