Amazon EC2 Image Builder ListImagePipelineImages API

openapi: 3.1.0
info:
  title: EC2 Image Builder Listimagepipelineimages API
  version: '2019-12-02'
  description: Generated from AWS's published Smithy model for EC2 Image Builder. 1 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://imagebuilder.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /ListImagePipelineImages:
    post:
      operationId: ListImagePipelineImages
      summary: List Image Pipeline Images
      description: Returns a list of images created by the specified pipeline.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListImagePipelineImagesResponse'
              example:
                requestId: 071a0ecb-b07d-4485-832c-e6b88de8ebed
                imageSummaryList:
                - arn: arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1
                  name: my-example-recipe
                  type: AMI
                  version: 1.0.0/1
                  platform: Linux
                  state:
                    status: BUILDING
                  owner: '111122223333'
                  dateCreated: '2026-09-09T19:39:20.458Z'
                  outputResources:
                    amis: []
                  buildType: USER_INITIATED
        '429':
          description: CallRateLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallRateLimitExceededException'
        '400':
          description: ClientException; InvalidPaginationTokenException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '500':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListImagePipelineImagesRequest'
            example:
              imagePipelineArn: arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline
      tags:
      - Listimagepipelineimages
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: imagebuilder
  schemas:
    Ami:
      type: object
      properties:
        region:
          type: string
          description: The Amazon Web Services Region of the Amazon EC2 AMI.
        image:
          type: string
          description: The AMI ID of the Amazon EC2 AMI.
        name:
          type: string
          description: The name of the Amazon EC2 AMI.
        description:
          type: string
          description: The description of the Amazon EC2 AMI. Minimum and maximum length are in characters.
        state:
          $ref: '#/components/schemas/ImageState'
        accountId:
          type: string
          description: The account ID of the owner of the AMI.
    CallRateLimitExceededException:
      type: object
      properties:
        message:
          type: string
    ClientException:
      type: object
      properties:
        message:
          type: string
    ComponentFailureContext:
      type: object
      properties:
        componentArn:
          type: string
          description: The Amazon Resource Name (ARN) of the component build version that failed.
        phaseName:
          type: string
          description: The name of the phase in the component document where the failure occurred, such as build, validate,
            or test.
        stepName:
          type: string
          description: The name of the step in the component document that failed.
        action:
          type: string
          description: The action that the failed step runs, for example ExecuteBash.
        errorMessage:
          type: string
          description: 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.
    Container:
      type: object
      properties:
        region:
          type: string
          description: Containers and container images are Region-specific. This is the Region context for the container.
        imageUris:
          type: array
          items:
            type: string
          description: A list of URIs for containers created in the context Region.
    DistributionFailureContext:
      type: object
      properties:
        errorMessage:
          type: string
          description: The error message for the distribution failure.
        regionFailures:
          type: array
          items:
            $ref: '#/components/schemas/RegionFailure'
          description: The details about the failure for each Region where the image didn't finish distribution or configuration.
    Filter:
      type: object
      properties:
        name:
          type: string
          description: The name of the filter. Filter names are case-sensitive.
        values:
          type: array
          items:
            type: string
          description: 'The filter values. Filter values are case-sensitive. The name filter can use a wildcard: web* matches
            names that begin with web, and *web* matches names that contain web. The wildcard isn''t supported in other positions
            or in other filters.'
    ForbiddenException:
      type: object
      properties:
        message:
          type: string
    ImageFailureContext:
      type: object
      properties:
        imageStatus:
          type: string
          enum:
          - PENDING
          - CREATING
          - BUILDING
          - TESTING
          - DISTRIBUTING
          - INTEGRATING
          - AVAILABLE
          - CANCELLED
          - FAILED
          - DEPRECATED
          - DELETED
          - DISABLED
          description: 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:
          type: string
          description: The unique identifier of the workflow execution that was running when the image failed.
        workflowArn:
          type: string
          description: The Amazon Resource Name (ARN) of the workflow build version that was running when the image failed.
        stepExecutionId:
          type: string
          description: The unique identifier of the workflow step execution that failed.
        failedStep:
          type: string
          description: The name of the workflow step that failed, as it appears in the workflow document.
        componentFailure:
          $ref: '#/components/schemas/ComponentFailureContext'
        distributionFailure:
          $ref: '#/components/schemas/DistributionFailureContext'
    ImageLoggingConfiguration:
      type: object
      properties:
        logGroupName:
          type: string
          description: The log group name that Image Builder uses for image creation. If not specified, the log group name
            defaults to /aws/imagebuilder/image-name.
    ImageState:
      type: object
      properties:
        status:
          type: string
          enum:
          - PENDING
          - CREATING
          - BUILDING
          - TESTING
          - DISTRIBUTING
          - INTEGRATING
          - AVAILABLE
          - CANCELLED
          - FAILED
          - DEPRECATED
          - DELETED
          - DISABLED
          description: The status of the image. A new image moves through build, test, and distribution statuses during creation,
            and ends in the AVAILABLE, FAILED, or CANCELLED state. The DEPRECATED, DISABLED, and DELETED statuses come from
            later resource management actions.
        reason:
          type: string
          description: The reason for the status of the image.
        failureContext:
          $ref: '#/components/schemas/ImageFailureContext'
    ImageSummary:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the image.
        name:
          type: string
          description: The name of the image.
        type:
          type: string
          enum:
          - AMI
          - DOCKER
          description: Specifies whether this image produces an AMI or a container image.
        version:
          type: string
          description: The version of the image.
        platform:
          type: string
          enum:
          - Windows
          - Linux
          - macOS
          description: The image operating system platform, such as Linux or Windows.
        osVersion:
          type: string
          description: 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:
          $ref: '#/components/schemas/ImageState'
        owner:
          type: string
          description: The owner of the image.
        dateCreated:
          type: string
          description: The date on which Image Builder created this image.
        outputResources:
          $ref: '#/components/schemas/OutputResources'
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags that apply to this image.
        buildType:
          type: string
          enum:
          - USER_INITIATED
          - SCHEDULED
          - IMPORT
          - IMPORT_ISO
          description: '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:
          type: string
          enum:
          - AMAZON_MANAGED
          - AWS_MARKETPLACE
          - IMPORTED
          - CUSTOM
          description: The origin of the base image that Image Builder used to build this image.
        deprecationTime:
          type: string
          format: date-time
          description: The time when deprecation occurs for an image resource. This can be a past or future date.
        lifecycleExecutionId:
          type: string
          description: Identifies the last runtime instance of the lifecycle policy to take action on the image.
        loggingConfiguration:
          $ref: '#/components/schemas/ImageLoggingConfiguration'
    ListImagePipelineImagesRequest:
      type: object
      properties:
        imagePipelineArn:
          type: string
          description: The Amazon Resource Name (ARN) of the image pipeline whose images you want to view.
        filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: 'Use the following filters to streamline results: name version'
        maxResults:
          type: integer
          description: The maximum number of items to return in a single request. If you don't specify a value, Image Builder
            returns up to 25 items. The largest page size that you can request is 100 items. A page can contain fewer items
            than the maximum, with a nextToken to continue paging.
        nextToken:
          type: string
          description: A token to specify where to start paginating. Use the nextToken value from a previously truncated response.
      required:
      - imagePipelineArn
    ListImagePipelineImagesResponse:
      type: object
      properties:
        requestId:
          type: string
          description: The request ID that uniquely identifies this request.
        imageSummaryList:
          type: array
          items:
            $ref: '#/components/schemas/ImageSummary'
          description: The list of images built by this pipeline.
        nextToken:
          type: string
          description: The next token used for paginated responses. When this field isn't empty, there are additional elements
            that the service hasn't included in this request. Use this token with the next request to retrieve additional
            objects.
    OutputResources:
      type: object
      properties:
        amis:
          type: array
          items:
            $ref: '#/components/schemas/Ami'
          description: The Amazon EC2 AMIs created by this image. The list contains one entry per AMI, including copies that
            distribution created in each target Amazon Web Services Region and account.
        containers:
          type: array
          items:
            $ref: '#/components/schemas/Container'
          description: The container images that Image Builder created when it built this image, stored in the output Amazon
            ECR repository.
    RegionFailure:
      type: object
      properties:
        region:
          type: string
          description: The Region where the failure occurred.
        status:
          type: string
          enum:
          - FAILED
          - CANCELLED
          - TIMED_OUT
          description: The failure status for the Region. Indicates whether the process failed, was canceled, or timed out.
        imageConfigurationStep:
          type: string
          enum:
          - ASSOCIATE_LICENSES
          - UPDATE_LAUNCH_TEMPLATES
          - PUT_SSM_PARAMETERS
          - UPDATE_FAST_LAUNCH_CONFIGURATIONS
          - EXPORT_AMI
          description: 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:
          type: string
          description: The error message for the failure in the Region.
        targetAccountId:
          type: string
          description: The account ID of the account that the image was distributed to in the Region.
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    ServiceException:
      type: object
      properties:
        message:
          type: string
    ServiceUnavailableException:
      type: object
      properties:
        message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/imagebuilder/service/2019-12-02/imagebuilder-2019-12-02.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)