ListInstanceTypes - WorkSpaces Instances

ListInstanceTypes

Retrieves a list of instance types supported by Amazon WorkSpaces Instances, enabling precise workspace infrastructure configuration.

Request Syntax

{ "MaxResults": number, "NextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxResults

Maximum number of instance types to return in a single API call. Enables pagination of instance type results.

Type: Integer

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

Required: No

NextToken

Pagination token for retrieving subsequent pages of instance type results.

Type: String

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

Required: No

Response Syntax

{ "InstanceTypes": [ { "InstanceType": "string" } ], "NextToken": "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.

InstanceTypes

Collection of supported instance types for WorkSpaces Instances.

Type: Array of InstanceTypeInfo objects

NextToken

Token for retrieving additional instance types if the result set is paginated.

Type: String

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

Errors

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

AccessDeniedException

Indicates insufficient permissions to perform the requested action.

Message

Detailed explanation of the access denial.

HTTP Status Code: 400

InternalServerException

Indicates an unexpected server-side error occurred.

Message

Description of the internal server error.

RetryAfterSeconds

Recommended wait time before retrying the request.

HTTP Status Code: 500

ThrottlingException

Indicates the request rate has exceeded limits.

Message

Description of the throttling event.

QuotaCode

Specific code for the throttling quota.

RetryAfterSeconds

Recommended wait time before retrying the request.

ServiceCode

Code identifying the service experiencing throttling.

HTTP Status Code: 400

ValidationException

Indicates invalid input parameters in the request.

FieldList

List of fields that failed validation.

Message

Overall description of validation failures.

Reason

Specific reason for the validation failure.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: