DescribeComponent - AWS IoT Greengrass

DescribeComponent

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.

arn

The ARN of the component version.

Pattern: arn:aws(-cn|-us-gov)?: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" }, "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.

arn

The ARN of the component version.

Type: String

Pattern: arn:aws(-cn|-us-gov)?:greengrass:[^:]+:(aws|[0-9]+):components:[^:]+:versions:[^:]+

componentName

The name of the component.

Type: String

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

Pattern: [a-zA-Z0-9-_.]+

componentVersion

The version of the component.

Type: String

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

Pattern: [0-9a-zA-Z-.+]+

creationTimestamp

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

Type: Timestamp

description

The description of the component version.

Type: String

platforms

The platforms that the component version supports.

Type: Array of ComponentPlatform objects

publisher

The publisher of the component version.

Type: String

status

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

Type: CloudComponentStatus object

tags

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

Type: String to string map

Map Entries: Maximum number of 50 items.

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

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Errors

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

AccessDeniedException

You don't have permission to perform the action.

HTTP Status Code: 403

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

The requested resource can't be found.

HTTP Status Code: 404

ThrottlingException

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

ValidationException

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 AWS SDKs, see the following: