Menu
AWS Greengrass
API Reference

/greengrass/definition/devices/DeviceDefinitionId

GET

GET /greengrass/definition/devices/DeviceDefinitionId

Operation ID: GetDeviceDefinition

Retrieves information about a device definition.

Produces: application/json

Path Parameters

DeviceDefinitionId

The ID of the device definition.

where used: path; required: true

type: string

CLI

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

cli-input-json format:

Copy
{ "DeviceDefinitionId": "string" }

Responses

200 (GetDeviceDefinitionResponse)

DefinitionInformation

Copy
{ "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string" }
DefinitionInformation

Information about a definition.

type: object

Name

The name of the definition.

type: string

Id

The ID of the definition.

type: string

Arn

The ARN of the definition.

type: string

LastUpdatedTimestamp

The time, in milliseconds since the epoch, when the definition was last updated.

type: string

CreationTimestamp

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

type: string

LatestVersion

The latest version of the definition.

type: string

LatestVersionArn

The ARN of the latest version of the definition.

type: string

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

DELETE

DELETE /greengrass/definition/devices/DeviceDefinitionId

Operation ID: DeleteDeviceDefinition

Deletes a device definition.

Produces: application/json

Path Parameters

DeviceDefinitionId

The ID of the device definition.

where used: path; required: true

type: string

CLI

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

cli-input-json format:

Copy
{ "DeviceDefinitionId": "string" }

Responses

200

success

Empty

Copy
{ }
Empty Schema

Empty

type: object

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

PUT

PUT /greengrass/definition/devices/DeviceDefinitionId

Operation ID: UpdateDeviceDefinition

Updates a device definition.

Produces: application/json

Body Parameters

UpdateDefinitionRequestBody

where used: body; required: true

Copy
{ "Name": "string" }
Name

The name of the definition.

required: true

type: string

Path Parameters

DeviceDefinitionId

The ID of the device definition.

where used: path; required: true

type: string

CLI

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

cli-input-json format:

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

Responses

200

success

Empty

Copy
{ }
Empty Schema

Empty

type: object

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: