DescribeComponent - Amazon IoT Greengrass
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Retrieves metadata for a version of a component.

Request Syntax

GET /greengrass/v2/components/arn/metadata HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The ARN of the component version.

Pattern: arn:[^:]*:greengrass:[^:]*:(aws|[0-9]+):components:[^:]+:versions:[^:]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "arn": "string", "componentName": "string", "componentVersion": "string", "creationTimestamp": number, "description": "string", "platforms": [ { "attributes": { "string" : "string" }, "name": "string" } ], "publisher": "string", "status": { "componentState": "string", "errors": { "string" : "string" }, "message": "string", "vendorGuidance": "string", "vendorGuidanceMessage": "string" }, "tags": { "string" : "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The ARN of the component version.

Type: String

Pattern: arn:[^:]*:greengrass:[^:]*:(aws|[0-9]+):components:[^:]+:versions:[^:]+


The name of the component.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.


The version of the component.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.


The time at which the component was created, expressed in ISO 8601 format.

Type: Timestamp


The description of the component version.

Type: String


The platforms that the component version supports.

Type: Array of ComponentPlatform objects


The publisher of the component version.

Type: String


The status of the component version in Amazon IoT Greengrass V2. This status is different from the status of the component on a core device.

Type: CloudComponentStatus object


A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the Amazon IoT Greengrass V2 Developer Guide.

Type: String to string map

Map Entries: Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.


For information about the errors that are common to all actions, see Common Errors.


You don't have permission to perform the action.

HTTP Status Code: 403


Amazon IoT Greengrass can't process your request right now. Try again later.

HTTP Status Code: 500


The requested resource can't be found.

HTTP Status Code: 404


Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

HTTP Status Code: 429


The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: