list_workgroups `async` ¶

list_workgroups(
    *,
    config_overrides: Optional[AsyncRedshiftServerlessClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
    owner_account: Optional[OwnerAccount] = None,
) -> ListWorkgroupsResponse

Returns information about a list of specified workgroups.

Parameters:

next_token (Optional[str], default: None ) –

If your initial ListWorkgroups operation returns a nextToken, you can include the returned nextToken in following ListNamespaces operations, which returns results in the next page.
max_results (Optional[int], default: None ) –

An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
owner_account (Optional[OwnerAccount], default: None ) –

The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.

Raises:

InternalServerException –

The request processing has failed because of an unknown error, exception or failure.
ValidationException –

The input failed to satisfy the constraints specified by an Amazon Web Services service.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_redshift_serverless/_services/async_redshift_serverless.py

async def list_workgroups(
    self,
    *,
    config_overrides: Optional[AsyncRedshiftServerlessClientConfig] = 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.
    """

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

        (
            output,
            http_response,
        ) = await capo_redshift_serverless._operations.redshift_serverless.list_workgroups.async_list_workgroups(
            req.options, req.input
        )
        return AsyncOperationResponse(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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

list_workgroups async ¶

list_workgroups `async` ¶