Skip to content

ListThingsRequest

Source code in docs_src/capo_iot/types/list_things_request.py
class ListThingsRequest(TypedDict, closed=True):
    next_token: NotRequired["capo_iot.types.next_token.NextToken"]
    """<p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response; otherwise <b>null</b> to receive the first set of results.</p>"""
    max_results: NotRequired["capo_iot.types.registry_max_results.RegistryMaxResults"]
    """<p>The maximum number of results to return in this operation.</p>"""
    attribute_name: NotRequired["capo_iot.types.attribute_name.AttributeName"]
    """<p>The attribute name used to search for things.</p>"""
    attribute_value: NotRequired["capo_iot.types.attribute_value.AttributeValue"]
    """<p>The attribute value used to search for things.</p>"""
    thing_type_name: NotRequired["capo_iot.types.thing_type_name.ThingTypeName"]
    """<p>The name of the thing type used to search for things.</p>"""
    use_prefix_attribute_value: (
        "capo_iot.types.use_prefix_attribute_value.usePrefixAttributeValue"
    )
    """<p>When <code>true</code>, the action returns the thing resources with attribute values that start with the <code>attributeValue</code> provided.</p> <p>When <code>false</code>, or not present, the action returns only the thing resources with attribute values that match the entire <code>attributeValue</code> provided. </p>"""

attribute_name instance-attribute

attribute_name: NotRequired[AttributeName]

The attribute name used to search for things.

attribute_value instance-attribute

attribute_value: NotRequired[AttributeValue]

The attribute value used to search for things.

max_results instance-attribute

max_results: NotRequired[RegistryMaxResults]

The maximum number of results to return in this operation.

next_token instance-attribute

next_token: NotRequired[NextToken]

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

thing_type_name instance-attribute

thing_type_name: NotRequired[ThingTypeName]

The name of the thing type used to search for things.

use_prefix_attribute_value instance-attribute

use_prefix_attribute_value: usePrefixAttributeValue

When true, the action returns the thing resources with attribute values that start with the attributeValue provided.

When false, or not present, the action returns only the thing resources with attribute values that match the entire attributeValue provided.