imagebuilder / Paginator / ListImagePipelineImages

ListImagePipelineImages¶

class imagebuilder.Paginator.ListImagePipelineImages¶

paginator = client.get_paginator('list_image_pipeline_images')

paginate(**kwargs)¶

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

Request Syntax

response_iterator = paginator.paginate(
    imagePipelineArn='string',
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

imagePipelineArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the image pipeline whose images you want to view.
filters (list) –
Use the following filters to streamline results:
- name
- 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) –
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',
    'imageSummaryList': [
        {
            'arn': 'string',
            'name': 'string',
            'type': 'AMI'|'DOCKER',
            'version': 'string',
            'platform': 'Windows'|'Linux'|'macOS',
            'osVersion': 'string',
            'state': {
                'status': 'PENDING'|'CREATING'|'BUILDING'|'TESTING'|'DISTRIBUTING'|'INTEGRATING'|'AVAILABLE'|'CANCELLED'|'FAILED'|'DEPRECATED'|'DELETED'|'DISABLED',
                'reason': 'string',
                'failureContext': {
                    'imageStatus': 'PENDING'|'CREATING'|'BUILDING'|'TESTING'|'DISTRIBUTING'|'INTEGRATING'|'AVAILABLE'|'CANCELLED'|'FAILED'|'DEPRECATED'|'DELETED'|'DISABLED',
                    'workflowExecutionId': 'string',
                    'workflowArn': 'string',
                    'stepExecutionId': 'string',
                    'failedStep': 'string',
                    'componentFailure': {
                        'componentArn': 'string',
                        'phaseName': 'string',
                        'stepName': 'string',
                        'action': 'string',
                        'errorMessage': 'string'
                    },
                    'distributionFailure': {
                        'errorMessage': 'string',
                        'regionFailures': [
                            {
                                'region': 'string',
                                'status': 'FAILED'|'CANCELLED'|'TIMED_OUT',
                                'imageConfigurationStep': 'ASSOCIATE_LICENSES'|'UPDATE_LAUNCH_TEMPLATES'|'PUT_SSM_PARAMETERS'|'UPDATE_FAST_LAUNCH_CONFIGURATIONS'|'EXPORT_AMI',
                                'errorMessage': 'string',
                                'targetAccountId': 'string'
                            },
                        ]
                    }
                }
            },
            'owner': 'string',
            'dateCreated': 'string',
            'outputResources': {
                'amis': [
                    {
                        'region': 'string',
                        'image': 'string',
                        'name': 'string',
                        'description': 'string',
                        'state': {
                            'status': 'PENDING'|'CREATING'|'BUILDING'|'TESTING'|'DISTRIBUTING'|'INTEGRATING'|'AVAILABLE'|'CANCELLED'|'FAILED'|'DEPRECATED'|'DELETED'|'DISABLED',
                            'reason': 'string',
                            'failureContext': {
                                'imageStatus': 'PENDING'|'CREATING'|'BUILDING'|'TESTING'|'DISTRIBUTING'|'INTEGRATING'|'AVAILABLE'|'CANCELLED'|'FAILED'|'DEPRECATED'|'DELETED'|'DISABLED',
                                'workflowExecutionId': 'string',
                                'workflowArn': 'string',
                                'stepExecutionId': 'string',
                                'failedStep': 'string',
                                'componentFailure': {
                                    'componentArn': 'string',
                                    'phaseName': 'string',
                                    'stepName': 'string',
                                    'action': 'string',
                                    'errorMessage': 'string'
                                },
                                'distributionFailure': {
                                    'errorMessage': 'string',
                                    'regionFailures': [
                                        {
                                            'region': 'string',
                                            'status': 'FAILED'|'CANCELLED'|'TIMED_OUT',
                                            'imageConfigurationStep': 'ASSOCIATE_LICENSES'|'UPDATE_LAUNCH_TEMPLATES'|'PUT_SSM_PARAMETERS'|'UPDATE_FAST_LAUNCH_CONFIGURATIONS'|'EXPORT_AMI',
                                            'errorMessage': 'string',
                                            'targetAccountId': 'string'
                                        },
                                    ]
                                }
                            }
                        },
                        'accountId': 'string'
                    },
                ],
                'containers': [
                    {
                        'region': 'string',
                        'imageUris': [
                            'string',
                        ]
                    },
                ]
            },
            'tags': {
                'string': 'string'
            },
            'buildType': 'USER_INITIATED'|'SCHEDULED'|'IMPORT'|'IMPORT_ISO',
            'imageSource': 'AMAZON_MANAGED'|'AWS_MARKETPLACE'|'IMPORTED'|'CUSTOM',
            'deprecationTime': datetime(2015, 1, 1),
            'lifecycleExecutionId': 'string',
            'loggingConfiguration': {
                'logGroupName': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- requestId (string) –
  
  The request ID that uniquely identifies this request.
- imageSummaryList (list) –
  
  The list of images built by this pipeline.
  - (dict) –
    
    An image summary.
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the image.
    - name (string) –
      
      The name of the image.
    - type (string) –
      
      Specifies whether this image produces an AMI or a container image.
    - version (string) –
      
      The version of the image.
    - platform (string) –
      
      The image operating system platform, such as Linux or Windows.
    - osVersion (string) –
      
      The operating system version of the instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
    - state (dict) –
      
      The state of the image.
      - status (string) –
        
        The status of the image.
      - reason (string) –
        
        The reason for the status of the image.
      - failureContext (dict) –
        
        The details about the failure, for images that failed to complete. Image Builder only sets this property when the image status is FAILED.
        
        imageStatus (string) –
        
        The status that the image had when the failure occurred. This indicates the stage of the image creation process where the image failed, for example BUILDING or DISTRIBUTING.
        
        workflowExecutionId (string) –
        
        The unique identifier of the workflow execution that was running when the image failed.
        
        workflowArn (string) –
        
        The Amazon Resource Name (ARN) of the workflow build version that was running when the image failed.
        
        stepExecutionId (string) –
        
        The unique identifier of the workflow step execution that failed.
        
        failedStep (string) –
        
        The name of the workflow step that failed, as it appears in the workflow document.
        
        componentFailure (dict) –
        
        The details about the component that failed, if the failure occurred while a component was running.
        
        componentArn (string) –
        
        The Amazon Resource Name (ARN) of the component build version that failed.
        
        phaseName (string) –
        
        The name of the phase in the component document where the failure occurred, such as build, validate, or test.
        
        stepName (string) –
        
        The name of the step in the component document that failed.
        
        action (string) –
        
        The action that the failed step runs, for example ExecuteBash.
        
        errorMessage (string) –
        
        The error message from the step that failed. Image Builder truncates messages that are longer than 1024 characters. The component log in Amazon CloudWatch Logs contains the full output.
        
        distributionFailure (dict) –
        
        The details about the distribution failure, if the failure occurred while Image Builder distributed or configured the image.
        
        errorMessage (string) –
        
        The error message for the distribution failure.
        
        regionFailures (list) –
        
        The details about the failure for each Region where the image didn’t finish distribution or configuration.
        
        (dict) –
        
        Contains details about a distribution or image configuration failure for a single Region.
        
        region (string) –
        
        The Region where the failure occurred.
        
        status (string) –
        
        The failure status for the Region. Indicates whether the process failed, was canceled, or timed out.
        
        imageConfigurationStep (string) –
        
        The image configuration step where the failure occurred. Image Builder sets this property when the failure happened during post-distribution configuration, such as launch template updates or virtual machine (VM) export. This property doesn’t appear for failures that occurred while Image Builder copied the image to the Region.
        
        errorMessage (string) –
        
        The error message for the failure in the Region.
        
        targetAccountId (string) –
        
        The account ID of the account that the image was distributed to in the Region.
    - owner (string) –
      
      The owner of the image.
    - dateCreated (string) –
      
      The date on which Image Builder created this image.
    - outputResources (dict) –
      
      The output resources that Image Builder produced when it created this image.
      - amis (list) –
        
        The Amazon EC2 AMIs created by this image.
        
        (dict) –
        
        Details of an Amazon EC2 AMI.
        
        region (string) –
        
        The Amazon Web Services Region of the Amazon EC2 AMI.
        
        image (string) –
        
        The AMI ID of the Amazon EC2 AMI.
        
        name (string) –
        
        The name of the Amazon EC2 AMI.
        
        description (string) –
        
        The description of the Amazon EC2 AMI. Minimum and maximum length are in characters.
        
        state (dict) –
        
        Image status and the reason for that status.
        
        status (string) –
        
        The status of the image.
        
        reason (string) –
        
        The reason for the status of the image.
        
        failureContext (dict) –
        
        The details about the failure, for images that failed to complete. Image Builder only sets this property when the image status is FAILED.
        
        imageStatus (string) –
        
        The status that the image had when the failure occurred. This indicates the stage of the image creation process where the image failed, for example BUILDING or DISTRIBUTING.
        
        workflowExecutionId (string) –
        
        The unique identifier of the workflow execution that was running when the image failed.
        
        workflowArn (string) –
        
        The Amazon Resource Name (ARN) of the workflow build version that was running when the image failed.
        
        stepExecutionId (string) –
        
        The unique identifier of the workflow step execution that failed.
        
        failedStep (string) –
        
        The name of the workflow step that failed, as it appears in the workflow document.
        
        componentFailure (dict) –
        
        The details about the component that failed, if the failure occurred while a component was running.
        
        componentArn (string) –
        
        The Amazon Resource Name (ARN) of the component build version that failed.
        
        phaseName (string) –
        
        The name of the phase in the component document where the failure occurred, such as build, validate, or test.
        
        stepName (string) –
        
        The name of the step in the component document that failed.
        
        action (string) –
        
        The action that the failed step runs, for example ExecuteBash.
        
        errorMessage (string) –
        
        The error message from the step that failed. Image Builder truncates messages that are longer than 1024 characters. The component log in Amazon CloudWatch Logs contains the full output.
        
        distributionFailure (dict) –
        
        The details about the distribution failure, if the failure occurred while Image Builder distributed or configured the image.
        
        errorMessage (string) –
        
        The error message for the distribution failure.
        
        regionFailures (list) –
        
        The details about the failure for each Region where the image didn’t finish distribution or configuration.
        
        (dict) –
        
        Contains details about a distribution or image configuration failure for a single Region.
        
        region (string) –
        
        The Region where the failure occurred.
        
        status (string) –
        
        The failure status for the Region. Indicates whether the process failed, was canceled, or timed out.
        
        imageConfigurationStep (string) –
        
        The image configuration step where the failure occurred. Image Builder sets this property when the failure happened during post-distribution configuration, such as launch template updates or virtual machine (VM) export. This property doesn’t appear for failures that occurred while Image Builder copied the image to the Region.
        
        errorMessage (string) –
        
        The error message for the failure in the Region.
        
        targetAccountId (string) –
        
        The account ID of the account that the image was distributed to in the Region.
        
        accountId (string) –
        
        The account ID of the owner of the AMI.
      - containers (list) –
        
        Container images that the pipeline has generated and stored in the output repository.
        
        (dict) –
        
        A container encapsulates the runtime environment for an application.
        
        region (string) –
        
        Containers and container images are Region-specific. This is the Region context for the container.
        
        imageUris (list) –
        
        A list of URIs for containers created in the context Region.
        
        (string) –
    - tags (dict) –
      
      The tags that apply to this image.
      - (string) –
        
        (string) –
    - 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.
    - deprecationTime (datetime) –
      
      The time when deprecation occurs for an image resource. This can be a past or future date.
    - lifecycleExecutionId (string) –
      
      Identifies the last runtime instance of the lifecycle policy to take action on the image.
    - loggingConfiguration (dict) –
      
      The logging configuration that’s defined for the image.
      - logGroupName (string) –
        
        The log group name that Image Builder uses for image creation. If not specified, the log group name defaults to /aws/imagebuilder/image-name.
- NextToken (string) –
  
  A token to resume pagination.