Skip to content

ListFragmentsInput

Source code in docs_src/capo_kinesis_video_archived_media/types/list_fragments_input.py
class ListFragmentsInput(TypedDict, closed=True):
    stream_name: NotRequired[
        "capo_kinesis_video_archived_media.types.stream_name.StreamName"
    ]
    """<p>The name of the stream from which to retrieve a fragment list. Specify either this parameter or the <code>StreamARN</code> parameter.</p>"""
    stream_arn: NotRequired[
        "capo_kinesis_video_archived_media.types.resource_arn.ResourceARN"
    ]
    """<p>The Amazon Resource Name (ARN) of the stream from which to retrieve a fragment list. Specify either this parameter or the <code>StreamName</code> parameter.</p>"""
    max_results: NotRequired[
        "capo_kinesis_video_archived_media.types.list_fragments_max_results.ListFragmentsMaxResults"
    ]
    """<p>The total number of fragments to return. If the total number of fragments available is more than the value specified in <code>max-results</code>, then a <a>ListFragmentsOutput$NextToken</a> is provided in the output that you can use to resume pagination.</p>"""
    next_token: NotRequired[
        "capo_kinesis_video_archived_media.types.next_token.NextToken"
    ]
    """<p>A token to specify where to start paginating. This is the <a>ListFragmentsOutput$NextToken</a> from a previously truncated response.</p>"""
    fragment_selector: NotRequired[
        "capo_kinesis_video_archived_media.types.fragment_selector.FragmentSelector"
    ]
    """<p>Describes the timestamp range and timestamp origin for the range of fragments to return.</p> <note> <p>This is only required when the <code>NextToken</code> isn't passed in the API.</p> </note>"""

fragment_selector instance-attribute

fragment_selector: NotRequired[FragmentSelector]

Describes the timestamp range and timestamp origin for the range of fragments to return.

This is only required when the NextToken isn't passed in the API.

max_results instance-attribute

max_results: NotRequired[ListFragmentsMaxResults]

The total number of fragments to return. If the total number of fragments available is more than the value specified in max-results, then a ListFragmentsOutput$NextToken is provided in the output that you can use to resume pagination.

next_token instance-attribute

next_token: NotRequired[NextToken]

A token to specify where to start paginating. This is the ListFragmentsOutput$NextToken from a previously truncated response.

stream_arn instance-attribute

stream_arn: NotRequired[ResourceARN]

The Amazon Resource Name (ARN) of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamName parameter.

stream_name instance-attribute

stream_name: NotRequired[StreamName]

The name of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamARN parameter.