Amazon EC2 Image Builder Get Image Pipeline API

openapi: 3.1.0
info:
  title: EC2 Image Builder Getimagepipeline 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:
  /GetImagePipeline:
    get:
      operationId: GetImagePipeline
      summary: Get Image Pipeline
      description: Retrieves an image pipeline.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetImagePipelineResponse'
              example:
                requestId: b7e58d62-36dc-43a5-87ff-546e04cdabf1
                imagePipeline:
                  arn: arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline
                  name: my-example-pipeline
                  description: Builds an Amazon Linux 2023 image every Sunday
                  platform: Linux
                  enhancedImageMetadataEnabled: true
                  imageRecipeArn: arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0
                  infrastructureConfigurationArn: arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure
                  imageTestsConfiguration:
                    imageTestsEnabled: true
                    timeoutMinutes: 720
                  schedule:
                    scheduleExpression: cron(0 0 ? * SUN *)
                    pipelineExecutionStartCondition: EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
                  status: ENABLED
                  dateCreated: '2026-09-09T19:38:26.574Z'
                  dateUpdated: '2026-09-09T19:38:26.574Z'
        '429':
          description: CallRateLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallRateLimitExceededException'
        '400':
          description: ClientException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '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/GetImagePipelineRequest'
            example:
              imagePipelineArn: arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline
      tags:
      - Getimagepipeline
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:
    AutoDisablePolicy:
      type: object
      properties:
        failureCount:
          type: integer
          description: The number of consecutive scheduled image pipeline executions that must fail before Image Builder automatically
            disables the pipeline.
      required:
      - failureCount
    CallRateLimitExceededException:
      type: object
      properties:
        message:
          type: string
    ClientException:
      type: object
      properties:
        message:
          type: string
    EcrConfiguration:
      type: object
      properties:
        repositoryName:
          type: string
          description: The name of the container repository where Image Builder pushes the container image for the vulnerability
            scan. Provide the repository name only (a namespace path is allowed, but not the registry hostname); the repository
            must already exist in your account. If you don't specify a repository name, Image Builder creates the default
            repository image-builder-image-scanning-repository in your account.
        containerTags:
          type: array
          items:
            type: string
          description: Tags for Image Builder to apply to the output container image that Amazon Inspector scans. Tags can
            help you identify and manage your scanned images.
    ForbiddenException:
      type: object
      properties:
        message:
          type: string
    GetImagePipelineRequest:
      type: object
      properties:
        imagePipelineArn:
          type: string
          description: The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve.
      required:
      - imagePipelineArn
    GetImagePipelineResponse:
      type: object
      properties:
        requestId:
          type: string
          description: The request ID that uniquely identifies this request.
        imagePipeline:
          $ref: '#/components/schemas/ImagePipeline'
    ImagePipeline:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the image pipeline.
        name:
          type: string
          description: The name of the image pipeline.
        description:
          type: string
          description: The description of the image pipeline.
        platform:
          type: string
          enum:
          - Windows
          - Linux
          - macOS
          description: The platform of the image pipeline, inherited from the recipe that the pipeline uses.
        enhancedImageMetadataEnabled:
          type: boolean
          description: Specifies whether to collect additional information about the image being created, including the operating
            system (OS) version and package list. Defaults to true.
        imageRecipeArn:
          type: string
          description: The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
        containerRecipeArn:
          type: string
          description: The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
        infrastructureConfigurationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
        distributionConfigurationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
        imageTestsConfiguration:
          $ref: '#/components/schemas/ImageTestsConfiguration'
        schedule:
          $ref: '#/components/schemas/Schedule'
        status:
          type: string
          enum:
          - DISABLED
          - ENABLED
          description: The status of the image pipeline. A disabled pipeline doesn't run on its schedule, but you can still
            start builds manually. Image Builder can also disable a pipeline automatically when consecutive scheduled builds
            fail.
        dateCreated:
          type: string
          description: The date on which this image pipeline was created.
        dateUpdated:
          type: string
          description: The date on which this image pipeline was last updated.
        dateLastRun:
          type: string
          description: The date on which this image pipeline was last run.
        lastRunStatus:
          type: string
          enum:
          - PENDING
          - CREATING
          - BUILDING
          - TESTING
          - DISTRIBUTING
          - INTEGRATING
          - AVAILABLE
          - CANCELLED
          - FAILED
          - DEPRECATED
          - DELETED
          - DISABLED
          description: The status of the last image that this pipeline built, such as BUILDING, TESTING, FAILED, or AVAILABLE.
        dateNextRun:
          type: string
          description: The next date when the pipeline is scheduled to run.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags of this image pipeline.
        imageScanningConfiguration:
          $ref: '#/components/schemas/ImageScanningConfiguration'
        imageTags:
          type: object
          additionalProperties:
            type: string
          description: The tags that Image Builder applies to the Image Builder image resource that this pipeline's scheduled
            executions create. These tags don't apply to the output AMI. Builds that you start manually use the tags from
            the StartImagePipelineExecution request instead.
        executionRole:
          type: string
          description: The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access
            to perform workflow actions.
        workflows:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowConfiguration'
          description: Contains the workflows that run for the image pipeline.
        loggingConfiguration:
          $ref: '#/components/schemas/PipelineLoggingConfiguration'
        consecutiveFailures:
          type: integer
          description: 'Image Builder tracks the number of consecutive failures for scheduled pipeline executions and takes
            one of the following actions each time it runs on a schedule: If the pipeline execution is successful, the number
            of consecutive failures resets to zero. If the pipeline execution fails, Image Builder increments the number of
            consecutive failures. If the failure count reaches the limit defined in the AutoDisablePolicy, Image Builder disables
            the pipeline. The consecutive failure count is also reset to zero under the following conditions: The pipeline
            runs manually and succeeds. The pipeline conf'
    ImageScanningConfiguration:
      type: object
      properties:
        imageScanningEnabled:
          type: boolean
          description: Specifies whether Amazon Inspector scans for vulnerabilities when you create a new image. You must
            also enable image tests. For AMI output, imageScanningTypes sets whether Amazon Inspector scans the test instance
            or the output AMI. For container output, Amazon Inspector scans the container image that Image Builder pushes
            to the Amazon ECR repository from your ecrConfiguration settings. To use container image scans, you must activate
            Amazon Inspector for Amazon ECR scanning in your account. The Image Builder ListImageScanFindings operation returns
            the findings of these scans.
        ecrConfiguration:
          $ref: '#/components/schemas/EcrConfiguration'
        imageScanningTypes:
          type: array
          items:
            type: string
            enum:
            - TEST_INSTANCE_CVE
            - ON_DEMAND_AMI_CVE
          description: 'The type of vulnerability scan that Image Builder runs for AMI output when imageScanningEnabled is
            true. Specify a single value. If you omit imageScanningTypes, Image Builder uses TEST_INSTANCE_CVE. The scan types
            work as follows: With TEST_INSTANCE_CVE, Amazon Inspector scans the test instance during image tests. To use this
            scan, you must activate Amazon Inspector for Amazon EC2 scanning in your account. The Image Builder ListImageScanFindings
            operation returns the findings. With ON_DEMAND_AMI_CVE, Amazon Inspector starts an on-demand scan of the output
            AMI during image tests. To use this sc'
        scanResultCondition:
          $ref: '#/components/schemas/ScanResultCondition'
    ImageTestsConfiguration:
      type: object
      properties:
        imageTestsEnabled:
          type: boolean
          description: Specifies whether tests run after building the image. When enabled, tests run after the image build
            and before image distribution. Defaults to true.
        timeoutMinutes:
          type: integer
          description: The maximum time in minutes that tests are permitted to run. If you don't specify a value, Image Builder
            stores and returns 720. The timeout property is not currently active. This value is ignored.
    PipelineLoggingConfiguration:
      type: object
      properties:
        imageLogGroupName:
          type: string
          description: Specifies the CloudWatch Logs log group name for image build logs. The log group name can contain alphanumeric
            characters, hyphens, underscores, forward slashes, and periods, up to 512 characters. Log group names not starting
            with /aws/imagebuilder/ require an executionRole with CloudWatch Logs write permissions. If not specified, defaults
            to /aws/imagebuilder/image-name.
        pipelineLogGroupName:
          type: string
          description: Specifies the CloudWatch Logs log group name for pipeline execution logs. The log group name can contain
            alphanumeric characters, hyphens, underscores, forward slashes, and periods, up to 512 characters. Log group names
            not starting with /aws/imagebuilder/ require an executionRole with CloudWatch Logs write permissions. If not specified,
            defaults to /aws/imagebuilder/pipeline/pipeline-name.
    ScanResultCondition:
      type: object
      properties:
        maximumSeverityLabel:
          type: string
          enum:
          - INFORMATIONAL
          - LOW
          - MEDIUM
          - HIGH
          description: The maximum severity allowed for findings on the output AMI. A finding above this severity fails the
            image, unless fixAvailable excludes it. Valid values are INFORMATIONAL, LOW, MEDIUM, and HIGH. A CRITICAL finding
            that counts always fails the image.
        fixAvailable:
          type: boolean
          description: Specifies whether only findings that have a fix available count toward maximumSeverityLabel. When false,
            Image Builder counts every finding. The default is true.
      required:
      - maximumSeverityLabel
    Schedule:
      type: object
      properties:
        scheduleExpression:
          type: string
          description: The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.
            You can specify a cron expression, or a rate expression such as rate(1 day). For information on how to format
            a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.
        timezone:
          type: string
          description: The timezone that applies to the scheduling expression. Specify a value in IANA timezone format, for
            example Etc/UTC or America/Los_Angeles. If not specified, this defaults to UTC.
        pipelineExecutionStartCondition:
          type: string
          enum:
          - EXPRESSION_MATCH_ONLY
          - EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
          description: The start condition configures when the pipeline should trigger a new image build, as follows. If no
            value is set Image Builder defaults to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE. EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
            (default) – When you use semantic version filters on the base image or components in your image recipe, EC2 Image
            Builder builds a new image only when there are new versions of the base image or components in your recipe that
            match the filter. For semantic version syntax, see CreateComponent. EXPRESSION_MATCH_ONLY – This condition builds
            a new image every t
        autoDisablePolicy:
          $ref: '#/components/schemas/AutoDisablePolicy'
    ServiceException:
      type: object
      properties:
        message:
          type: string
    ServiceUnavailableException:
      type: object
      properties:
        message:
          type: string
    WorkflowConfiguration:
      type: object
      properties:
        workflowArn:
          type: string
          description: The Amazon Resource Name (ARN) of the workflow resource.
        parameters:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowParameter'
          description: Contains parameter values for each of the parameters that the workflow document defined for the workflow
            resource.
        parallelGroup:
          type: string
          description: Test workflows are defined within named runtime groups called parallel groups. The parallel group is
            the named group that contains this test workflow. Test workflows within a parallel group can run at the same time.
            Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows
            as others complete, until all workflows in the group have completed. This field only applies for test workflows.
        onFailure:
          type: string
          enum:
          - CONTINUE
          - ABORT
          description: The action to take if the workflow fails. With CONTINUE, a failed workflow is logged and image creation
            proceeds to the next workflow. If you don't set a value, the image build fails when the workflow fails. You can
            only set this property for test workflows.
      required:
      - workflowArn
    WorkflowParameter:
      type: object
      properties:
        name:
          type: string
          description: The name of the workflow parameter to set.
        value:
          type: array
          items:
            type: string
          description: Sets the value for the named workflow parameter.
      required:
      - name
      - value
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)