ListCoreDevices - AWS IoT Greengrass

ListCoreDevices

Retrieves a paginated list of AWS IoT Greengrass core devices.

Request Syntax

GET /greengrass/v2/coreDevices?maxResults=maxResults&nextToken=nextToken&status=status&thingGroupArn=thingGroupArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of results to be returned per paginated request.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

The token to be used for the next set of paginated results.

status

The core device status by which to filter. If you specify this parameter, the list includes only core devices that have this status. Choose one of the following options:

  • HEALTHY – The AWS IoT Greengrass Core software and all components run on the core device without issue.

  • UNHEALTHY – The AWS IoT Greengrass Core software or a component is in a failed state on the core device.

Valid Values: HEALTHY | UNHEALTHY

thingGroupArn

The ARN of the AWS IoT thing group by which to filter. If you specify this parameter, the list includes only core devices that are members of this thing group.

Pattern: arn:aws(-cn|-us-gov)?:iot:[^:]+:[0-9]+:thinggroup/.+

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "coreDevices": [ { "coreDeviceThingName": "string", "lastStatusUpdateTimestamp": number, "status": "string" } ], "nextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

coreDevices

A list that summarizes each core device.

Type: Array of CoreDevice objects

nextToken

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

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have permission to perform the action.

HTTP Status Code: 403

InternalServerException

AWS IoT Greengrass can't process your request right now. Try again later.

HTTP Status Code: 500

ThrottlingException

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

HTTP Status Code: 429

ValidationException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: