Skip to content

iter_describe_images

iter_describe_images(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    executable_users: Optional[ExecutableByStringList] = None,
    image_ids: Optional[ImageIdStringList] = None,
    owners: Optional[OwnerStringList] = None,
    include_deprecated: Optional[Boolean] = None,
    include_disabled: Optional[Boolean] = None,
    max_results: Optional[Integer] = None,
    next_token: Optional[String] = None,
    dry_run: Optional[Boolean] = None,
    filters: Optional[FilterList] = None,
) -> Iterator[Image]
Source code in docs_src/capo_ec2/_services/ec2.py
def iter_describe_images(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    executable_users: Optional[
        "capo_ec2.types.executable_by_string_list.ExecutableByStringList"
    ] = None,
    image_ids: Optional[
        "capo_ec2.types.image_id_string_list.ImageIdStringList"
    ] = None,
    owners: Optional["capo_ec2.types.owner_string_list.OwnerStringList"] = None,
    include_deprecated: Optional["capo_ec2.types.boolean.Boolean"] = None,
    include_disabled: Optional["capo_ec2.types.boolean.Boolean"] = None,
    max_results: Optional["capo_ec2.types.integer.Integer"] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
) -> "Iterator[capo_ec2.types.image.Image]":
    _token = next_token
    while True:
        _response = self.describe_images(
            config_overrides=config_overrides,
            executable_users=executable_users,
            image_ids=image_ids,
            owners=owners,
            include_deprecated=include_deprecated,
            include_disabled=include_disabled,
            max_results=max_results,
            next_token=_token,
            dry_run=dry_run,
            filters=filters,
        )
        _page = _resolve_path(_response, ("images",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("next_token",))
        if not _token:
            break