Amazon EC2 Image Builder ListComponentBuildVersions API

openapi: 3.1.0
info:
  title: EC2 Image Builder Listcomponentbuildversions 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:
  /ListComponentBuildVersions:
    post:
      operationId: ListComponentBuildVersions
      summary: List Component Build Versions
      description: Returns a list of component build versions for the specified component version ARN. You can only list build
        versions for components that your account owns. Deprecated build versions aren't included in the results.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListComponentBuildVersionsResponse'
              example:
                componentSummaryList:
                - arn: arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0/2
                  name: my-example-component
                  version: 1.0.0
                  platform: Linux
                  supportedOsVersions:
                  - Amazon Linux 2023
                  state:
                    status: ACTIVE
                  type: BUILD
                  owner: '111122223333'
                  description: Installs the latest version of my application
                  changeDescription: Updated the install command to use dnf
                  dateCreated: '2026-09-09T18:35:23.098Z'
                  tags:
                    Environment: Production
                - arn: arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0/1
                  name: my-example-component
                  version: 1.0.0
                  platform: Linux
                  supportedOsVersions:
                  - Amazon Linux 2023
                  state:
                    status: ACTIVE
                  type: BUILD
                  owner: '111122223333'
                  description: Installs the latest version of my application
                  changeDescription: Initial version
                  dateCreated: '2026-09-09T18:35:20.731Z'
                  tags:
                    Environment: Production
                requestId: 1d8693f0-26e1-42d7-ba35-d95ace1ce7e0
        '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'
        '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/ListComponentBuildVersionsRequest'
            example:
              componentVersionArn: arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0
      tags:
      - Listcomponentbuildversions
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:
    CallRateLimitExceededException:
      type: object
      properties:
        message:
          type: string
    ClientException:
      type: object
      properties:
        message:
          type: string
    ComponentState:
      type: object
      properties:
        status:
          type: string
          enum:
          - DEPRECATED
          - DISABLED
          - ACTIVE
          description: The current state of the component. Components with a status of DEPRECATED or DISABLED can't be added
            to new recipes.
        reason:
          type: string
          description: Describes how or why the component changed state.
    ComponentSummary:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the component.
        name:
          type: string
          description: The name of the component.
        version:
          type: string
          description: The version of the component.
        platform:
          type: string
          enum:
          - Windows
          - Linux
          - macOS
          description: The operating system platform of the component.
        supportedOsVersions:
          type: array
          items:
            type: string
          description: The operating system (OS) version that the component supports. If the OS information is available,
            Image Builder performs a prefix match against the base image OS version during image recipe creation.
        state:
          $ref: '#/components/schemas/ComponentState'
        type:
          type: string
          enum:
          - BUILD
          - TEST
          description: The component type specifies whether Image Builder uses the component to build the image or only to
            test it.
        owner:
          type: string
          description: The owner of the component. The value is your account ID for components that you own, the sharing account's
            ID for shared components, or Amazon, ThirdParty, or AWSMarketplace.
        description:
          type: string
          description: The description of the component.
        changeDescription:
          type: string
          description: The change description for this version of the component.
        dateCreated:
          type: string
          description: The date that Image Builder created this version of the component.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags that apply to the component.
        publisher:
          type: string
          description: Contains the name of the publisher if this is a third-party component. Otherwise, this property is
            empty.
        obfuscate:
          type: boolean
          description: Indicates whether component source is hidden from view in the console, and from component detail results
            for API, CLI, or SDK operations.
    ForbiddenException:
      type: object
      properties:
        message:
          type: string
    ListComponentBuildVersionsRequest:
      type: object
      properties:
        componentVersionArn:
          type: string
          description: The component version ARN whose build versions you want to list. The ARN must specify an exact version,
            without a build number suffix. If you don't specify an ARN, Image Builder returns build versions for the components
            that your account owns.
        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.
    ListComponentBuildVersionsResponse:
      type: object
      properties:
        requestId:
          type: string
          description: The request ID that uniquely identifies this request.
        componentSummaryList:
          type: array
          items:
            $ref: '#/components/schemas/ComponentSummary'
          description: The list of component summaries. Each summary represents one build version of the specified component
            version, or of the components that your account owns if you didn't specify an ARN. Deprecated build versions aren't
            included.
        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.
    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)