Skip to content

ListStreamsInput

Source code in docs_src/capo_kinesis_video/types/list_streams_input.py
class ListStreamsInput(TypedDict, closed=True):
    max_results: NotRequired[
        "capo_kinesis_video.types.list_streams_input_limit.ListStreamsInputLimit"
    ]
    """<p>The maximum number of streams to return in the response. The default is 10,000.</p>"""
    next_token: NotRequired["capo_kinesis_video.types.next_token.NextToken"]
    """<p>If you specify this parameter, when the result of a <code>ListStreams</code> operation is truncated, the call returns the <code>NextToken</code> in the response. To get another batch of streams, provide this token in your next request.</p>"""
    stream_name_condition: NotRequired[
        "capo_kinesis_video.types.stream_name_condition.StreamNameCondition"
    ]
    """<p>Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition. </p>"""

max_results instance-attribute

max_results: NotRequired[ListStreamsInputLimit]

The maximum number of streams to return in the response. The default is 10,000.

next_token instance-attribute

next_token: NotRequired[NextToken]

If you specify this parameter, when the result of a ListStreams operation is truncated, the call returns the NextToken in the response. To get another batch of streams, provide this token in your next request.

stream_name_condition instance-attribute

stream_name_condition: NotRequired[StreamNameCondition]

Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.