Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateInstanceProfile

Updates information about an existing private device instance profile.

Request Syntax


{
   "arn": "string",
   "description": "string",
   "excludeAppPackagesFromCleanup": [ "string" ],
   "name": "string",
   "packageCleanup": boolean,
   "rebootAfterUse": boolean
}

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 instance profile.

Type: String

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

Pattern: ^arn:aws:devicefarm:.+

Required: Yes

description

The updated description for your instance profile.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 16384.

Required: No

excludeAppPackagesFromCleanup

An array of strings that specifies the list of app packages that should not be cleaned up from the device after a test run is over.

The list of packages is only considered if you set packageCleanup to true.

Type: Array of strings

Required: No

name

The updated name for your instance profile.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

packageCleanup

The updated choice for whether you want to specify package cleanup. The default value is false for private devices.

Type: Boolean

Required: No

rebootAfterUse

The updated choice for whether you want to reboot the device after use. The default value is true.

Type: Boolean

Required: No

Response Syntax


{
   "instanceProfile": { 
      "arn": "string",
      "description": "string",
      "excludeAppPackagesFromCleanup": [ "string" ],
      "name": "string",
      "packageCleanup": boolean,
      "rebootAfterUse": boolean
   }
}

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.

instanceProfile

An object that contains information about your instance profile.

Type: InstanceProfile object

Errors

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

ArgumentException

An invalid argument was specified.

message: Any additional information about the exception.

HTTP Status Code: 400

LimitExceededException

A limit was exceeded.

message: Any additional information about the exception.

HTTP Status Code: 400

NotFoundException

The specified entity was not found.

message: Any additional information about the exception.

HTTP Status Code: 400

ServiceAccountException

There was a problem with the service account.

message: Any additional information about the exception.

HTTP Status Code: 400