imagebuilder / Paginator / ListImages

ListImages¶

class imagebuilder.Paginator.ListImages¶

paginator = client.get_paginator('list_images')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from imagebuilder.Client.list_images().

Request Syntax

response_iterator = paginator.paginate(
    owner='Self'|'Shared'|'Amazon'|'ThirdParty'|'AWSMarketplace',
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    byName=True|False,
    includeDeprecated=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

owner (string) – 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.
filters (list) –
Use the following filters to streamline results:
- name
- osVersion
- platform
- type
- version
- (dict) –
  
  A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
  - name (string) –
    
    The name of the filter. Filter names are case-sensitive.
  - values (list) –
    
    The filter values. Filter values are case-sensitive.
    - (string) –
byName (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.
includeDeprecated (boolean) – Specifies whether to include deprecated Amazon-managed images in the results. Deprecated images that you own are always returned. Defaults to false.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'requestId': 'string',
    'imageVersionList': [
        {
            'arn': 'string',
            'name': 'string',
            'type': 'AMI'|'DOCKER',
            'version': 'string',
            'platform': 'Windows'|'Linux'|'macOS',
            'osVersion': 'string',
            'owner': 'string',
            'dateCreated': 'string',
            'buildType': 'USER_INITIATED'|'SCHEDULED'|'IMPORT'|'IMPORT_ISO',
            'imageSource': 'AMAZON_MANAGED'|'AWS_MARKETPLACE'|'IMPORTED'|'CUSTOM'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- requestId (string) –
  
  The request ID that uniquely identifies this request.
- imageVersionList (list) –
  
  The list of image semantic versions.
  
  Note
  The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
  
  Filtering: You can use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
  - (dict) –
    
    The defining characteristics of a specific version of an Image Builder image.
    - arn (string) –
      
      The Amazon Resource Name (ARN) of a specific version of an Image Builder image.
      Note
      Semantic versioning is included in each object’s Amazon Resource Name (ARN), at the level that applies to that object as follows:
      
      Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
      
      Version ARNs have only the first three nodes: <major>.<minor>.<patch>
      
      Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
    - name (string) –
      
      The name of this specific version of an Image Builder image.
    - type (string) –
      
      Specifies whether this image produces an AMI or a container image.
    - version (string) –
      
      The semantic version of the image. This version follows the semantic version syntax.
      
      Note
      The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
      
      Assignment: For the first three nodes, you can assign any positive integer value, including zero. The upper limit is 2^30-1, or 1073741823, for each node. Image Builder automatically assigns the build number to the fourth node.
      
      Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
      
      Filtering: You can use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
    - platform (string) –
      
      The operating system platform of the image version, for example “Windows” or “Linux”.
    - osVersion (string) –
      
      The operating system version of the image. For example, Amazon Linux 2023 or Microsoft Windows Server 2022.
    - owner (string) –
      
      The owner of the image version.
    - dateCreated (string) –
      
      The date on which this specific version of the Image Builder image was created.
    - buildType (string) –
      
      Indicates the type of build that created this image. The build can be initiated in the following ways:
      - USER_INITIATED – A manual pipeline build request.
      - SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
      - IMPORT – A VM import created the image to use as the base image for the recipe.
      - IMPORT_ISO – An ISO disk import created the image.
    - imageSource (string) –
      
      The origin of the base image that Image Builder used to build this image.
- NextToken (string) –
  
  A token to resume pagination.