Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateDeviceInstance

Updates information about a private device instance.

Request Syntax


{
   "arn": "string",
   "labels": [ "string" ],
   "profileArn": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

arn

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

Type: String

Length Constraints: Minimum length of 32. Maximum length of 1011.

Pattern: ^arn:.+

Required: Yes

labels

An array of strings that you want to associate with the device instance.

Type: Array of strings

Required: No

profileArn

The ARN of the profile that you want to associate with the device instance.

Type: String

Length Constraints: Minimum length of 32. Maximum length of 1011.

Pattern: ^arn:.+

Required: No

Response Syntax


{
   "deviceInstance": { 
      "arn": "string",
      "deviceArn": "string",
      "instanceProfile": { 
         "arn": "string",
         "description": "string",
         "excludeAppPackagesFromCleanup": [ "string" ],
         "name": "string",
         "packageCleanup": boolean,
         "rebootAfterUse": boolean
      },
      "labels": [ "string" ],
      "status": "string",
      "udid": "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.

deviceInstance

An object that contains information about your device instance.

Type: DeviceInstance object

Errors

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

ArgumentException

An invalid argument was specified.

HTTP Status Code: 400

LimitExceededException

A limit was exceeded.

HTTP Status Code: 400

NotFoundException

The specified entity was not found.

HTTP Status Code: 400

ServiceAccountException

There was a problem with the service account.

HTTP Status Code: 400