CreateInstanceProfile
Creates a profile that can be applied to one or more private fleet device instances.
Request Syntax
{
"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.
- description
-
The description of 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.
The list of packages is considered only if you set
packageCleanuptotrue.Type: Array of strings
Required: No
- name
-
The name of your instance profile.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: Yes
- packageCleanup
-
When set to
true, Device Farm removes app packages after a test run. The default value isfalsefor private devices.Type: Boolean
Required: No
- rebootAfterUse
-
When set to
true, Device Farm reboots the instance after a test run. The default value istrue.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.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
