list_work_groups `async` ¶

list_work_groups(
    *,
    config_overrides: Optional[AsyncAthenaClientConfig] = None,
    next_token: Optional[Token] = None,
    max_results: Optional[MaxWorkGroupsCount] = None,
) -> ListWorkGroupsOutput

Lists available workgroups for the account.

Parameters:

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

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
max_results (Optional[MaxWorkGroupsCount], default: None ) –

The maximum number of workgroups to return in this request.

Raises:

InternalServerException –

Indicates a platform issue, which may be due to a transient condition or outage.
InvalidRequestException –

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
UnknownServiceError –

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

Source code in docs_src/capo_athena/_services/async_athena.py

async def list_work_groups(
    self,
    *,
    config_overrides: Optional[AsyncAthenaClientConfig] = None,
    next_token: Optional["capo_athena.types.token.Token"] = None,
    max_results: Optional[
        "capo_athena.types.max_work_groups_count.MaxWorkGroupsCount"
    ] = None,
) -> "capo_athena.types.list_work_groups_output.ListWorkGroupsOutput":
    """<p>Lists available workgroups for the account.</p>

    Args:
        next_token: <p>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the <code>NextToken</code> from the response object of the previous page call.</p>
        max_results: <p>The maximum number of workgroups to return in this request.</p>

    Raises:
        capo_athena.errors.internal_server_exception.InternalServerException: <p>Indicates a platform issue, which may be due to a transient condition or outage.</p>
        capo_athena.errors.invalid_request_exception.InvalidRequestException: <p>Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.</p>
        capo_athena.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_athena.types.list_work_groups_input.ListWorkGroupsInput]",
    ) -> AsyncOperationResponse[
        "capo_athena.types.list_work_groups_output.ListWorkGroupsOutput"
    ]:
        import capo_athena._operations.amazon_athena.list_work_groups

        (
            output,
            http_response,
        ) = await capo_athena._operations.amazon_athena.list_work_groups.async_list_work_groups(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListWorkGroups")
    )
    input_: capo_athena.types.list_work_groups_input.ListWorkGroupsInput = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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

list_work_groups async ¶

list_work_groups `async` ¶