BatchDisassociateClientDeviceFromCoreDevice - AWS IoT Greengrass

BatchDisassociateClientDeviceFromCoreDevice

Disassociate a list of client devices from a core device. After you disassociate a client device from a core device, the client device won't be able to use cloud discovery to retrieve the core device's connectivity information and certificates.

Request Syntax

POST /greengrass/v2/coreDevices/coreDeviceThingName/disassociateClientDevices HTTP/1.1 Content-type: application/json { "entries": [ { "thingName": "string" } ] }

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

Request Body

The request accepts the following data in JSON format.

entries

The list of client devices to disassociate.

Type: Array of DisassociateClientDeviceFromCoreDeviceEntry objects

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

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "errorEntries": [ { "code": "string", "message": "string", "thingName": "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.

errorEntries

The list of errors (if any) for the entries in the request. Each error entry contains the name of the AWS IoT thing that failed to disassociate.

Type: Array of DisassociateClientDeviceFromCoreDeviceErrorEntry objects

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

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

ResourceNotFoundException

The requested resource can't be 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.

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: