Skip to content

GetStatisticsRequest

Source code in docs_src/capo_iot/types/get_statistics_request.py
class GetStatisticsRequest(TypedDict, closed=True):
    index_name: NotRequired["capo_iot.types.index_name.IndexName"]
    """<p>The name of the index to search. The default value is <code>AWS_Things</code>.</p>"""
    query_string: "capo_iot.types.query_string.QueryString"
    """<p>The query used to search. You can specify "*" for the query string to get the count of all indexed things in your Amazon Web Services account.</p>"""
    aggregation_field: NotRequired["capo_iot.types.aggregation_field.AggregationField"]
    """<p>The aggregation field name.</p>"""
    query_version: NotRequired["capo_iot.types.query_version.QueryVersion"]
    """<p>The version of the query used to search.</p>"""

aggregation_field instance-attribute

aggregation_field: NotRequired[AggregationField]

The aggregation field name.

index_name instance-attribute

index_name: NotRequired[IndexName]

The name of the index to search. The default value is AWS_Things.

query_string instance-attribute

query_string: QueryString

The query used to search. You can specify "*" for the query string to get the count of all indexed things in your Amazon Web Services account.

query_version instance-attribute

query_version: NotRequired[QueryVersion]

The version of the query used to search.