Menu
AWS Greengrass
API Reference

CreateDeviceDefinitionVersion

Creates a version of a device definition that has already been defined.

URI: /greengrass/definition/devices/DeviceDefinitionId/versions

Operation: POST

Produces: application/json

Parameters:

  • DeviceDefinitionId

    The id of the device definition.

    where used: path

    required: true

    type: string

  • CreateDeviceDefinitionVersionRequestBody

    Information needed to create a device definition version.

    where used: body

    required: true

    schema:

    DeviceDefinitionVersion

    type: object

    Information about a device definition version.

    properties:

    • Devices

      A list of devices in the definition version.

      type: array

      items:

      Information about the Greengrass device.

      Device

      type: object

      Information about a device.

      required: Id|ThingArn|CertificateArn

      properties:

      • 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 is automatically synced with the cloud.

        type: boolean

    Example:

    Copy
    { "Devices": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ] }
  • X-Amzn-Client-Token

    A client token used to correlate requests and responses.

    where used: header

    required: false

    type: string

Responses: