AWS Documentation » AWS IoT Greengrass » API Reference » Greengrass API » Actions » ListDeviceDefinitions

ListDeviceDefinitions

Retrieves a list of device definitions.

URI: GET /greengrass/definition/devices

Produces: application/json

CLI:

aws greengrass list-device-definitions \
    [--max-results <value>] \
    [--next-token <value>]  \
    [--cli-input-json <value>] \
    [--generate-cli-skeleton]

cli-input-json format:

{
  "MaxResults": "integer",
  "NextToken": "string"
}

Parameters:

MaxResults

The maximum number of results to be returned per request.

where used: query; required: false

type: integer

NextToken

The token for the next set of results, or null if there are no additional results.

where used: query; required: false

type: string

Responses:

200 (ListDeviceDefinitionsResponse)

ListDefinitionsResponse

{
  "Definitions": [
    {
      "Name": "string",
      "Id": "string",
      "Arn": "string",
      "LastUpdatedTimestamp": "string",
      "CreationTimestamp": "string",
      "LatestVersion": "string",
      "LatestVersionArn": "string"
    }
  ],
  "NextToken": "string"
}

ListDefinitionsResponse

A list of definitions.

type: object

Definitions

Information about a definition.

type: array

items: DefinitionInformation

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

NextToken

The token for the next set of results, or null if there are no additional results.

type: string