ListClientDevicesAssociatedWithCoreDevice - AWS IoT Greengrass

ListClientDevicesAssociatedWithCoreDevice

Retrieves a paginated list of client devices that are associated with a core device.

Request Syntax

GET /greengrass/v2/coreDevices/coreDeviceThingName/associatedClientDevices?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

coreDeviceThingName

The name of the core device. This is also the name of the AWS IoT thing.

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

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.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "associatedClientDevices": [ { "associationTimestamp": number, "thingName": "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.

associatedClientDevices

A list that describes the client devices that are associated with the core device.

Type: Array of AssociatedClientDevice objects

Array Members: Minimum number of 1 item. Maximum number of 100 items.

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.

retryAfterSeconds

The amount of time to wait before you retry the request.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource can't be found.

resourceId

The ID of the resource that isn't found.

resourceType

The type of the resource that isn't found.

HTTP Status Code: 404

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.

quotaCode

The code for the quota in Service Quotas.

retryAfterSeconds

The amount of time to wait before you retry the request.

serviceCode

The code for the service in Service Quotas.

HTTP Status Code: 429

ValidationException

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

fields

The list of fields that failed to validate.

reason

The reason for the validation exception.

HTTP Status Code: 400

See Also

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