---
title: "GET /GetComponent#componentBuildVersionArn"
method: GET
path: "/GetComponent#componentBuildVersionArn"
---

# GET /GetComponent#componentBuildVersionArn

`GET /GetComponent#componentBuildVersionArn`

Gets a component object.

## Query parameters

- `componentBuildVersionArn` string, required

## Response `200`

Success

- GetComponentResponse
  - `requestId` string — The request ID that uniquely identifies this request.
  - `component` object — The component object associated with the specified ARN.
    - `arn` string — The Amazon Resource Name (ARN) of the component.
    - `name` string — The name of the component.
    - `version` string — The version of the component.
    - `description` string — The description of the component.
    - `changeDescription` string — The change description of the component.
    - `type` 'BUILD' | 'TEST' — The component type specifies whether Image Builder uses the component to build the image or only to test it.
    - `platform` 'Windows' | 'Linux' — The operating system platform of the component.
    - `supportedOsVersions` OsVersion[] — 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` object — Describes the current status of the component. This is used for components that are no longer active.
      - `status` 'DEPRECATED' — The current state of the component.
      - `reason` string — Describes how or why the component changed state.
    - `parameters` ComponentParameterDetail[] — Contains parameter details for each of the parameters that the component document defined for the component.
      - `name` string, required — The name of this input parameter.
      - `type` string, required — The type of input this parameter provides. The currently supported value is "string".
      - `defaultValue` ComponentParameterValue[] — The default value of this parameter if no input is provided.
      - `description` string — Describes this parameter.
    - `owner` string — The owner of the component.
    - `data` string — Component data contains the YAML document content for the component.
    - `kmsKeyId` string — The KMS key identifier used to encrypt the component.
    - `encrypted` boolean — The encryption status of the component.
    - `dateCreated` string — The date that Image Builder created the component.
    - `tags` object — The tags that apply to the component.
    - `publisher` string — Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.
    - `obfuscate` boolean — Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.

## Other responses

- `480` — ServiceException
- `481` — ClientException
- `482` — ServiceUnavailableException
- `483` — InvalidRequestException
- `484` — ForbiddenException
- `485` — CallRateLimitExceededException

---

[API](https://skmtc.net/aws/apis/imagebuilder.md) · [All operations](https://skmtc.net/aws/apis/imagebuilder/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/imagebuilder/versions/cfe68d8f8262/schema)