iter_get_images `async` ¶

iter_get_images(
    image_selector_type: ImageSelectorType,
    start_timestamp: Timestamp,
    end_timestamp: Timestamp,
    format: Format,
    *,
    config_overrides: Optional[AsyncKinesisVideoArchivedMediaClientConfig] = None,
    stream_name: Optional[StreamName] = None,
    stream_arn: Optional[ResourceARN] = None,
    sampling_interval: Optional[SamplingInterval] = None,
    format_config: Optional[FormatConfig] = None,
    width_pixels: Optional[WidthPixels] = None,
    height_pixels: Optional[HeightPixels] = None,
    max_results: Optional[GetImagesMaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> AsyncIterator[Image]

Source code in docs_src/capo_kinesis_video_archived_media/_services/async_kinesis_video_archived_media.py

async def iter_get_images(
    self,
    image_selector_type: "capo_kinesis_video_archived_media.types.image_selector_type.ImageSelectorType",
    start_timestamp: "capo_kinesis_video_archived_media.types.timestamp.Timestamp",
    end_timestamp: "capo_kinesis_video_archived_media.types.timestamp.Timestamp",
    format: "capo_kinesis_video_archived_media.types.format.Format",
    *,
    config_overrides: Optional[AsyncKinesisVideoArchivedMediaClientConfig] = None,
    stream_name: Optional[
        "capo_kinesis_video_archived_media.types.stream_name.StreamName"
    ] = None,
    stream_arn: Optional[
        "capo_kinesis_video_archived_media.types.resource_arn.ResourceARN"
    ] = None,
    sampling_interval: Optional[
        "capo_kinesis_video_archived_media.types.sampling_interval.SamplingInterval"
    ] = None,
    format_config: Optional[
        "capo_kinesis_video_archived_media.types.format_config.FormatConfig"
    ] = None,
    width_pixels: Optional[
        "capo_kinesis_video_archived_media.types.width_pixels.WidthPixels"
    ] = None,
    height_pixels: Optional[
        "capo_kinesis_video_archived_media.types.height_pixels.HeightPixels"
    ] = None,
    max_results: Optional[
        "capo_kinesis_video_archived_media.types.get_images_max_results.GetImagesMaxResults"
    ] = None,
    next_token: Optional[
        "capo_kinesis_video_archived_media.types.next_token.NextToken"
    ] = None,
) -> "AsyncIterator[capo_kinesis_video_archived_media.types.image.Image]":
    _token = next_token
    while True:
        _response = await self.get_images(
            image_selector_type,
            start_timestamp,
            end_timestamp,
            format,
            config_overrides=config_overrides,
            stream_name=stream_name,
            stream_arn=stream_arn,
            sampling_interval=sampling_interval,
            format_config=format_config,
            width_pixels=width_pixels,
            height_pixels=height_pixels,
            max_results=max_results,
            next_token=_token,
        )
        _page = _resolve_path(_response, ("images",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("next_token",))
        if not _token:
            break

iter_get_images async ¶

iter_get_images `async` ¶