Skip to content

ListInstancesRequest

Source code in docs_src/capo_supplychain/types/list_instances_request.py
class ListInstancesRequest(TypedDict, closed=True):
    next_token: NotRequired[
        "capo_supplychain.types.instance_next_token.InstanceNextToken"
    ]
    """<p>The pagination token to fetch the next page of instances.</p>"""
    max_results: "capo_supplychain.types.instance_max_results.InstanceMaxResults"
    """<p>Specify the maximum number of instances to fetch in this paginated request.</p>"""
    instance_name_filter: NotRequired[
        "capo_supplychain.types.instance_name_list.InstanceNameList"
    ]
    """<p>The filter to ListInstances based on their names.</p>"""
    instance_state_filter: NotRequired[
        "capo_supplychain.types.instance_state_list.InstanceStateList"
    ]
    """<p>The filter to ListInstances based on their state.</p>"""

instance_name_filter instance-attribute

instance_name_filter: NotRequired[InstanceNameList]

The filter to ListInstances based on their names.

instance_state_filter instance-attribute

instance_state_filter: NotRequired[InstanceStateList]

The filter to ListInstances based on their state.

max_results instance-attribute

max_results: InstanceMaxResults

Specify the maximum number of instances to fetch in this paginated request.

next_token instance-attribute

next_token: NotRequired[InstanceNextToken]

The pagination token to fetch the next page of instances.