list_workgroups ¶

def list_workgroups(
    self,
    *,
    config_overrides: Optional[RedshiftServerlessClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
    owner_account: Optional[
        "capo_redshift_serverless.types.owner_account.OwnerAccount"
    ] = None,
) -> (
    "capo_redshift_serverless.types.list_workgroups_response.ListWorkgroupsResponse"
):
    """<p>Returns information about a list of specified workgroups.</p>

    Args:
        next_token: <p>If your initial ListWorkgroups operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in following ListNamespaces operations, which returns results in the next page.</p>
        max_results: <p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to display the next page of results.</p>
        owner_account: <p>The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.</p>

    Raises:
        capo_redshift_serverless.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_redshift_serverless.errors.validation_exception.ValidationException: <p>The input failed to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_redshift_serverless.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_redshift_serverless.types.list_workgroups_request.ListWorkgroupsRequest]",
    ) -> OperationResponse[
        "capo_redshift_serverless.types.list_workgroups_response.ListWorkgroupsResponse"
    ]:
        import capo_redshift_serverless._operations.redshift_serverless.list_workgroups

        output, http_response = (
            capo_redshift_serverless._operations.redshift_serverless.list_workgroups.list_workgroups(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListWorkgroups")
    )
    input_: capo_redshift_serverless.types.list_workgroups_request.ListWorkgroupsRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if owner_account is not None:
        input_["owner_account"] = owner_account

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