Menu
AWS Greengrass
API Reference

/greengrass/definition/devices/DeviceDefinitionId/versions/DeviceDefinitionVersionId

GET

GET /greengrass/definition/devices/DeviceDefinitionId/versions/DeviceDefinitionVersionId

Operation ID: GetDeviceDefinitionVersion

Retrieves information about a device definition version.

Produces: application/json

Path Parameters

DeviceDefinitionId

The ID of the device definition.

where used: path; required: true

type: string

DeviceDefinitionVersionId

The ID of the device definition version.

where used: path; required: true

type: string

CLI

Copy
aws greengrass get-device-definition-version \ --device-definition-id <value> \ --device-definition-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

Copy
{ "DeviceDefinitionId": "string", "DeviceDefinitionVersionId": "string" }

Responses

200 (GetDeviceDefinitionVersionResponse)

GetDeviceDefinitionVersionResponse

Copy
{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": { "Devices": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ] } }
GetDeviceDefinitionVersionResponse

type: object

Arn

The ARN of the device definition version.

type: string

Id

The ID of the device definition version.

type: string

Version

The version of the device definition version.

type: string

CreationTimestamp

The time, in milliseconds since the epoch, when the device definition version was created.

type: string

Definition

Information about a device definition version.

type: object

Devices

A list of devices in the definition version.

type: array

items: Device

Device

Information about a device.

type: object

required: ["Id", "ThingArn", "CertificateArn"]

Id

The ID of the device.

type: string

ThingArn

The thing ARN of the device.

type: string

CertificateArn

The ARN of the certificate associated with the device.

type: string

SyncShadow

If true, the device's local shadow will be automatically synced with the cloud.

type: boolean

400

invalid request

GeneralError

Copy
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }
GeneralError

General error information.

type: object

required: ["Message"]

Message

A message containing information about the error.

type: string

ErrorDetails

A list of error details.

type: array

items: ErrorDetail

ErrorDetail

Details about the error.

type: object

DetailedErrorCode

A detailed error code.

type: string

DetailedErrorMessage

A detailed error message.

type: string

On this page: