Greengrass / Client / get_device_definition_version

get_device_definition_version#

Greengrass.Client.get_device_definition_version(**kwargs)#

Retrieves information about a device definition version.

See also: AWS API Documentation

Request Syntax

response = client.get_device_definition_version(
    DeviceDefinitionId='string',
    DeviceDefinitionVersionId='string',
    NextToken='string'
)
Parameters:

  • DeviceDefinitionId (string) – [REQUIRED] The ID of the device definition.

  • DeviceDefinitionVersionId (string) – [REQUIRED] The ID of the device definition version. This value maps to the ‘’Version’’ property of the corresponding ‘’VersionInformation’’ object, which is returned by ‘’ListDeviceDefinitionVersions’’ requests. If the version is the last one that was associated with a device definition, the value also maps to the ‘’LatestVersion’’ property of the corresponding ‘’DefinitionInformation’’ object.

  • NextToken (string) – The token for the next set of results, or ‘’null’’ if there are no additional results.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Definition': {
        'Devices': [
            {
                'CertificateArn': 'string',
                'Id': 'string',
                'SyncShadow': True|False,
                'ThingArn': 'string'
            },
        ]
    },
    'Id': 'string',
    'NextToken': 'string',
    'Version': 'string'
}

Response Structure

  • (dict) –

    • Arn (string) – The ARN of the device definition version.

    • CreationTimestamp (string) – The time, in milliseconds since the epoch, when the device definition version was created.

    • Definition (dict) – Information about the device definition version.

      • Devices (list) – A list of devices in the definition version.

        • (dict) – Information about a device.

          • CertificateArn (string) – The ARN of the certificate associated with the device.

          • Id (string) – A descriptive or arbitrary ID for the device. This value must be unique within the device definition version. Max length is 128 characters with pattern ‘’[a-zA-Z0-9:_-]+’’.

          • SyncShadow (boolean) – If true, the device’s local shadow will be automatically synced with the cloud.

          • ThingArn (string) – The thing ARN of the device.

    • Id (string) – The ID of the device definition version.

    • NextToken (string) – The token for the next set of results, or ‘’null’’ if there are no additional results.

    • Version (string) – The version of the device definition version.

Exceptions

  • Greengrass.Client.exceptions.BadRequestException