Skip to content

ListImagesRequest

Source code in docs_src/capo_imagebuilder/types/list_images_request.py
class ListImagesRequest(TypedDict, closed=True):
    owner: NotRequired["capo_imagebuilder.types.ownership.Ownership"]
    """<p>Filters the list to images owned by you, by Amazon, or shared with you by other accounts. By default, only your account's images are returned.</p>"""
    filters: NotRequired["capo_imagebuilder.types.filter_list.FilterList"]
    """<p>Use the following filters to streamline results:</p> <ul> <li> <p> <code>name</code> </p> </li> <li> <p> <code>osVersion</code> </p> </li> <li> <p> <code>platform</code> </p> </li> <li> <p> <code>type</code> </p> </li> <li> <p> <code>version</code> </p> </li> </ul>"""
    by_name: "capo_imagebuilder.types.boolean.Boolean"
    """<p>Specifies whether to return one entry per image name, with all versions of each image aggregated. Defaults to <code>false</code>, which returns one entry per image version. You can't combine this option with the <code>version</code> filter.</p>"""
    max_results: NotRequired[
        "capo_imagebuilder.types.restricted_integer.RestrictedInteger"
    ]
    """<p>The maximum number of items to return in a single request.</p>"""
    next_token: NotRequired["capo_imagebuilder.types.pagination_token.PaginationToken"]
    """<p>A token to specify where to start paginating. Use the <code>nextToken</code> value from a previously truncated response.</p>"""
    include_deprecated: NotRequired[
        "capo_imagebuilder.types.nullable_boolean.NullableBoolean"
    ]
    """<p>Specifies whether to include deprecated Amazon-managed images in the results. Deprecated images that you own are always returned. Defaults to <code>false</code>.</p>"""

by_name instance-attribute

by_name: Boolean

Specifies whether to return one entry per image name, with all versions of each image aggregated. Defaults to false, which returns one entry per image version. You can't combine this option with the version filter.

filters instance-attribute

filters: NotRequired[FilterList]

Use the following filters to streamline results:

  • name

  • osVersion

  • platform

  • type

  • version

include_deprecated instance-attribute

include_deprecated: NotRequired[NullableBoolean]

Specifies whether to include deprecated Amazon-managed images in the results. Deprecated images that you own are always returned. Defaults to false.

max_results instance-attribute

max_results: NotRequired[RestrictedInteger]

The maximum number of items to return in a single request.

next_token instance-attribute

next_token: NotRequired[PaginationToken]

A token to specify where to start paginating. Use the nextToken value from a previously truncated response.

owner instance-attribute

owner: NotRequired[Ownership]

Filters the list to images owned by you, by Amazon, or shared with you by other accounts. By default, only your account's images are returned.