WorkspacesInstances / Paginator / ListInstanceTypes

ListInstanceTypes

class WorkspacesInstances.Paginator.ListInstanceTypes

paginator = client.get_paginator('list_instance_types')

paginate(**kwargs)

Creates an iterator that will paginate through responses from WorkspacesInstances.Client.list_instance_types().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    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'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• 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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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'
                },
            ]
        },
    ],

}

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.