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.

Request Syntax

response = client.list_instance_types(
    MaxResults=123,
    NextToken='string',
    InstanceConfigurationFilter={
        'BillingMode': 'MONTHLY'|'HOURLY',
        'PlatformType': 'Windows'|'Windows BYOL'|'Linux/UNIX'|'Ubuntu Pro Linux'|'Red Hat Enterprise Linux'|'Red Hat BYOL Linux'|'SUSE Linux',
        'Tenancy': 'SHARED'|'DEDICATED'
    }
)

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.
InstanceConfigurationFilter (dict) –
Optional filter to narrow instance type results based on configuration requirements. Only returns instance types that support the specified combination of tenancy, platform type, and billing mode.
- BillingMode (string) – [REQUIRED]
  
  Filters WorkSpace Instance types based on supported billing modes. Allows customers to search for instance types that support their preferred billing model, such as HOURLY or MONTHLY billing.
- PlatformType (string) – [REQUIRED]
  
  Filters WorkSpace Instance types by operating system platform. Allows customers to find instances that support their desired OS, such as Windows, Linux/UNIX, Ubuntu Pro, RHEL, or SUSE.
- Tenancy (string) – [REQUIRED]
  
  Filters WorkSpace Instance types by tenancy model. Allows customers to find instances that match their tenancy requirements, such as SHARED or DEDICATED.

Return type:

dict

Returns:

Response Syntax

{
    'InstanceTypes': [
        {
            'InstanceType': 'string',
            'SupportedInstanceConfigurations': [
                {
                    'BillingMode': 'MONTHLY'|'HOURLY',
                    'PlatformType': 'Windows'|'Windows BYOL'|'Linux/UNIX'|'Ubuntu Pro Linux'|'Red Hat Enterprise Linux'|'Red Hat BYOL Linux'|'SUSE Linux',
                    'Tenancy': 'SHARED'|'DEDICATED'
                },
            ]
        },
    ],
    '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.
    - SupportedInstanceConfigurations (list) –
      
      Lists all valid combinations of tenancy, platform type, and billing mode supported for the specific WorkSpace Instance type. Contains the complete set of configuration options available for this instance type.
      - (dict) –
        
        Represents a single valid configuration combination that an instance type supports, combining tenancy, platform type, and billing mode into one complete configuration specification.
        
        BillingMode (string) –
        
        Specifies the billing mode supported in this configuration combination.
        
        PlatformType (string) –
        
        Specifies the operating system platform supported in this configuration combination.
        
        Tenancy (string) –
        
        Specifies the tenancy model supported in this configuration combination.
- 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