get_cardinality `async` ¶

get_cardinality(
    query_string: QueryString,
    *,
    config_overrides: Optional[AsyncIoTClientConfig] = None,
    index_name: Optional[IndexName] = None,
    aggregation_field: Optional[AggregationField] = None,
    query_version: Optional[QueryVersion] = None,
) -> GetCardinalityResponse

Returns the approximate count of unique values that match the query.

Requires permission to access the GetCardinality action.

Parameters:

index_name (Optional[IndexName], default: None ) –

The name of the index to search.
query_string (QueryString) –

The search query string.
aggregation_field (Optional[AggregationField], default: None ) –

The field to aggregate.
query_version (Optional[QueryVersion], default: None ) –

The query version.

Raises:

IndexNotReadyException –

The index is not ready.
InternalFailureException –

An unexpected error has occurred.
InvalidAggregationException –

The aggregation is invalid.
InvalidQueryException –

The query is invalid.
InvalidRequestException –

The request is not valid.
ResourceNotFoundException –

The specified resource does not exist.
ServiceUnavailableException –

The service is temporarily unavailable.
ThrottlingException –

The rate exceeds the limit.
UnauthorizedException –

You are not authorized to perform this operation.
UnknownServiceError –

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

Source code in docs_src/capo_iot/_services/async_io_t.py

async def get_cardinality(
    self,
    query_string: "capo_iot.types.query_string.QueryString",
    *,
    config_overrides: Optional[AsyncIoTClientConfig] = None,
    index_name: Optional["capo_iot.types.index_name.IndexName"] = None,
    aggregation_field: Optional[
        "capo_iot.types.aggregation_field.AggregationField"
    ] = None,
    query_version: Optional["capo_iot.types.query_version.QueryVersion"] = None,
) -> "capo_iot.types.get_cardinality_response.GetCardinalityResponse":
    """<p>Returns the approximate count of unique values that match the query.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">GetCardinality</a> action.</p>

    Args:
        index_name: <p>The name of the index to search.</p>
        query_string: <p>The search query string.</p>
        aggregation_field: <p>The field to aggregate.</p>
        query_version: <p>The query version.</p>

    Raises:
        capo_iot.errors.index_not_ready_exception.IndexNotReadyException: <p>The index is not ready.</p>
        capo_iot.errors.internal_failure_exception.InternalFailureException: <p>An unexpected error has occurred.</p>
        capo_iot.errors.invalid_aggregation_exception.InvalidAggregationException: <p>The aggregation is invalid.</p>
        capo_iot.errors.invalid_query_exception.InvalidQueryException: <p>The query is invalid.</p>
        capo_iot.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_iot.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_iot.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is temporarily unavailable.</p>
        capo_iot.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iot.errors.unauthorized_exception.UnauthorizedException: <p>You are not authorized to perform this operation.</p>
        capo_iot.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iot.types.get_cardinality_request.GetCardinalityRequest]",
    ) -> AsyncOperationResponse[
        "capo_iot.types.get_cardinality_response.GetCardinalityResponse"
    ]:
        import capo_iot._operations.aws_iot_service.get_cardinality

        (
            output,
            http_response,
        ) = await capo_iot._operations.aws_iot_service.get_cardinality.async_get_cardinality(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetCardinality")
    )
    input_: capo_iot.types.get_cardinality_request.GetCardinalityRequest = {
        "query_string": query_string
    }
    if index_name is not None:
        input_["index_name"] = index_name
    if aggregation_field is not None:
        input_["aggregation_field"] = aggregation_field
    if query_version is not None:
        input_["query_version"] = query_version

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

get_cardinality async ¶

get_cardinality `async` ¶