Skip to content

list_regions async

list_regions(
    *,
    config_overrides: Optional[AsyncWorkspacesInstancesClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListRegionsResponse

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

Parameters:

  • max_results (Optional[MaxResults], default: None ) –

    Maximum number of regions to return in a single API call. Enables pagination of region results.

  • next_token (Optional[NextToken], default: None ) –

    Pagination token for retrieving subsequent pages of region results.

Raises:

Source code in docs_src/capo_workspaces_instances/_services/async_workspaces_instances.py
async def list_regions(
    self,
    *,
    config_overrides: Optional[AsyncWorkspacesInstancesClientConfig] = None,
    max_results: Optional[
        "capo_workspaces_instances.types.max_results.MaxResults"
    ] = None,
    next_token: Optional[
        "capo_workspaces_instances.types.next_token.NextToken"
    ] = None,
) -> "capo_workspaces_instances.types.list_regions_response.ListRegionsResponse":
    """<p>Retrieves a list of AWS regions supported by Amazon WorkSpaces Instances, enabling region discovery for workspace deployments.</p>

    Args:
        max_results: <p>Maximum number of regions to return in a single API call. Enables pagination of region results.</p>
        next_token: <p>Pagination token for retrieving subsequent pages of region results.</p>

    Raises:
        capo_workspaces_instances.errors.access_denied_exception.AccessDeniedException: <p>Indicates insufficient permissions to perform the requested action.</p>
        capo_workspaces_instances.errors.internal_server_exception.InternalServerException: <p>Indicates an unexpected server-side error occurred.</p>
        capo_workspaces_instances.errors.throttling_exception.ThrottlingException: <p>Indicates the request rate has exceeded limits.</p>
        capo_workspaces_instances.errors.validation_exception.ValidationException: <p>Indicates invalid input parameters in the request.</p>
        capo_workspaces_instances.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_workspaces_instances.types.list_regions_request.ListRegionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_workspaces_instances.types.list_regions_response.ListRegionsResponse"
    ]:
        import capo_workspaces_instances._operations.eucmi_frontend_api_service.list_regions

        (
            output,
            http_response,
        ) = await capo_workspaces_instances._operations.eucmi_frontend_api_service.list_regions.async_list_regions(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_workspaces_instances.types.list_regions_request.ListRegionsRequest",
    ) -> dict[str, Any]:
        import capo_workspaces_instances.types.list_regions_request

        return (
            capo_workspaces_instances.types.list_regions_request.redact_sensitive(
                input_
            )
        )

    def _redact_output(
        output: "capo_workspaces_instances.types.list_regions_response.ListRegionsResponse",
    ) -> dict[str, Any]:
        import capo_workspaces_instances.types.list_regions_response

        return (
            capo_workspaces_instances.types.list_regions_response.redact_sensitive(
                output
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "ListRegions", redact_input=_redact_input, redact_output=_redact_output
        ),
    )
    input_: capo_workspaces_instances.types.list_regions_request.ListRegionsRequest = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output