WorkspacesInstances / Paginator / ListRegions

ListRegions

class WorkspacesInstances.Paginator.ListRegions

paginator = client.get_paginator('list_regions')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

{
    'Regions': [
        {
            'RegionName': 'string'
        },
    ],

}

Response Structure

• (dict) –

  Contains the list of supported AWS regions for WorkSpaces Instances.

  • Regions (list) –

    Collection of AWS regions supported by WorkSpaces Instances.

    • (dict) –

      Represents an AWS region supported by WorkSpaces Instances.

      • RegionName (string) –

        Name of the AWS region.