DeregisterDevice
Deregisters a thin client device.
Request Syntax
POST /deregister-device/id HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"targetDeviceStatus": "string"
}URI Request Parameters
The request uses the following URI parameters.
- id
-
The ID of the device to deregister.
Pattern:
[a-zA-Z0-9]{24}Required: Yes
Request Body
The request accepts the following data in JSON format.
- clientToken
-
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value
. If you don't provide this value, then AWS generates a random one for you.
If you retry the operation with the same
ClientToken, but with different parameters, the retry fails with anIdempotentParameterMismatcherror.Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Required: No
- targetDeviceStatus
-
The desired new status for the device.
Type: String
Valid Values:
DEREGISTERED | ARCHIVEDRequired: No
Response Syntax
HTTP/1.1 202
Response Elements
If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- ConflictException
-
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
HTTP Status Code: 409
- InternalServerException
-
The server encountered an internal error and is unable to complete the request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource specified in the request was not found.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the specified constraints.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
