Paginators

Index > KinesisVideoArchivedMedia > Paginators

Auto-generated documentation for KinesisVideoArchivedMedia type annotations stubs module mypy-boto3-kinesis-video-archived-media.

GetImagesPaginator

Type annotations and code completion for boto3.client("kinesis-video-archived-media").get_paginator("get_images"). boto3 documentation

# GetImagesPaginator usage example

from boto3.session import Session

from mypy_boto3_kinesis_video_archived_media.paginator import GetImagesPaginator

def get_get_images_paginator() -> GetImagesPaginator:
    return Session().client("kinesis-video-archived-media").get_paginator("get_images")

# GetImagesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_kinesis_video_archived_media.paginator import GetImagesPaginator

session = Session()

client = Session().client("kinesis-video-archived-media")  # (1)
paginator: GetImagesPaginator = client.get_paginator("get_images")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: KinesisVideoArchivedMediaClient
2. paginator: GetImagesPaginator
3. item: GetImagesOutputTypeDef

paginate

Type annotations and code completion for GetImagesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    ImageSelectorType: ImageSelectorTypeType,  # (1)
    StartTimestamp: TimestampTypeDef,
    EndTimestamp: TimestampTypeDef,
    Format: FormatType,  # (2)
    StreamName: str = ...,
    StreamARN: str = ...,
    SamplingInterval: int = ...,
    FormatConfig: Mapping[FormatConfigKeyType, str] = ...,  # (3)
    WidthPixels: int = ...,
    HeightPixels: int = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (4)
) -> PageIterator[GetImagesOutputTypeDef]:  # (5)
    ...

1. See ImageSelectorTypeType
2. See FormatType
3. See FormatConfigKeyType
4. See PaginatorConfigTypeDef
5. See GetImagesOutputTypeDef

# paginate method usage example with argument unpacking

kwargs: GetImagesInputPaginateTypeDef = {  # (1)
    "ImageSelectorType": ...,
    "StartTimestamp": ...,
    "EndTimestamp": ...,
    "Format": ...,
}

parent.paginate(**kwargs)

1. See GetImagesInputPaginateTypeDef

ListFragmentsPaginator

Type annotations and code completion for boto3.client("kinesis-video-archived-media").get_paginator("list_fragments"). boto3 documentation

# ListFragmentsPaginator usage example

from boto3.session import Session

from mypy_boto3_kinesis_video_archived_media.paginator import ListFragmentsPaginator

def get_list_fragments_paginator() -> ListFragmentsPaginator:
    return Session().client("kinesis-video-archived-media").get_paginator("list_fragments")

# ListFragmentsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_kinesis_video_archived_media.paginator import ListFragmentsPaginator

session = Session()

client = Session().client("kinesis-video-archived-media")  # (1)
paginator: ListFragmentsPaginator = client.get_paginator("list_fragments")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: KinesisVideoArchivedMediaClient
2. paginator: ListFragmentsPaginator
3. item: ListFragmentsOutputTypeDef

paginate

Type annotations and code completion for ListFragmentsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    StreamName: str = ...,
    StreamARN: str = ...,
    FragmentSelector: FragmentSelectorTypeDef = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> PageIterator[ListFragmentsOutputTypeDef]:  # (3)
    ...

1. See FragmentSelectorTypeDef
2. See PaginatorConfigTypeDef
3. See ListFragmentsOutputTypeDef

# paginate method usage example with argument unpacking

kwargs: ListFragmentsInputPaginateTypeDef = {  # (1)
    "StreamName": ...,
}

parent.paginate(**kwargs)

1. See ListFragmentsInputPaginateTypeDef