Amazon EC2 Image Builder Get Component API

openapi: 3.1.0
info:
  title: EC2 Image Builder Get Component 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:
  /GetComponent:
    get:
      operationId: GetComponent
      summary: Get Component
      description: Retrieves a component object.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetComponentResponse'
              example:
                requestId: f5401098-035f-4be2-9eee-784c388ed04b
                component:
                  arn: arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0/1
                  name: my-example-component
                  version: 1.0.0
                  description: Installs the latest version of my application
                  changeDescription: Initial version
                  type: BUILD
                  platform: Linux
                  state:
                    status: ACTIVE
                  owner: '111122223333'
                  data: "name: InstallMyApp\ndescription: Installs my application\nschemaVersion: 1.0\nphases:\n  - name:\
                    \ build\n    steps:\n      - name: InstallApp\n        action: ExecuteBash\n        inputs:\n        \
                    \  commands:\n            - sudo yum -y install my-app\n"
                  encrypted: true
                  dateCreated: '2026-09-09T18:31:30.404Z'
                latestVersionReferences:
                  latestVersionArn: arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/x.x.x
                  latestMajorVersionArn: arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.x.x
                  latestMinorVersionArn: arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.x
                  latestPatchVersionArn: arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0
        '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/GetComponentRequest'
            example:
              componentBuildVersionArn: arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0/1
      tags:
      - Get Component
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
    Component:
      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.
        description:
          type: string
          description: The description of the component.
        changeDescription:
          type: string
          description: Describes what change has been made in this version of the component, or what makes this version different
            from other versions of the component.
        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.
        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 supported by the component. 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'
        parameters:
          type: array
          items:
            $ref: '#/components/schemas/ComponentParameterDetail'
          description: Contains parameter details for each of the parameters that the component document defined for the component.
        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.
        data:
          type: string
          description: Component data contains the YAML document content for the component.
        kmsKeyId:
          type: string
          description: The KMS key identifier used to encrypt the component. This can be either the Key ARN or the Alias ARN.
            For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.
        encrypted:
          type: boolean
          description: Indicates whether the component data is encrypted at rest. Image Builder encrypts all component data
            at rest, so this value is always true. This field is retained for backward compatibility.
        dateCreated:
          type: string
          description: The date that Image Builder created 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.
        productCodes:
          type: array
          items:
            $ref: '#/components/schemas/ProductCodeListItem'
          description: Contains product codes that are used for billing purposes for Amazon Web Services Marketplace components.
    ComponentParameterDetail:
      type: object
      properties:
        name:
          type: string
          description: The name of this input parameter.
        type:
          type: string
          description: The type of input this parameter provides. The currently supported value is "string".
        defaultValue:
          type: array
          items:
            type: string
          description: The default value of this parameter if no input is provided.
        description:
          type: string
          description: Describes this parameter.
      required:
      - name
      - type
    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.
    ForbiddenException:
      type: object
      properties:
        message:
          type: string
    GetComponentRequest:
      type: object
      properties:
        componentBuildVersionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the component that you want to get. You can specify a build version
            ARN, or a component version ARN. The version can use the x wildcard in trailing positions, for example 1.0.x or
            1.x.x. Version ARNs resolve to the latest available matching component build version.
      required:
      - componentBuildVersionArn
    GetComponentResponse:
      type: object
      properties:
        requestId:
          type: string
          description: The request ID that uniquely identifies this request.
        component:
          $ref: '#/components/schemas/Component'
        latestVersionReferences:
          $ref: '#/components/schemas/LatestVersionReferences'
    LatestVersionReferences:
      type: object
      properties:
        latestVersionArn:
          type: string
          description: The latest version Amazon Resource Name (ARN) of the Image Builder resource.
        latestMajorVersionArn:
          type: string
          description: The latest version Amazon Resource Name (ARN) with the same major version of the Image Builder resource.
        latestMinorVersionArn:
          type: string
          description: The latest version Amazon Resource Name (ARN) with the same minor version of the Image Builder resource.
        latestPatchVersionArn:
          type: string
          description: The latest version Amazon Resource Name (ARN) with the same patch version of the Image Builder resource.
    ProductCodeListItem:
      type: object
      properties:
        productCodeId:
          type: string
          description: For Amazon Web Services Marketplace components, this contains the product code ID that can be stamped
            onto an EC2 AMI to ensure that components are billed correctly. If this property is empty, it might mean that
            the component is not published.
        productCodeType:
          type: string
          enum:
          - marketplace
          description: The owner of the product code that's billed. If this property is empty, it might mean that the component
            is not published.
      required:
      - productCodeId
      - productCodeType
    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)