Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DeactivateDeviceIdentifier

Deactivates the specified device identifier.

Request Syntax


POST /v1/device-identifiers/deactivate HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "deviceIdentifierArn": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

Type: String

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

Required: No

deviceIdentifierArn

The Amazon Resource Name (ARN) of the device identifier.

Type: String

Pattern: ^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "deviceIdentifier": { 
      "createdAt": "string",
      "deviceIdentifierArn": "string",
      "iccid": "string",
      "imsi": "string",
      "networkArn": "string",
      "orderArn": "string",
      "status": "string",
      "trafficGroupArn": "string",
      "vendor": "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.

deviceIdentifier

Information about the device identifier.

Type: DeviceIdentifier object

Errors

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

InternalServerException

Information about an internal error.

HTTP Status Code: 500

ResourceNotFoundException

The resource was not found.

HTTP Status Code: 404

ValidationException

The request failed validation.

HTTP Status Code: 400