AWS IoT Greengrass Version 1 entered the extended life phase on June 30, 2023. For more information, see the AWS IoT Greengrass V1 maintenance policy. After this date, AWS IoT Greengrass V1 won't release updates that provide features, enhancements, bug fixes, or security patches. Devices that run on AWS IoT Greengrass V1 won't be disrupted and will continue to operate and to connect to the cloud. We strongly recommend that you migrate to AWS IoT Greengrass Version 2, which adds significant new features and support for additional platforms.
/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. This value maps to the
Versionproperty of the correspondingVersionInformationobject, which is returned byListDeviceDefinitionVersionsrequests. If the version is the last one that was associated with a device definition, the value also maps to theLatestVersionproperty of the correspondingDefinitionInformationobject.where used: path; required: true
type: string
Query Parameters
- NextToken
-
The token for the next set of results, or
nullif there are no more results.where used: query; required: false
type: string
CLI
aws greengrass get-device-definition-version \ --device-definition-id <value> \ --device-definition-version-id <value> \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{
"DeviceDefinitionId": "string",
"DeviceDefinitionVersionId": "string",
"NextToken": "string"
}Responses
- 200 (GetDeviceDefinitionVersionResponse)
-
GetDeviceDefinitionVersionResponse
{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": { "Devices": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ] }, "NextToken": "string" }- 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
-
A descriptive or arbitrary ID for the device. This value must be unique within the device definition version. Maximum length is 128 characters with the pattern
[a‑zA‑Z0‑9:_‑]+.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 is synced with the cloud automatically.
type: boolean
- NextToken
-
The token for the next set of results, or
nullif there are no more results.type: string
- 400
-
Invalid request.
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }- GeneralError
-
General error information.
type: object
required: ["Message"]
- Message
-
A message that contains 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
