list_clusters_v2 `async` ¶

list_clusters_v2(
    *,
    config_overrides: Optional[AsyncKafkaClientConfig] = None,
    cluster_name_filter: Optional[__string] = None,
    cluster_type_filter: Optional[__string] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[__string] = None,
) -> ListClustersV2Response

Returns a list of all the MSK clusters in the current Region.

Parameters:

cluster_name_filter (Optional[__string], default: None ) –

Specify a prefix of the names of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.
cluster_type_filter (Optional[__string], default: None ) –

Specify either PROVISIONED or SERVERLESS.
max_results (Optional[MaxResults], default: None ) –

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
next_token (Optional[__string], default: None ) –

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

Raises:

BadRequestException –

Returns information about an error.
ForbiddenException –

Returns information about an error.
InternalServerErrorException –

Returns information about an error.
UnauthorizedException –

Returns information about an error.
UnknownServiceError –

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

Source code in docs_src/capo_kafka/_services/async_kafka.py

async def list_clusters_v2(
    self,
    *,
    config_overrides: Optional[AsyncKafkaClientConfig] = None,
    cluster_name_filter: Optional["capo_kafka.types.__string.__string"] = None,
    cluster_type_filter: Optional["capo_kafka.types.__string.__string"] = None,
    max_results: Optional["capo_kafka.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_kafka.types.__string.__string"] = None,
) -> "capo_kafka.types.list_clusters_v2_response.ListClustersV2Response":
    """<p>Returns a list of all the MSK clusters in the current Region.</p>

    Args:
        cluster_name_filter: <p>Specify a prefix of the names of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.</p>
        cluster_type_filter: <p>Specify either PROVISIONED or SERVERLESS.</p>
        max_results: <p>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</p>
        next_token: <p>The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.</p>

    Raises:
        capo_kafka.errors.bad_request_exception.BadRequestException: <p>Returns information about an error.</p>
        capo_kafka.errors.forbidden_exception.ForbiddenException: <p>Returns information about an error.</p>
        capo_kafka.errors.internal_server_error_exception.InternalServerErrorException: <p>Returns information about an error.</p>
        capo_kafka.errors.unauthorized_exception.UnauthorizedException: <p>Returns information about an error.</p>
        capo_kafka.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_kafka.types.list_clusters_v2_request.ListClustersV2Request]",
    ) -> AsyncOperationResponse[
        "capo_kafka.types.list_clusters_v2_response.ListClustersV2Response"
    ]:
        import capo_kafka._operations.kafka.list_clusters_v2

        (
            output,
            http_response,
        ) = await capo_kafka._operations.kafka.list_clusters_v2.async_list_clusters_v2(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListClustersV2")
    )
    input_: capo_kafka.types.list_clusters_v2_request.ListClustersV2Request = {}
    if cluster_name_filter is not None:
        input_["cluster_name_filter"] = cluster_name_filter
    if cluster_type_filter is not None:
        input_["cluster_type_filter"] = cluster_type_filter
    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

list_clusters_v2 async ¶

list_clusters_v2 `async` ¶