WorkspacesInstances / Client / list_regions

list_regions

WorkspacesInstances.Client.list_regions(**kwargs)

Retrieves a list of AWS regions supported by Amazon WorkSpaces Instances, enabling region discovery for workspace deployments.

See also: AWS API Documentation

Request Syntax

response = client.list_regions(
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • MaxResults (integer) – Maximum number of regions to return in a single API call. Enables pagination of region results.

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

Return type:

dict

Returns:

Response Syntax

{
    'Regions': [
        {
            'RegionName': 'string'
        },
    ],
    'NextToken': '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.

    • NextToken (string) –

      Token for retrieving additional regions if the result set is paginated.

Exceptions