list_workspace_instances ¶

def list_workspace_instances(
    self,
    *,
    config_overrides: Optional[WorkspacesInstancesClientConfig] = None,
    provision_states: Optional[
        "capo_workspaces_instances.types.provision_states.ProvisionStates"
    ] = 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_workspace_instances_response.ListWorkspaceInstancesResponse":
    """<p>Retrieves a collection of WorkSpaces Instances based on specified filters.</p>

    Args:
        provision_states: <p>Filter WorkSpaces Instances by their current provisioning states.</p>
        max_results: <p>Maximum number of WorkSpaces Instances to return in a single response.</p>
        next_token: <p>Pagination token for retrieving subsequent pages of WorkSpaces Instances.</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.
    """

    def _handler(
        req: "OperationRequest[capo_workspaces_instances.types.list_workspace_instances_request.ListWorkspaceInstancesRequest]",
    ) -> OperationResponse[
        "capo_workspaces_instances.types.list_workspace_instances_response.ListWorkspaceInstancesResponse"
    ]:
        import capo_workspaces_instances._operations.eucmi_frontend_api_service.list_workspace_instances

        output, http_response = (
            capo_workspaces_instances._operations.eucmi_frontend_api_service.list_workspace_instances.list_workspace_instances(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

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

        return capo_workspaces_instances.types.list_workspace_instances_request.redact_sensitive(
            input_
        )

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

        return capo_workspaces_instances.types.list_workspace_instances_response.redact_sensitive(
            output
        )

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

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output