WorkspacesInstances / Client / list_instance_types

list_instance_types

WorkspacesInstances.Client.list_instance_types(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_instance_types(
    MaxResults=123,
    NextToken='string'
)
Parameters:
  • MaxResults (integer) – Maximum number of instance types to return in a single API call. Enables pagination of instance type results.

  • NextToken (string) – Pagination token for retrieving subsequent pages of instance type results.

Return type:

dict

Returns:

Response Syntax

{
    'InstanceTypes': [
        {
            'InstanceType': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    Contains the list of instance types supported by WorkSpaces Instances.

    • InstanceTypes (list) –

      Collection of supported instance types for WorkSpaces Instances.

      • (dict) –

        Provides details about a specific WorkSpace Instance type.

        • InstanceType (string) –

          Unique identifier for the WorkSpace Instance type.

    • NextToken (string) –

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

Exceptions

  • WorkspacesInstances.Client.exceptions.ValidationException

  • WorkspacesInstances.Client.exceptions.AccessDeniedException

  • WorkspacesInstances.Client.exceptions.ThrottlingException

  • WorkspacesInstances.Client.exceptions.InternalServerException