# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [CreateDevicePool](API_CreateDevicePool.md) 
+  [CreateInstanceProfile](API_CreateInstanceProfile.md) 
+  [CreateNetworkProfile](API_CreateNetworkProfile.md) 
+  [CreateProject](API_CreateProject.md) 
+  [CreateRemoteAccessSession](API_CreateRemoteAccessSession.md) 
+  [CreateTestGridProject](API_CreateTestGridProject.md) 
+  [CreateTestGridUrl](API_CreateTestGridUrl.md) 
+  [CreateUpload](API_CreateUpload.md) 
+  [CreateVPCEConfiguration](API_CreateVPCEConfiguration.md) 
+  [DeleteDevicePool](API_DeleteDevicePool.md) 
+  [DeleteInstanceProfile](API_DeleteInstanceProfile.md) 
+  [DeleteNetworkProfile](API_DeleteNetworkProfile.md) 
+  [DeleteProject](API_DeleteProject.md) 
+  [DeleteRemoteAccessSession](API_DeleteRemoteAccessSession.md) 
+  [DeleteRun](API_DeleteRun.md) 
+  [DeleteTestGridProject](API_DeleteTestGridProject.md) 
+  [DeleteUpload](API_DeleteUpload.md) 
+  [DeleteVPCEConfiguration](API_DeleteVPCEConfiguration.md) 
+  [GetAccountSettings](API_GetAccountSettings.md) 
+  [GetDevice](API_GetDevice.md) 
+  [GetDeviceInstance](API_GetDeviceInstance.md) 
+  [GetDevicePool](API_GetDevicePool.md) 
+  [GetDevicePoolCompatibility](API_GetDevicePoolCompatibility.md) 
+  [GetInstanceProfile](API_GetInstanceProfile.md) 
+  [GetJob](API_GetJob.md) 
+  [GetNetworkProfile](API_GetNetworkProfile.md) 
+  [GetOfferingStatus](API_GetOfferingStatus.md) 
+  [GetProject](API_GetProject.md) 
+  [GetRemoteAccessSession](API_GetRemoteAccessSession.md) 
+  [GetRun](API_GetRun.md) 
+  [GetSuite](API_GetSuite.md) 
+  [GetTest](API_GetTest.md) 
+  [GetTestGridProject](API_GetTestGridProject.md) 
+  [GetTestGridSession](API_GetTestGridSession.md) 
+  [GetUpload](API_GetUpload.md) 
+  [GetVPCEConfiguration](API_GetVPCEConfiguration.md) 
+  [InstallToRemoteAccessSession](API_InstallToRemoteAccessSession.md) 
+  [ListArtifacts](API_ListArtifacts.md) 
+  [ListDeviceInstances](API_ListDeviceInstances.md) 
+  [ListDevicePools](API_ListDevicePools.md) 
+  [ListDevices](API_ListDevices.md) 
+  [ListInstanceProfiles](API_ListInstanceProfiles.md) 
+  [ListJobs](API_ListJobs.md) 
+  [ListNetworkProfiles](API_ListNetworkProfiles.md) 
+  [ListOfferingPromotions](API_ListOfferingPromotions.md) 
+  [ListOfferings](API_ListOfferings.md) 
+  [ListOfferingTransactions](API_ListOfferingTransactions.md) 
+  [ListProjects](API_ListProjects.md) 
+  [ListRemoteAccessSessions](API_ListRemoteAccessSessions.md) 
+  [ListRuns](API_ListRuns.md) 
+  [ListSamples](API_ListSamples.md) 
+  [ListSuites](API_ListSuites.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ListTestGridProjects](API_ListTestGridProjects.md) 
+  [ListTestGridSessionActions](API_ListTestGridSessionActions.md) 
+  [ListTestGridSessionArtifacts](API_ListTestGridSessionArtifacts.md) 
+  [ListTestGridSessions](API_ListTestGridSessions.md) 
+  [ListTests](API_ListTests.md) 
+  [ListUniqueProblems](API_ListUniqueProblems.md) 
+  [ListUploads](API_ListUploads.md) 
+  [ListVPCEConfigurations](API_ListVPCEConfigurations.md) 
+  [PurchaseOffering](API_PurchaseOffering.md) 
+  [RenewOffering](API_RenewOffering.md) 
+  [ScheduleRun](API_ScheduleRun.md) 
+  [StopJob](API_StopJob.md) 
+  [StopRemoteAccessSession](API_StopRemoteAccessSession.md) 
+  [StopRun](API_StopRun.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateDeviceInstance](API_UpdateDeviceInstance.md) 
+  [UpdateDevicePool](API_UpdateDevicePool.md) 
+  [UpdateInstanceProfile](API_UpdateInstanceProfile.md) 
+  [UpdateNetworkProfile](API_UpdateNetworkProfile.md) 
+  [UpdateProject](API_UpdateProject.md) 
+  [UpdateTestGridProject](API_UpdateTestGridProject.md) 
+  [UpdateUpload](API_UpdateUpload.md) 
+  [UpdateVPCEConfiguration](API_UpdateVPCEConfiguration.md) 

# CreateDevicePool
<a name="API_CreateDevicePool"></a>

Creates a device pool.

## Request Syntax
<a name="API_CreateDevicePool_RequestSyntax"></a>

```
{
   "description": "string",
   "maxDevices": number,
   "name": "string",
   "projectArn": "string",
   "rules": [ 
      { 
         "attribute": "string",
         "operator": "string",
         "value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateDevicePool_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [description](#API_CreateDevicePool_RequestSyntax) **   <a name="devicefarm-CreateDevicePool-request-description"></a>
The device pool's description.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 16384.  
Required: No

 ** [maxDevices](#API_CreateDevicePool_RequestSyntax) **   <a name="devicefarm-CreateDevicePool-request-maxDevices"></a>
The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and meet the criteria that you assign for the `rules` parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.  
By specifying the maximum number of devices, you can control the costs that you incur by running tests.  
Type: Integer  
Required: No

 ** [name](#API_CreateDevicePool_RequestSyntax) **   <a name="devicefarm-CreateDevicePool-request-name"></a>
The device pool's name.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: Yes

 ** [projectArn](#API_CreateDevicePool_RequestSyntax) **   <a name="devicefarm-CreateDevicePool-request-projectArn"></a>
The ARN of the project for the device pool.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [rules](#API_CreateDevicePool_RequestSyntax) **   <a name="devicefarm-CreateDevicePool-request-rules"></a>
The device pool's rules.  
Type: Array of [Rule](API_Rule.md) objects  
Required: Yes

## Response Syntax
<a name="API_CreateDevicePool_ResponseSyntax"></a>

```
{
   "devicePool": { 
      "arn": "string",
      "description": "string",
      "maxDevices": number,
      "name": "string",
      "rules": [ 
         { 
            "attribute": "string",
            "operator": "string",
            "value": "string"
         }
      ],
      "type": "string"
   }
}
```

## Response Elements
<a name="API_CreateDevicePool_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [devicePool](#API_CreateDevicePool_ResponseSyntax) **   <a name="devicefarm-CreateDevicePool-response-devicePool"></a>
The newly created device pool.  
Type: [DevicePool](API_DevicePool.md) object

## Errors
<a name="API_CreateDevicePool_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_CreateDevicePool_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/CreateDevicePool) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/CreateDevicePool) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/CreateDevicePool) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/CreateDevicePool) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/CreateDevicePool) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/CreateDevicePool) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/CreateDevicePool) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/CreateDevicePool) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/CreateDevicePool) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/CreateDevicePool) 

# CreateInstanceProfile
<a name="API_CreateInstanceProfile"></a>

Creates a profile that can be applied to one or more private fleet device instances.

## Request Syntax
<a name="API_CreateInstanceProfile_RequestSyntax"></a>

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

## Request Parameters
<a name="API_CreateInstanceProfile_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [description](#API_CreateInstanceProfile_RequestSyntax) **   <a name="devicefarm-CreateInstanceProfile-request-description"></a>
The description of your instance profile.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 16384.  
Required: No

 ** [excludeAppPackagesFromCleanup](#API_CreateInstanceProfile_RequestSyntax) **   <a name="devicefarm-CreateInstanceProfile-request-excludeAppPackagesFromCleanup"></a>
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 `packageCleanup` to `true`.  
Type: Array of strings  
Required: No

 ** [name](#API_CreateInstanceProfile_RequestSyntax) **   <a name="devicefarm-CreateInstanceProfile-request-name"></a>
The name of your instance profile.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: Yes

 ** [packageCleanup](#API_CreateInstanceProfile_RequestSyntax) **   <a name="devicefarm-CreateInstanceProfile-request-packageCleanup"></a>
When set to `true`, Device Farm removes app packages after a test run. The default value is `false` for private devices.  
Type: Boolean  
Required: No

 ** [rebootAfterUse](#API_CreateInstanceProfile_RequestSyntax) **   <a name="devicefarm-CreateInstanceProfile-request-rebootAfterUse"></a>
When set to `true`, Device Farm reboots the instance after a test run. The default value is `true`.  
Type: Boolean  
Required: No

## Response Syntax
<a name="API_CreateInstanceProfile_ResponseSyntax"></a>

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

## Response Elements
<a name="API_CreateInstanceProfile_ResponseElements"></a>

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](#API_CreateInstanceProfile_ResponseSyntax) **   <a name="devicefarm-CreateInstanceProfile-response-instanceProfile"></a>
An object that contains information about your instance profile.  
Type: [InstanceProfile](API_InstanceProfile.md) object

## Errors
<a name="API_CreateInstanceProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_CreateInstanceProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/CreateInstanceProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/CreateInstanceProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/CreateInstanceProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/CreateInstanceProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/CreateInstanceProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/CreateInstanceProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/CreateInstanceProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/CreateInstanceProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/CreateInstanceProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/CreateInstanceProfile) 

# CreateNetworkProfile
<a name="API_CreateNetworkProfile"></a>

Creates a network profile.

## Request Syntax
<a name="API_CreateNetworkProfile_RequestSyntax"></a>

```
{
   "description": "string",
   "downlinkBandwidthBits": number,
   "downlinkDelayMs": number,
   "downlinkJitterMs": number,
   "downlinkLossPercent": number,
   "name": "string",
   "projectArn": "string",
   "type": "string",
   "uplinkBandwidthBits": number,
   "uplinkDelayMs": number,
   "uplinkJitterMs": number,
   "uplinkLossPercent": number
}
```

## Request Parameters
<a name="API_CreateNetworkProfile_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [description](#API_CreateNetworkProfile_RequestSyntax) **   <a name="devicefarm-CreateNetworkProfile-request-description"></a>
The description of the network profile.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 16384.  
Required: No

 ** [downlinkBandwidthBits](#API_CreateNetworkProfile_RequestSyntax) **   <a name="devicefarm-CreateNetworkProfile-request-downlinkBandwidthBits"></a>
The data throughput rate in bits per second, as an integer from 0 to 104857600.  
Type: Long  
Required: No

 ** [downlinkDelayMs](#API_CreateNetworkProfile_RequestSyntax) **   <a name="devicefarm-CreateNetworkProfile-request-downlinkDelayMs"></a>
Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.  
Type: Long  
Required: No

 ** [downlinkJitterMs](#API_CreateNetworkProfile_RequestSyntax) **   <a name="devicefarm-CreateNetworkProfile-request-downlinkJitterMs"></a>
Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.  
Type: Long  
Required: No

 ** [downlinkLossPercent](#API_CreateNetworkProfile_RequestSyntax) **   <a name="devicefarm-CreateNetworkProfile-request-downlinkLossPercent"></a>
Proportion of received packets that fail to arrive from 0 to 100 percent.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** [name](#API_CreateNetworkProfile_RequestSyntax) **   <a name="devicefarm-CreateNetworkProfile-request-name"></a>
The name for the new network profile.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: Yes

 ** [projectArn](#API_CreateNetworkProfile_RequestSyntax) **   <a name="devicefarm-CreateNetworkProfile-request-projectArn"></a>
The Amazon Resource Name (ARN) of the project for which you want to create a network profile.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [type](#API_CreateNetworkProfile_RequestSyntax) **   <a name="devicefarm-CreateNetworkProfile-request-type"></a>
The type of network profile to create. Valid values are listed here.  
Type: String  
Valid Values: `CURATED | PRIVATE`   
Required: No

 ** [uplinkBandwidthBits](#API_CreateNetworkProfile_RequestSyntax) **   <a name="devicefarm-CreateNetworkProfile-request-uplinkBandwidthBits"></a>
The data throughput rate in bits per second, as an integer from 0 to 104857600.  
Type: Long  
Required: No

 ** [uplinkDelayMs](#API_CreateNetworkProfile_RequestSyntax) **   <a name="devicefarm-CreateNetworkProfile-request-uplinkDelayMs"></a>
Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.  
Type: Long  
Required: No

 ** [uplinkJitterMs](#API_CreateNetworkProfile_RequestSyntax) **   <a name="devicefarm-CreateNetworkProfile-request-uplinkJitterMs"></a>
Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.  
Type: Long  
Required: No

 ** [uplinkLossPercent](#API_CreateNetworkProfile_RequestSyntax) **   <a name="devicefarm-CreateNetworkProfile-request-uplinkLossPercent"></a>
Proportion of transmitted packets that fail to arrive from 0 to 100 percent.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

## Response Syntax
<a name="API_CreateNetworkProfile_ResponseSyntax"></a>

```
{
   "networkProfile": { 
      "arn": "string",
      "description": "string",
      "downlinkBandwidthBits": number,
      "downlinkDelayMs": number,
      "downlinkJitterMs": number,
      "downlinkLossPercent": number,
      "name": "string",
      "type": "string",
      "uplinkBandwidthBits": number,
      "uplinkDelayMs": number,
      "uplinkJitterMs": number,
      "uplinkLossPercent": number
   }
}
```

## Response Elements
<a name="API_CreateNetworkProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [networkProfile](#API_CreateNetworkProfile_ResponseSyntax) **   <a name="devicefarm-CreateNetworkProfile-response-networkProfile"></a>
The network profile that is returned by the create network profile request.  
Type: [NetworkProfile](API_NetworkProfile.md) object

## Errors
<a name="API_CreateNetworkProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_CreateNetworkProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/CreateNetworkProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/CreateNetworkProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/CreateNetworkProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/CreateNetworkProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/CreateNetworkProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/CreateNetworkProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/CreateNetworkProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/CreateNetworkProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/CreateNetworkProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/CreateNetworkProfile) 

# CreateProject
<a name="API_CreateProject"></a>

Creates a project.

## Request Syntax
<a name="API_CreateProject_RequestSyntax"></a>

```
{
   "defaultJobTimeoutMinutes": number,
   "environmentVariables": [ 
      { 
         "name": "string",
         "value": "string"
      }
   ],
   "executionRoleArn": "string",
   "name": "string",
   "vpcConfig": { 
      "securityGroupIds": [ "string" ],
      "subnetIds": [ "string" ],
      "vpcId": "string"
   }
}
```

## Request Parameters
<a name="API_CreateProject_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [defaultJobTimeoutMinutes](#API_CreateProject_RequestSyntax) **   <a name="devicefarm-CreateProject-request-defaultJobTimeoutMinutes"></a>
Sets the execution timeout value (in minutes) for a project. All test runs in this project use the specified execution timeout value unless overridden when scheduling a run.  
Type: Integer  
Required: No

 ** [environmentVariables](#API_CreateProject_RequestSyntax) **   <a name="devicefarm-CreateProject-request-environmentVariables"></a>
 A set of environment variables which are used by default for all runs in the project. These environment variables are applied to the test run during the execution of a test spec file.   
 For more information about using test spec files, please see [Custom test environments ](https://docs.aws.amazon.com/devicefarm/latest/developerguide/custom-test-environments.html) in *AWS Device Farm.*   
Type: Array of [EnvironmentVariable](API_EnvironmentVariable.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 32 items.  
Required: No

 ** [executionRoleArn](#API_CreateProject_RequestSyntax) **   <a name="devicefarm-CreateProject-request-executionRoleArn"></a>
An IAM role to be assumed by the test host for all runs in the project.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `^arn:aws:iam::[0-9]{12}:role/.+`   
Required: No

 ** [name](#API_CreateProject_RequestSyntax) **   <a name="devicefarm-CreateProject-request-name"></a>
The project's name.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: Yes

 ** [vpcConfig](#API_CreateProject_RequestSyntax) **   <a name="devicefarm-CreateProject-request-vpcConfig"></a>
The VPC security groups and subnets that are attached to a project.  
Type: [VpcConfig](API_VpcConfig.md) object  
Required: No

## Response Syntax
<a name="API_CreateProject_ResponseSyntax"></a>

```
{
   "project": { 
      "arn": "string",
      "created": number,
      "defaultJobTimeoutMinutes": number,
      "environmentVariables": [ 
         { 
            "name": "string",
            "value": "string"
         }
      ],
      "executionRoleArn": "string",
      "name": "string",
      "vpcConfig": { 
         "securityGroupIds": [ "string" ],
         "subnetIds": [ "string" ],
         "vpcId": "string"
      }
   }
}
```

## Response Elements
<a name="API_CreateProject_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [project](#API_CreateProject_ResponseSyntax) **   <a name="devicefarm-CreateProject-response-project"></a>
The newly created project.  
Type: [Project](API_Project.md) object

## Errors
<a name="API_CreateProject_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** TagOperationException **   
The operation was not successful. Try again.  
HTTP Status Code: 400

## See Also
<a name="API_CreateProject_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/CreateProject) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/CreateProject) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/CreateProject) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/CreateProject) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/CreateProject) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/CreateProject) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/CreateProject) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/CreateProject) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/CreateProject) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/CreateProject) 

# CreateRemoteAccessSession
<a name="API_CreateRemoteAccessSession"></a>

Specifies and starts a remote access session.

## Request Syntax
<a name="API_CreateRemoteAccessSession_RequestSyntax"></a>

```
{
   "appArn": "string",
   "configuration": { 
      "auxiliaryApps": [ "string" ],
      "billingMethod": "string",
      "deviceProxy": { 
         "host": "string",
         "port": number
      },
      "vpceConfigurationArns": [ "string" ]
   },
   "deviceArn": "string",
   "instanceArn": "string",
   "interactionMode": "string",
   "name": "string",
   "projectArn": "string",
   "skipAppResign": boolean
}
```

## Request Parameters
<a name="API_CreateRemoteAccessSession_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [appArn](#API_CreateRemoteAccessSession_RequestSyntax) **   <a name="devicefarm-CreateRemoteAccessSession-request-appArn"></a>
The Amazon Resource Name (ARN) of the app to create the remote access session.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: No

 ** [configuration](#API_CreateRemoteAccessSession_RequestSyntax) **   <a name="devicefarm-CreateRemoteAccessSession-request-configuration"></a>
The configuration information for the remote access session request.  
Type: [CreateRemoteAccessSessionConfiguration](API_CreateRemoteAccessSessionConfiguration.md) object  
Required: No

 ** [deviceArn](#API_CreateRemoteAccessSession_RequestSyntax) **   <a name="devicefarm-CreateRemoteAccessSession-request-deviceArn"></a>
The ARN of the device for which you want to create a remote access session.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [instanceArn](#API_CreateRemoteAccessSession_RequestSyntax) **   <a name="devicefarm-CreateRemoteAccessSession-request-instanceArn"></a>
The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: No

 ** [interactionMode](#API_CreateRemoteAccessSession_RequestSyntax) **   <a name="devicefarm-CreateRemoteAccessSession-request-interactionMode"></a>
 *This parameter has been deprecated.*   
The interaction mode of the remote access session. Changing the interactive mode of remote access sessions is no longer available.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 64.  
Valid Values: `INTERACTIVE | NO_VIDEO | VIDEO_ONLY`   
Required: No

 ** [name](#API_CreateRemoteAccessSession_RequestSyntax) **   <a name="devicefarm-CreateRemoteAccessSession-request-name"></a>
The name of the remote access session to create.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

 ** [projectArn](#API_CreateRemoteAccessSession_RequestSyntax) **   <a name="devicefarm-CreateRemoteAccessSession-request-projectArn"></a>
The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [skipAppResign](#API_CreateRemoteAccessSession_RequestSyntax) **   <a name="devicefarm-CreateRemoteAccessSession-request-skipAppResign"></a>
When set to `true`, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.  
For more information on how Device Farm modifies your uploads during tests, see [Do you modify my app?](http://aws.amazon.com/device-farm/faqs/)   
Type: Boolean  
Required: No

## Response Syntax
<a name="API_CreateRemoteAccessSession_ResponseSyntax"></a>

```
{
   "remoteAccessSession": { 
      "appUpload": "string",
      "arn": "string",
      "billingMethod": "string",
      "created": number,
      "device": { 
         "arn": "string",
         "availability": "string",
         "carrier": "string",
         "cpu": { 
            "architecture": "string",
            "clock": number,
            "frequency": "string"
         },
         "fleetName": "string",
         "fleetType": "string",
         "formFactor": "string",
         "heapSize": number,
         "image": "string",
         "instances": [ 
            { 
               "arn": "string",
               "deviceArn": "string",
               "instanceProfile": { 
                  "arn": "string",
                  "description": "string",
                  "excludeAppPackagesFromCleanup": [ "string" ],
                  "name": "string",
                  "packageCleanup": boolean,
                  "rebootAfterUse": boolean
               },
               "labels": [ "string" ],
               "status": "string",
               "udid": "string"
            }
         ],
         "manufacturer": "string",
         "memory": number,
         "model": "string",
         "modelId": "string",
         "name": "string",
         "os": "string",
         "platform": "string",
         "radio": "string",
         "remoteAccessEnabled": boolean,
         "remoteDebugEnabled": boolean,
         "resolution": { 
            "height": number,
            "width": number
         }
      },
      "deviceMinutes": { 
         "metered": number,
         "total": number,
         "unmetered": number
      },
      "deviceProxy": { 
         "host": "string",
         "port": number
      },
      "deviceUdid": "string",
      "endpoint": "string",
      "endpoints": { 
         "interactiveEndpoint": "string",
         "remoteDriverEndpoint": "string"
      },
      "instanceArn": "string",
      "interactionMode": "string",
      "message": "string",
      "name": "string",
      "result": "string",
      "skipAppResign": boolean,
      "started": number,
      "status": "string",
      "stopped": number,
      "vpcConfig": { 
         "securityGroupIds": [ "string" ],
         "subnetIds": [ "string" ],
         "vpcId": "string"
      }
   }
}
```

## Response Elements
<a name="API_CreateRemoteAccessSession_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [remoteAccessSession](#API_CreateRemoteAccessSession_ResponseSyntax) **   <a name="devicefarm-CreateRemoteAccessSession-response-remoteAccessSession"></a>
A container that describes the remote access session when the request to create a remote access session is sent.  
Type: [RemoteAccessSession](API_RemoteAccessSession.md) object

## Errors
<a name="API_CreateRemoteAccessSession_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_CreateRemoteAccessSession_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/CreateRemoteAccessSession) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/CreateRemoteAccessSession) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/CreateRemoteAccessSession) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/CreateRemoteAccessSession) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/CreateRemoteAccessSession) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/CreateRemoteAccessSession) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/CreateRemoteAccessSession) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/CreateRemoteAccessSession) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/CreateRemoteAccessSession) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/CreateRemoteAccessSession) 

# CreateTestGridProject
<a name="API_CreateTestGridProject"></a>

Creates a Selenium testing project. Projects are used to track [TestGridSession](API_TestGridSession.md) instances.

## Request Syntax
<a name="API_CreateTestGridProject_RequestSyntax"></a>

```
{
   "description": "string",
   "name": "string",
   "vpcConfig": { 
      "securityGroupIds": [ "string" ],
      "subnetIds": [ "string" ],
      "vpcId": "string"
   }
}
```

## Request Parameters
<a name="API_CreateTestGridProject_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [description](#API_CreateTestGridProject_RequestSyntax) **   <a name="devicefarm-CreateTestGridProject-request-description"></a>
Human-readable description of the project.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `.*\S.*`   
Required: No

 ** [name](#API_CreateTestGridProject_RequestSyntax) **   <a name="devicefarm-CreateTestGridProject-request-name"></a>
Human-readable name of the Selenium testing project.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `.*\S.*`   
Required: Yes

 ** [vpcConfig](#API_CreateTestGridProject_RequestSyntax) **   <a name="devicefarm-CreateTestGridProject-request-vpcConfig"></a>
The VPC security groups and subnets that are attached to a project.  
Type: [TestGridVpcConfig](API_TestGridVpcConfig.md) object  
Required: No

## Response Syntax
<a name="API_CreateTestGridProject_ResponseSyntax"></a>

```
{
   "testGridProject": { 
      "arn": "string",
      "created": number,
      "description": "string",
      "name": "string",
      "vpcConfig": { 
         "securityGroupIds": [ "string" ],
         "subnetIds": [ "string" ],
         "vpcId": "string"
      }
   }
}
```

## Response Elements
<a name="API_CreateTestGridProject_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [testGridProject](#API_CreateTestGridProject_ResponseSyntax) **   <a name="devicefarm-CreateTestGridProject-response-testGridProject"></a>
ARN of the Selenium testing project that was created.  
Type: [TestGridProject](API_TestGridProject.md) object

## Errors
<a name="API_CreateTestGridProject_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ArgumentException **   
An invalid argument was specified.    
 ** message **   
Any additional information about the exception.
HTTP Status Code: 400

 ** InternalServiceException **   
An internal exception was raised in the service. Contact [aws-devicefarm-support@amazon.com](mailto:aws-devicefarm-support@amazon.com) if you see this error.   
HTTP Status Code: 500

 ** LimitExceededException **   
A limit was exceeded.    
 ** message **   
Any additional information about the exception.
HTTP Status Code: 400

## See Also
<a name="API_CreateTestGridProject_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/CreateTestGridProject) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/CreateTestGridProject) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/CreateTestGridProject) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/CreateTestGridProject) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/CreateTestGridProject) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/CreateTestGridProject) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/CreateTestGridProject) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/CreateTestGridProject) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/CreateTestGridProject) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/CreateTestGridProject) 

# CreateTestGridUrl
<a name="API_CreateTestGridUrl"></a>

Creates a signed, short-term URL that can be passed to a Selenium `RemoteWebDriver` constructor.

## Request Syntax
<a name="API_CreateTestGridUrl_RequestSyntax"></a>

```
{
   "expiresInSeconds": number,
   "projectArn": "string"
}
```

## Request Parameters
<a name="API_CreateTestGridUrl_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [expiresInSeconds](#API_CreateTestGridUrl_RequestSyntax) **   <a name="devicefarm-CreateTestGridUrl-request-expiresInSeconds"></a>
Lifetime, in seconds, of the URL.  
Type: Integer  
Valid Range: Minimum value of 60. Maximum value of 86400.  
Required: Yes

 ** [projectArn](#API_CreateTestGridUrl_RequestSyntax) **   <a name="devicefarm-CreateTestGridUrl-request-projectArn"></a>
ARN (from [CreateTestGridProject](API_CreateTestGridProject.md) or [ListTestGridProjects](API_ListTestGridProjects.md)) to associate with the short-term URL.   
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Syntax
<a name="API_CreateTestGridUrl_ResponseSyntax"></a>

```
{
   "expires": number,
   "url": "string"
}
```

## Response Elements
<a name="API_CreateTestGridUrl_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [expires](#API_CreateTestGridUrl_ResponseSyntax) **   <a name="devicefarm-CreateTestGridUrl-response-expires"></a>
The number of seconds the URL from [CreateTestGridUrl:url](#devicefarm-CreateTestGridUrl-response-url) stays active.  
Type: Timestamp

 ** [url](#API_CreateTestGridUrl_ResponseSyntax) **   <a name="devicefarm-CreateTestGridUrl-response-url"></a>
A signed URL, expiring in [CreateTestGridUrl:expiresInSeconds](#devicefarm-CreateTestGridUrl-request-expiresInSeconds) seconds, to be passed to a `RemoteWebDriver`.   
Type: String

## Errors
<a name="API_CreateTestGridUrl_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ArgumentException **   
An invalid argument was specified.    
 ** message **   
Any additional information about the exception.
HTTP Status Code: 400

 ** InternalServiceException **   
An internal exception was raised in the service. Contact [aws-devicefarm-support@amazon.com](mailto:aws-devicefarm-support@amazon.com) if you see this error.   
HTTP Status Code: 500

 ** NotFoundException **   
The specified entity was not found.    
 ** message **   
Any additional information about the exception.
HTTP Status Code: 400

## See Also
<a name="API_CreateTestGridUrl_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/CreateTestGridUrl) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/CreateTestGridUrl) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/CreateTestGridUrl) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/CreateTestGridUrl) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/CreateTestGridUrl) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/CreateTestGridUrl) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/CreateTestGridUrl) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/CreateTestGridUrl) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/CreateTestGridUrl) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/CreateTestGridUrl) 

# CreateUpload
<a name="API_CreateUpload"></a>

Uploads an app or test scripts.

## Request Syntax
<a name="API_CreateUpload_RequestSyntax"></a>

```
{
   "contentType": "string",
   "name": "string",
   "projectArn": "string",
   "type": "string"
}
```

## Request Parameters
<a name="API_CreateUpload_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [contentType](#API_CreateUpload_RequestSyntax) **   <a name="devicefarm-CreateUpload-request-contentType"></a>
The upload's content type (for example, `application/octet-stream`).  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 64.  
Required: No

 ** [name](#API_CreateUpload_RequestSyntax) **   <a name="devicefarm-CreateUpload-request-name"></a>
The upload's file name. The name should not contain any forward slashes (`/`). If you are uploading an iOS app, the file name must end with the `.ipa` extension. If you are uploading an Android app, the file name must end with the `.apk` extension. For all others, the file name must end with the `.zip` file extension.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: Yes

 ** [projectArn](#API_CreateUpload_RequestSyntax) **   <a name="devicefarm-CreateUpload-request-projectArn"></a>
The ARN of the project for the upload.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [type](#API_CreateUpload_RequestSyntax) **   <a name="devicefarm-CreateUpload-request-type"></a>
The upload's upload type.  
Must be one of the following values:  
+ ANDROID\$1APP
+ IOS\$1APP
+ WEB\$1APP
+ EXTERNAL\$1DATA
+ APPIUM\$1JAVA\$1JUNIT\$1TEST\$1PACKAGE
+ APPIUM\$1JAVA\$1TESTNG\$1TEST\$1PACKAGE
+ APPIUM\$1PYTHON\$1TEST\$1PACKAGE
+ APPIUM\$1NODE\$1TEST\$1PACKAGE
+ APPIUM\$1RUBY\$1TEST\$1PACKAGE
+ APPIUM\$1WEB\$1JAVA\$1JUNIT\$1TEST\$1PACKAGE
+ APPIUM\$1WEB\$1JAVA\$1TESTNG\$1TEST\$1PACKAGE
+ APPIUM\$1WEB\$1PYTHON\$1TEST\$1PACKAGE
+ APPIUM\$1WEB\$1NODE\$1TEST\$1PACKAGE
+ APPIUM\$1WEB\$1RUBY\$1TEST\$1PACKAGE
+ INSTRUMENTATION\$1TEST\$1PACKAGE
+ XCTEST\$1TEST\$1PACKAGE
+ XCTEST\$1UI\$1TEST\$1PACKAGE
+ APPIUM\$1JAVA\$1JUNIT\$1TEST\$1SPEC
+ APPIUM\$1JAVA\$1TESTNG\$1TEST\$1SPEC
+ APPIUM\$1PYTHON\$1TEST\$1SPEC
+ APPIUM\$1NODE\$1TEST\$1SPEC
+ APPIUM\$1RUBY\$1TEST\$1SPEC
+ APPIUM\$1WEB\$1JAVA\$1JUNIT\$1TEST\$1SPEC
+ APPIUM\$1WEB\$1JAVA\$1TESTNG\$1TEST\$1SPEC
+ APPIUM\$1WEB\$1PYTHON\$1TEST\$1SPEC
+ APPIUM\$1WEB\$1NODE\$1TEST\$1SPEC
+ APPIUM\$1WEB\$1RUBY\$1TEST\$1SPEC
+ INSTRUMENTATION\$1TEST\$1SPEC
+ XCTEST\$1UI\$1TEST\$1SPEC
 If you call `CreateUpload` with `WEB_APP` specified, AWS Device Farm throws an `ArgumentException` error.  
Type: String  
Valid Values: `ANDROID_APP | IOS_APP | WEB_APP | EXTERNAL_DATA | APPIUM_JAVA_JUNIT_TEST_PACKAGE | APPIUM_JAVA_TESTNG_TEST_PACKAGE | APPIUM_PYTHON_TEST_PACKAGE | APPIUM_NODE_TEST_PACKAGE | APPIUM_RUBY_TEST_PACKAGE | APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE | APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE | APPIUM_WEB_PYTHON_TEST_PACKAGE | APPIUM_WEB_NODE_TEST_PACKAGE | APPIUM_WEB_RUBY_TEST_PACKAGE | CALABASH_TEST_PACKAGE | INSTRUMENTATION_TEST_PACKAGE | UIAUTOMATION_TEST_PACKAGE | UIAUTOMATOR_TEST_PACKAGE | XCTEST_TEST_PACKAGE | XCTEST_UI_TEST_PACKAGE | APPIUM_JAVA_JUNIT_TEST_SPEC | APPIUM_JAVA_TESTNG_TEST_SPEC | APPIUM_PYTHON_TEST_SPEC | APPIUM_NODE_TEST_SPEC | APPIUM_RUBY_TEST_SPEC | APPIUM_WEB_JAVA_JUNIT_TEST_SPEC | APPIUM_WEB_JAVA_TESTNG_TEST_SPEC | APPIUM_WEB_PYTHON_TEST_SPEC | APPIUM_WEB_NODE_TEST_SPEC | APPIUM_WEB_RUBY_TEST_SPEC | INSTRUMENTATION_TEST_SPEC | XCTEST_UI_TEST_SPEC`   
Required: Yes

## Response Syntax
<a name="API_CreateUpload_ResponseSyntax"></a>

```
{
   "upload": { 
      "arn": "string",
      "category": "string",
      "contentType": "string",
      "created": number,
      "message": "string",
      "metadata": "string",
      "name": "string",
      "status": "string",
      "type": "string",
      "url": "string"
   }
}
```

## Response Elements
<a name="API_CreateUpload_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [upload](#API_CreateUpload_ResponseSyntax) **   <a name="devicefarm-CreateUpload-response-upload"></a>
The newly created upload.  
Type: [Upload](API_Upload.md) object

## Errors
<a name="API_CreateUpload_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_CreateUpload_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/CreateUpload) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/CreateUpload) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/CreateUpload) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/CreateUpload) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/CreateUpload) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/CreateUpload) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/CreateUpload) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/CreateUpload) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/CreateUpload) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/CreateUpload) 

# CreateVPCEConfiguration
<a name="API_CreateVPCEConfiguration"></a>

Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.

## Request Syntax
<a name="API_CreateVPCEConfiguration_RequestSyntax"></a>

```
{
   "serviceDnsName": "string",
   "vpceConfigurationDescription": "string",
   "vpceConfigurationName": "string",
   "vpceServiceName": "string"
}
```

## Request Parameters
<a name="API_CreateVPCEConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [serviceDnsName](#API_CreateVPCEConfiguration_RequestSyntax) **   <a name="devicefarm-CreateVPCEConfiguration-request-serviceDnsName"></a>
The DNS name of the service running in your VPC that you want Device Farm to test.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: Yes

 ** [vpceConfigurationDescription](#API_CreateVPCEConfiguration_RequestSyntax) **   <a name="devicefarm-CreateVPCEConfiguration-request-vpceConfigurationDescription"></a>
An optional description that provides details about your VPC endpoint configuration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** [vpceConfigurationName](#API_CreateVPCEConfiguration_RequestSyntax) **   <a name="devicefarm-CreateVPCEConfiguration-request-vpceConfigurationName"></a>
The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: Yes

 ** [vpceServiceName](#API_CreateVPCEConfiguration_RequestSyntax) **   <a name="devicefarm-CreateVPCEConfiguration-request-vpceServiceName"></a>
The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: Yes

## Response Syntax
<a name="API_CreateVPCEConfiguration_ResponseSyntax"></a>

```
{
   "vpceConfiguration": { 
      "arn": "string",
      "serviceDnsName": "string",
      "vpceConfigurationDescription": "string",
      "vpceConfigurationName": "string",
      "vpceServiceName": "string"
   }
}
```

## Response Elements
<a name="API_CreateVPCEConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [vpceConfiguration](#API_CreateVPCEConfiguration_ResponseSyntax) **   <a name="devicefarm-CreateVPCEConfiguration-response-vpceConfiguration"></a>
An object that contains information about your VPC endpoint configuration.  
Type: [VPCEConfiguration](API_VPCEConfiguration.md) object

## Errors
<a name="API_CreateVPCEConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** ServiceAccountException **   
There was a problem with the service account.    
 ** message **   
Any additional information about the exception.
HTTP Status Code: 400

## See Also
<a name="API_CreateVPCEConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/CreateVPCEConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/CreateVPCEConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/CreateVPCEConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/CreateVPCEConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/CreateVPCEConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/CreateVPCEConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/CreateVPCEConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/CreateVPCEConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/CreateVPCEConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/CreateVPCEConfiguration) 

# DeleteDevicePool
<a name="API_DeleteDevicePool"></a>

Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.

## Request Syntax
<a name="API_DeleteDevicePool_RequestSyntax"></a>

```
{
   "arn": "string"
}
```

## Request Parameters
<a name="API_DeleteDevicePool_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_DeleteDevicePool_RequestSyntax) **   <a name="devicefarm-DeleteDevicePool-request-arn"></a>
Represents the Amazon Resource Name (ARN) of the Device Farm device pool to delete.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Elements
<a name="API_DeleteDevicePool_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteDevicePool_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_DeleteDevicePool_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/DeleteDevicePool) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/DeleteDevicePool) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/DeleteDevicePool) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/DeleteDevicePool) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/DeleteDevicePool) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/DeleteDevicePool) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/DeleteDevicePool) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/DeleteDevicePool) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/DeleteDevicePool) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/DeleteDevicePool) 

# DeleteInstanceProfile
<a name="API_DeleteInstanceProfile"></a>

Deletes a profile that can be applied to one or more private device instances.

## Request Syntax
<a name="API_DeleteInstanceProfile_RequestSyntax"></a>

```
{
   "arn": "string"
}
```

## Request Parameters
<a name="API_DeleteInstanceProfile_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_DeleteInstanceProfile_RequestSyntax) **   <a name="devicefarm-DeleteInstanceProfile-request-arn"></a>
The Amazon Resource Name (ARN) of the instance profile you are requesting to delete.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Elements
<a name="API_DeleteInstanceProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteInstanceProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_DeleteInstanceProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/DeleteInstanceProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/DeleteInstanceProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/DeleteInstanceProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/DeleteInstanceProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/DeleteInstanceProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/DeleteInstanceProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/DeleteInstanceProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/DeleteInstanceProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/DeleteInstanceProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/DeleteInstanceProfile) 

# DeleteNetworkProfile
<a name="API_DeleteNetworkProfile"></a>

Deletes a network profile.

## Request Syntax
<a name="API_DeleteNetworkProfile_RequestSyntax"></a>

```
{
   "arn": "string"
}
```

## Request Parameters
<a name="API_DeleteNetworkProfile_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_DeleteNetworkProfile_RequestSyntax) **   <a name="devicefarm-DeleteNetworkProfile-request-arn"></a>
The ARN of the network profile to delete.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Elements
<a name="API_DeleteNetworkProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteNetworkProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_DeleteNetworkProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/DeleteNetworkProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/DeleteNetworkProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/DeleteNetworkProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/DeleteNetworkProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/DeleteNetworkProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/DeleteNetworkProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/DeleteNetworkProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/DeleteNetworkProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/DeleteNetworkProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/DeleteNetworkProfile) 

# DeleteProject
<a name="API_DeleteProject"></a>

Deletes an AWS Device Farm project, given the project ARN. You cannot delete a project if it has an active run or session.

**Important**  
You cannot undo this operation.

## Request Syntax
<a name="API_DeleteProject_RequestSyntax"></a>

```
{
   "arn": "string"
}
```

## Request Parameters
<a name="API_DeleteProject_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_DeleteProject_RequestSyntax) **   <a name="devicefarm-DeleteProject-request-arn"></a>
Represents the Amazon Resource Name (ARN) of the Device Farm project to delete.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Elements
<a name="API_DeleteProject_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteProject_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_DeleteProject_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/DeleteProject) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/DeleteProject) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/DeleteProject) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/DeleteProject) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/DeleteProject) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/DeleteProject) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/DeleteProject) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/DeleteProject) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/DeleteProject) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/DeleteProject) 

# DeleteRemoteAccessSession
<a name="API_DeleteRemoteAccessSession"></a>

Deletes a completed remote access session and its results. You cannot delete a remote access session if it is still active.

**Important**  
You cannot undo this operation.

## Request Syntax
<a name="API_DeleteRemoteAccessSession_RequestSyntax"></a>

```
{
   "arn": "string"
}
```

## Request Parameters
<a name="API_DeleteRemoteAccessSession_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_DeleteRemoteAccessSession_RequestSyntax) **   <a name="devicefarm-DeleteRemoteAccessSession-request-arn"></a>
The Amazon Resource Name (ARN) of the session for which you want to delete remote access.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Elements
<a name="API_DeleteRemoteAccessSession_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteRemoteAccessSession_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_DeleteRemoteAccessSession_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/DeleteRemoteAccessSession) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/DeleteRemoteAccessSession) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/DeleteRemoteAccessSession) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/DeleteRemoteAccessSession) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/DeleteRemoteAccessSession) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/DeleteRemoteAccessSession) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/DeleteRemoteAccessSession) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/DeleteRemoteAccessSession) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/DeleteRemoteAccessSession) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/DeleteRemoteAccessSession) 

# DeleteRun
<a name="API_DeleteRun"></a>

Deletes the run, given the run ARN. You cannot delete a run if it is still active.

**Important**  
You cannot undo this operation.

## Request Syntax
<a name="API_DeleteRun_RequestSyntax"></a>

```
{
   "arn": "string"
}
```

## Request Parameters
<a name="API_DeleteRun_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_DeleteRun_RequestSyntax) **   <a name="devicefarm-DeleteRun-request-arn"></a>
The Amazon Resource Name (ARN) for the run to delete.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Elements
<a name="API_DeleteRun_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteRun_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_DeleteRun_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/DeleteRun) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/DeleteRun) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/DeleteRun) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/DeleteRun) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/DeleteRun) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/DeleteRun) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/DeleteRun) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/DeleteRun) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/DeleteRun) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/DeleteRun) 

# DeleteTestGridProject
<a name="API_DeleteTestGridProject"></a>

 Deletes a Selenium testing project and all content generated under it. You cannot delete a project if it has active sessions.

**Important**  
You cannot undo this operation.

## Request Syntax
<a name="API_DeleteTestGridProject_RequestSyntax"></a>

```
{
   "projectArn": "string"
}
```

## Request Parameters
<a name="API_DeleteTestGridProject_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [projectArn](#API_DeleteTestGridProject_RequestSyntax) **   <a name="devicefarm-DeleteTestGridProject-request-projectArn"></a>
The ARN of the project to delete, from [CreateTestGridProject](API_CreateTestGridProject.md) or [ListTestGridProjects](API_ListTestGridProjects.md).  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Elements
<a name="API_DeleteTestGridProject_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteTestGridProject_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ArgumentException **   
An invalid argument was specified.    
 ** message **   
Any additional information about the exception.
HTTP Status Code: 400

 ** CannotDeleteException **   
The requested object could not be deleted.  
HTTP Status Code: 400

 ** InternalServiceException **   
An internal exception was raised in the service. Contact [aws-devicefarm-support@amazon.com](mailto:aws-devicefarm-support@amazon.com) if you see this error.   
HTTP Status Code: 500

 ** NotFoundException **   
The specified entity was not found.    
 ** message **   
Any additional information about the exception.
HTTP Status Code: 400

## See Also
<a name="API_DeleteTestGridProject_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/DeleteTestGridProject) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/DeleteTestGridProject) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/DeleteTestGridProject) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/DeleteTestGridProject) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/DeleteTestGridProject) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/DeleteTestGridProject) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/DeleteTestGridProject) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/DeleteTestGridProject) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/DeleteTestGridProject) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/DeleteTestGridProject) 

# DeleteUpload
<a name="API_DeleteUpload"></a>

Deletes an upload given the upload ARN.

## Request Syntax
<a name="API_DeleteUpload_RequestSyntax"></a>

```
{
   "arn": "string"
}
```

## Request Parameters
<a name="API_DeleteUpload_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_DeleteUpload_RequestSyntax) **   <a name="devicefarm-DeleteUpload-request-arn"></a>
Represents the Amazon Resource Name (ARN) of the Device Farm upload to delete.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Elements
<a name="API_DeleteUpload_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteUpload_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_DeleteUpload_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/DeleteUpload) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/DeleteUpload) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/DeleteUpload) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/DeleteUpload) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/DeleteUpload) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/DeleteUpload) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/DeleteUpload) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/DeleteUpload) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/DeleteUpload) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/DeleteUpload) 

# DeleteVPCEConfiguration
<a name="API_DeleteVPCEConfiguration"></a>

Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.

## Request Syntax
<a name="API_DeleteVPCEConfiguration_RequestSyntax"></a>

```
{
   "arn": "string"
}
```

## Request Parameters
<a name="API_DeleteVPCEConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_DeleteVPCEConfiguration_RequestSyntax) **   <a name="devicefarm-DeleteVPCEConfiguration-request-arn"></a>
The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to delete.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Elements
<a name="API_DeleteVPCEConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteVPCEConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ArgumentException **   
An invalid argument was specified.    
 ** message **   
Any additional information about the exception.
HTTP Status Code: 400

 ** InvalidOperationException **   
There was an error with the update request, or you do not have sufficient permissions to update this VPC endpoint configuration.  
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

## See Also
<a name="API_DeleteVPCEConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/DeleteVPCEConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/DeleteVPCEConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/DeleteVPCEConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/DeleteVPCEConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/DeleteVPCEConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/DeleteVPCEConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/DeleteVPCEConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/DeleteVPCEConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/DeleteVPCEConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/DeleteVPCEConfiguration) 

# GetAccountSettings
<a name="API_GetAccountSettings"></a>

Returns the number of unmetered iOS or unmetered Android devices that have been purchased by the account.

## Response Syntax
<a name="API_GetAccountSettings_ResponseSyntax"></a>

```
{
   "accountSettings": { 
      "awsAccountNumber": "string",
      "defaultJobTimeoutMinutes": number,
      "maxJobTimeoutMinutes": number,
      "maxSlots": { 
         "string" : number 
      },
      "skipAppResign": boolean,
      "trialMinutes": { 
         "remaining": number,
         "total": number
      },
      "unmeteredDevices": { 
         "string" : number 
      },
      "unmeteredRemoteAccessDevices": { 
         "string" : number 
      }
   }
}
```

## Response Elements
<a name="API_GetAccountSettings_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [accountSettings](#API_GetAccountSettings_ResponseSyntax) **   <a name="devicefarm-GetAccountSettings-response-accountSettings"></a>
The account settings.  
Type: [AccountSettings](API_AccountSettings.md) object

## Errors
<a name="API_GetAccountSettings_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_GetAccountSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/GetAccountSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/GetAccountSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetAccountSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/GetAccountSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/GetAccountSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/GetAccountSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/GetAccountSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetAccountSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetAccountSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetAccountSettings) 

# GetDevice
<a name="API_GetDevice"></a>

Gets information about a unique device type.

## Request Syntax
<a name="API_GetDevice_RequestSyntax"></a>

```
{
   "arn": "string"
}
```

## Request Parameters
<a name="API_GetDevice_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_GetDevice_RequestSyntax) **   <a name="devicefarm-GetDevice-request-arn"></a>
The device type's ARN.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Syntax
<a name="API_GetDevice_ResponseSyntax"></a>

```
{
   "device": { 
      "arn": "string",
      "availability": "string",
      "carrier": "string",
      "cpu": { 
         "architecture": "string",
         "clock": number,
         "frequency": "string"
      },
      "fleetName": "string",
      "fleetType": "string",
      "formFactor": "string",
      "heapSize": number,
      "image": "string",
      "instances": [ 
         { 
            "arn": "string",
            "deviceArn": "string",
            "instanceProfile": { 
               "arn": "string",
               "description": "string",
               "excludeAppPackagesFromCleanup": [ "string" ],
               "name": "string",
               "packageCleanup": boolean,
               "rebootAfterUse": boolean
            },
            "labels": [ "string" ],
            "status": "string",
            "udid": "string"
         }
      ],
      "manufacturer": "string",
      "memory": number,
      "model": "string",
      "modelId": "string",
      "name": "string",
      "os": "string",
      "platform": "string",
      "radio": "string",
      "remoteAccessEnabled": boolean,
      "remoteDebugEnabled": boolean,
      "resolution": { 
         "height": number,
         "width": number
      }
   }
}
```

## Response Elements
<a name="API_GetDevice_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [device](#API_GetDevice_ResponseSyntax) **   <a name="devicefarm-GetDevice-response-device"></a>
An object that contains information about the requested device.  
Type: [Device](API_Device.md) object

## Errors
<a name="API_GetDevice_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_GetDevice_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/GetDevice) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/GetDevice) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetDevice) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/GetDevice) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/GetDevice) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/GetDevice) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/GetDevice) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetDevice) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetDevice) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetDevice) 

# GetDeviceInstance
<a name="API_GetDeviceInstance"></a>

Returns information about a device instance that belongs to a private device fleet.

## Request Syntax
<a name="API_GetDeviceInstance_RequestSyntax"></a>

```
{
   "arn": "string"
}
```

## Request Parameters
<a name="API_GetDeviceInstance_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_GetDeviceInstance_RequestSyntax) **   <a name="devicefarm-GetDeviceInstance-request-arn"></a>
The Amazon Resource Name (ARN) of the instance you're requesting information about.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Syntax
<a name="API_GetDeviceInstance_ResponseSyntax"></a>

```
{
   "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
<a name="API_GetDeviceInstance_ResponseElements"></a>

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](#API_GetDeviceInstance_ResponseSyntax) **   <a name="devicefarm-GetDeviceInstance-response-deviceInstance"></a>
An object that contains information about your device instance.  
Type: [DeviceInstance](API_DeviceInstance.md) object

## Errors
<a name="API_GetDeviceInstance_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_GetDeviceInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/GetDeviceInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/GetDeviceInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetDeviceInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/GetDeviceInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/GetDeviceInstance) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/GetDeviceInstance) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/GetDeviceInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetDeviceInstance) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetDeviceInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetDeviceInstance) 

# GetDevicePool
<a name="API_GetDevicePool"></a>

Gets information about a device pool.

## Request Syntax
<a name="API_GetDevicePool_RequestSyntax"></a>

```
{
   "arn": "string"
}
```

## Request Parameters
<a name="API_GetDevicePool_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_GetDevicePool_RequestSyntax) **   <a name="devicefarm-GetDevicePool-request-arn"></a>
The device pool's ARN.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Syntax
<a name="API_GetDevicePool_ResponseSyntax"></a>

```
{
   "devicePool": { 
      "arn": "string",
      "description": "string",
      "maxDevices": number,
      "name": "string",
      "rules": [ 
         { 
            "attribute": "string",
            "operator": "string",
            "value": "string"
         }
      ],
      "type": "string"
   }
}
```

## Response Elements
<a name="API_GetDevicePool_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [devicePool](#API_GetDevicePool_ResponseSyntax) **   <a name="devicefarm-GetDevicePool-response-devicePool"></a>
An object that contains information about the requested device pool.  
Type: [DevicePool](API_DevicePool.md) object

## Errors
<a name="API_GetDevicePool_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_GetDevicePool_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/GetDevicePool) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/GetDevicePool) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetDevicePool) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/GetDevicePool) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/GetDevicePool) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/GetDevicePool) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/GetDevicePool) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetDevicePool) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetDevicePool) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetDevicePool) 

# GetDevicePoolCompatibility
<a name="API_GetDevicePoolCompatibility"></a>

Gets information about compatibility with a device pool.

## Request Syntax
<a name="API_GetDevicePoolCompatibility_RequestSyntax"></a>

```
{
   "appArn": "string",
   "configuration": { 
      "auxiliaryApps": [ "string" ],
      "billingMethod": "string",
      "customerArtifactPaths": { 
         "androidPaths": [ "string" ],
         "deviceHostPaths": [ "string" ],
         "iosPaths": [ "string" ]
      },
      "deviceProxy": { 
         "host": "string",
         "port": number
      },
      "environmentVariables": [ 
         { 
            "name": "string",
            "value": "string"
         }
      ],
      "executionRoleArn": "string",
      "extraDataPackageArn": "string",
      "locale": "string",
      "location": { 
         "latitude": number,
         "longitude": number
      },
      "networkProfileArn": "string",
      "radios": { 
         "bluetooth": boolean,
         "gps": boolean,
         "nfc": boolean,
         "wifi": boolean
      },
      "vpceConfigurationArns": [ "string" ]
   },
   "devicePoolArn": "string",
   "projectArn": "string",
   "test": { 
      "filter": "string",
      "parameters": { 
         "string" : "string" 
      },
      "testPackageArn": "string",
      "testSpecArn": "string",
      "type": "string"
   },
   "testType": "string"
}
```

## Request Parameters
<a name="API_GetDevicePoolCompatibility_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [appArn](#API_GetDevicePoolCompatibility_RequestSyntax) **   <a name="devicefarm-GetDevicePoolCompatibility-request-appArn"></a>
The ARN of the app that is associated with the specified device pool.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: No

 ** [configuration](#API_GetDevicePoolCompatibility_RequestSyntax) **   <a name="devicefarm-GetDevicePoolCompatibility-request-configuration"></a>
An object that contains information about the settings for a run.  
Type: [ScheduleRunConfiguration](API_ScheduleRunConfiguration.md) object  
Required: No

 ** [devicePoolArn](#API_GetDevicePoolCompatibility_RequestSyntax) **   <a name="devicefarm-GetDevicePoolCompatibility-request-devicePoolArn"></a>
The device pool's ARN.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [projectArn](#API_GetDevicePoolCompatibility_RequestSyntax) **   <a name="devicefarm-GetDevicePoolCompatibility-request-projectArn"></a>
The ARN of the project for which you want to check device pool compatibility.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: No

 ** [test](#API_GetDevicePoolCompatibility_RequestSyntax) **   <a name="devicefarm-GetDevicePoolCompatibility-request-test"></a>
Information about the uploaded test to be run against the device pool.  
Type: [ScheduleRunTest](API_ScheduleRunTest.md) object  
Required: No

 ** [testType](#API_GetDevicePoolCompatibility_RequestSyntax) **   <a name="devicefarm-GetDevicePoolCompatibility-request-testType"></a>
The test type for the specified device pool.  
Allowed values include the following:  
+ BUILTIN\$1FUZZ.
+ APPIUM\$1JAVA\$1JUNIT.
+ APPIUM\$1JAVA\$1TESTNG.
+ APPIUM\$1PYTHON.
+ APPIUM\$1NODE.
+ APPIUM\$1RUBY.
+ APPIUM\$1WEB\$1JAVA\$1JUNIT.
+ APPIUM\$1WEB\$1JAVA\$1TESTNG.
+ APPIUM\$1WEB\$1PYTHON.
+ APPIUM\$1WEB\$1NODE.
+ APPIUM\$1WEB\$1RUBY.
+ INSTRUMENTATION.
+ XCTEST.
+ XCTEST\$1UI.
Type: String  
Valid Values: `BUILTIN_FUZZ | APPIUM_JAVA_JUNIT | APPIUM_JAVA_TESTNG | APPIUM_PYTHON | APPIUM_NODE | APPIUM_RUBY | APPIUM_WEB_JAVA_JUNIT | APPIUM_WEB_JAVA_TESTNG | APPIUM_WEB_PYTHON | APPIUM_WEB_NODE | APPIUM_WEB_RUBY | INSTRUMENTATION | XCTEST | XCTEST_UI`   
Required: No

## Response Syntax
<a name="API_GetDevicePoolCompatibility_ResponseSyntax"></a>

```
{
   "compatibleDevices": [ 
      { 
         "compatible": boolean,
         "device": { 
            "arn": "string",
            "availability": "string",
            "carrier": "string",
            "cpu": { 
               "architecture": "string",
               "clock": number,
               "frequency": "string"
            },
            "fleetName": "string",
            "fleetType": "string",
            "formFactor": "string",
            "heapSize": number,
            "image": "string",
            "instances": [ 
               { 
                  "arn": "string",
                  "deviceArn": "string",
                  "instanceProfile": { 
                     "arn": "string",
                     "description": "string",
                     "excludeAppPackagesFromCleanup": [ "string" ],
                     "name": "string",
                     "packageCleanup": boolean,
                     "rebootAfterUse": boolean
                  },
                  "labels": [ "string" ],
                  "status": "string",
                  "udid": "string"
               }
            ],
            "manufacturer": "string",
            "memory": number,
            "model": "string",
            "modelId": "string",
            "name": "string",
            "os": "string",
            "platform": "string",
            "radio": "string",
            "remoteAccessEnabled": boolean,
            "remoteDebugEnabled": boolean,
            "resolution": { 
               "height": number,
               "width": number
            }
         },
         "incompatibilityMessages": [ 
            { 
               "message": "string",
               "type": "string"
            }
         ]
      }
   ],
   "incompatibleDevices": [ 
      { 
         "compatible": boolean,
         "device": { 
            "arn": "string",
            "availability": "string",
            "carrier": "string",
            "cpu": { 
               "architecture": "string",
               "clock": number,
               "frequency": "string"
            },
            "fleetName": "string",
            "fleetType": "string",
            "formFactor": "string",
            "heapSize": number,
            "image": "string",
            "instances": [ 
               { 
                  "arn": "string",
                  "deviceArn": "string",
                  "instanceProfile": { 
                     "arn": "string",
                     "description": "string",
                     "excludeAppPackagesFromCleanup": [ "string" ],
                     "name": "string",
                     "packageCleanup": boolean,
                     "rebootAfterUse": boolean
                  },
                  "labels": [ "string" ],
                  "status": "string",
                  "udid": "string"
               }
            ],
            "manufacturer": "string",
            "memory": number,
            "model": "string",
            "modelId": "string",
            "name": "string",
            "os": "string",
            "platform": "string",
            "radio": "string",
            "remoteAccessEnabled": boolean,
            "remoteDebugEnabled": boolean,
            "resolution": { 
               "height": number,
               "width": number
            }
         },
         "incompatibilityMessages": [ 
            { 
               "message": "string",
               "type": "string"
            }
         ]
      }
   ]
}
```

## Response Elements
<a name="API_GetDevicePoolCompatibility_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [compatibleDevices](#API_GetDevicePoolCompatibility_ResponseSyntax) **   <a name="devicefarm-GetDevicePoolCompatibility-response-compatibleDevices"></a>
Information about compatible devices.  
Type: Array of [DevicePoolCompatibilityResult](API_DevicePoolCompatibilityResult.md) objects

 ** [incompatibleDevices](#API_GetDevicePoolCompatibility_ResponseSyntax) **   <a name="devicefarm-GetDevicePoolCompatibility-response-incompatibleDevices"></a>
Information about incompatible devices.  
Type: Array of [DevicePoolCompatibilityResult](API_DevicePoolCompatibilityResult.md) objects

## Errors
<a name="API_GetDevicePoolCompatibility_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_GetDevicePoolCompatibility_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/GetDevicePoolCompatibility) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/GetDevicePoolCompatibility) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetDevicePoolCompatibility) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/GetDevicePoolCompatibility) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/GetDevicePoolCompatibility) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/GetDevicePoolCompatibility) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/GetDevicePoolCompatibility) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetDevicePoolCompatibility) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetDevicePoolCompatibility) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetDevicePoolCompatibility) 

# GetInstanceProfile
<a name="API_GetInstanceProfile"></a>

Returns information about the specified instance profile.

## Request Syntax
<a name="API_GetInstanceProfile_RequestSyntax"></a>

```
{
   "arn": "string"
}
```

## Request Parameters
<a name="API_GetInstanceProfile_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_GetInstanceProfile_RequestSyntax) **   <a name="devicefarm-GetInstanceProfile-request-arn"></a>
The Amazon Resource Name (ARN) of an instance profile.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Syntax
<a name="API_GetInstanceProfile_ResponseSyntax"></a>

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

## Response Elements
<a name="API_GetInstanceProfile_ResponseElements"></a>

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](#API_GetInstanceProfile_ResponseSyntax) **   <a name="devicefarm-GetInstanceProfile-response-instanceProfile"></a>
An object that contains information about an instance profile.  
Type: [InstanceProfile](API_InstanceProfile.md) object

## Errors
<a name="API_GetInstanceProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_GetInstanceProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/GetInstanceProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/GetInstanceProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetInstanceProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/GetInstanceProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/GetInstanceProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/GetInstanceProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/GetInstanceProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetInstanceProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetInstanceProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetInstanceProfile) 

# GetJob
<a name="API_GetJob"></a>

Gets information about a job.

## Request Syntax
<a name="API_GetJob_RequestSyntax"></a>

```
{
   "arn": "string"
}
```

## Request Parameters
<a name="API_GetJob_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_GetJob_RequestSyntax) **   <a name="devicefarm-GetJob-request-arn"></a>
The job's ARN.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Syntax
<a name="API_GetJob_ResponseSyntax"></a>

```
{
   "job": { 
      "arn": "string",
      "counters": { 
         "errored": number,
         "failed": number,
         "passed": number,
         "skipped": number,
         "stopped": number,
         "total": number,
         "warned": number
      },
      "created": number,
      "device": { 
         "arn": "string",
         "availability": "string",
         "carrier": "string",
         "cpu": { 
            "architecture": "string",
            "clock": number,
            "frequency": "string"
         },
         "fleetName": "string",
         "fleetType": "string",
         "formFactor": "string",
         "heapSize": number,
         "image": "string",
         "instances": [ 
            { 
               "arn": "string",
               "deviceArn": "string",
               "instanceProfile": { 
                  "arn": "string",
                  "description": "string",
                  "excludeAppPackagesFromCleanup": [ "string" ],
                  "name": "string",
                  "packageCleanup": boolean,
                  "rebootAfterUse": boolean
               },
               "labels": [ "string" ],
               "status": "string",
               "udid": "string"
            }
         ],
         "manufacturer": "string",
         "memory": number,
         "model": "string",
         "modelId": "string",
         "name": "string",
         "os": "string",
         "platform": "string",
         "radio": "string",
         "remoteAccessEnabled": boolean,
         "remoteDebugEnabled": boolean,
         "resolution": { 
            "height": number,
            "width": number
         }
      },
      "deviceMinutes": { 
         "metered": number,
         "total": number,
         "unmetered": number
      },
      "instanceArn": "string",
      "message": "string",
      "name": "string",
      "result": "string",
      "started": number,
      "status": "string",
      "stopped": number,
      "type": "string",
      "videoCapture": boolean,
      "videoEndpoint": "string"
   }
}
```

## Response Elements
<a name="API_GetJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [job](#API_GetJob_ResponseSyntax) **   <a name="devicefarm-GetJob-response-job"></a>
An object that contains information about the requested job.  
Type: [Job](API_Job.md) object

## Errors
<a name="API_GetJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_GetJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/GetJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/GetJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/GetJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/GetJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/GetJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/GetJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetJob) 

# GetNetworkProfile
<a name="API_GetNetworkProfile"></a>

Returns information about a network profile.

## Request Syntax
<a name="API_GetNetworkProfile_RequestSyntax"></a>

```
{
   "arn": "string"
}
```

## Request Parameters
<a name="API_GetNetworkProfile_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_GetNetworkProfile_RequestSyntax) **   <a name="devicefarm-GetNetworkProfile-request-arn"></a>
The ARN of the network profile to return information about.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Syntax
<a name="API_GetNetworkProfile_ResponseSyntax"></a>

```
{
   "networkProfile": { 
      "arn": "string",
      "description": "string",
      "downlinkBandwidthBits": number,
      "downlinkDelayMs": number,
      "downlinkJitterMs": number,
      "downlinkLossPercent": number,
      "name": "string",
      "type": "string",
      "uplinkBandwidthBits": number,
      "uplinkDelayMs": number,
      "uplinkJitterMs": number,
      "uplinkLossPercent": number
   }
}
```

## Response Elements
<a name="API_GetNetworkProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [networkProfile](#API_GetNetworkProfile_ResponseSyntax) **   <a name="devicefarm-GetNetworkProfile-response-networkProfile"></a>
The network profile.  
Type: [NetworkProfile](API_NetworkProfile.md) object

## Errors
<a name="API_GetNetworkProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_GetNetworkProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/GetNetworkProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/GetNetworkProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetNetworkProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/GetNetworkProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/GetNetworkProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/GetNetworkProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/GetNetworkProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetNetworkProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetNetworkProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetNetworkProfile) 

# GetOfferingStatus
<a name="API_GetOfferingStatus"></a>

Gets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and the offerings that will be available in the next period. The API returns a `NotEligible` error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact [aws-devicefarm-support@amazon.com](mailto:aws-devicefarm-support@amazon.com).

## Request Syntax
<a name="API_GetOfferingStatus_RequestSyntax"></a>

```
{
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_GetOfferingStatus_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [nextToken](#API_GetOfferingStatus_RequestSyntax) **   <a name="devicefarm-GetOfferingStatus-request-nextToken"></a>
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_GetOfferingStatus_ResponseSyntax"></a>

```
{
   "current": { 
      "string" : { 
         "effectiveOn": number,
         "offering": { 
            "description": "string",
            "id": "string",
            "platform": "string",
            "recurringCharges": [ 
               { 
                  "cost": { 
                     "amount": number,
                     "currencyCode": "string"
                  },
                  "frequency": "string"
               }
            ],
            "type": "string"
         },
         "quantity": number,
         "type": "string"
      }
   },
   "nextPeriod": { 
      "string" : { 
         "effectiveOn": number,
         "offering": { 
            "description": "string",
            "id": "string",
            "platform": "string",
            "recurringCharges": [ 
               { 
                  "cost": { 
                     "amount": number,
                     "currencyCode": "string"
                  },
                  "frequency": "string"
               }
            ],
            "type": "string"
         },
         "quantity": number,
         "type": "string"
      }
   },
   "nextToken": "string"
}
```

## Response Elements
<a name="API_GetOfferingStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [current](#API_GetOfferingStatus_ResponseSyntax) **   <a name="devicefarm-GetOfferingStatus-response-current"></a>
When specified, gets the offering status for the current period.  
Type: String to [OfferingStatus](API_OfferingStatus.md) object map  
Key Length Constraints: Minimum length of 32.

 ** [nextPeriod](#API_GetOfferingStatus_ResponseSyntax) **   <a name="devicefarm-GetOfferingStatus-response-nextPeriod"></a>
When specified, gets the offering status for the next period.  
Type: String to [OfferingStatus](API_OfferingStatus.md) object map  
Key Length Constraints: Minimum length of 32.

 ** [nextToken](#API_GetOfferingStatus_ResponseSyntax) **   <a name="devicefarm-GetOfferingStatus-response-nextToken"></a>
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.

## Errors
<a name="API_GetOfferingStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** NotEligibleException **   
Exception gets thrown when a user is not eligible to perform the specified transaction.    
 ** message **   
The HTTP response code of a Not Eligible 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

## Examples
<a name="API_GetOfferingStatus_Examples"></a>

### Example
<a name="API_GetOfferingStatus_Example_1"></a>

The following example checks the current and renewal status.

#### Sample Response
<a name="API_GetOfferingStatus_Example_1_Response"></a>

```
{
    "current": {
        "offering-id-ios": {
            "offering": {
                "platform": "IOS",
                "type": "RECURRING",
                "id": "offering-id-ios",
                "description": "iOS Unmetered Device Slot"
            },
            "quantity": 1
        }
    },
    "nextPeriod": {
        "offering-id-ios": {
              "effectiveOn": 1459468800.0,
              "offering": {
                  "platform": "IOS",
                  "type": "RECURRING",
                  "id": "offering-id-ios",
                  "description": "iOS Unmetered Device Slot"
              },
              "quantity": 1
          }
    }
}
```

## See Also
<a name="API_GetOfferingStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/GetOfferingStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/GetOfferingStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetOfferingStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/GetOfferingStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/GetOfferingStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/GetOfferingStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/GetOfferingStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetOfferingStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetOfferingStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetOfferingStatus) 

# GetProject
<a name="API_GetProject"></a>

Gets information about a project.

## Request Syntax
<a name="API_GetProject_RequestSyntax"></a>

```
{
   "arn": "string"
}
```

## Request Parameters
<a name="API_GetProject_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_GetProject_RequestSyntax) **   <a name="devicefarm-GetProject-request-arn"></a>
The project's ARN.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Syntax
<a name="API_GetProject_ResponseSyntax"></a>

```
{
   "project": { 
      "arn": "string",
      "created": number,
      "defaultJobTimeoutMinutes": number,
      "environmentVariables": [ 
         { 
            "name": "string",
            "value": "string"
         }
      ],
      "executionRoleArn": "string",
      "name": "string",
      "vpcConfig": { 
         "securityGroupIds": [ "string" ],
         "subnetIds": [ "string" ],
         "vpcId": "string"
      }
   }
}
```

## Response Elements
<a name="API_GetProject_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [project](#API_GetProject_ResponseSyntax) **   <a name="devicefarm-GetProject-response-project"></a>
The project to get information about.  
Type: [Project](API_Project.md) object

## Errors
<a name="API_GetProject_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_GetProject_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/GetProject) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/GetProject) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetProject) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/GetProject) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/GetProject) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/GetProject) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/GetProject) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetProject) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetProject) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetProject) 

# GetRemoteAccessSession
<a name="API_GetRemoteAccessSession"></a>

Returns a link to a currently running remote access session.

## Request Syntax
<a name="API_GetRemoteAccessSession_RequestSyntax"></a>

```
{
   "arn": "string"
}
```

## Request Parameters
<a name="API_GetRemoteAccessSession_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_GetRemoteAccessSession_RequestSyntax) **   <a name="devicefarm-GetRemoteAccessSession-request-arn"></a>
The Amazon Resource Name (ARN) of the remote access session about which you want to get session information.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Syntax
<a name="API_GetRemoteAccessSession_ResponseSyntax"></a>

```
{
   "remoteAccessSession": { 
      "appUpload": "string",
      "arn": "string",
      "billingMethod": "string",
      "created": number,
      "device": { 
         "arn": "string",
         "availability": "string",
         "carrier": "string",
         "cpu": { 
            "architecture": "string",
            "clock": number,
            "frequency": "string"
         },
         "fleetName": "string",
         "fleetType": "string",
         "formFactor": "string",
         "heapSize": number,
         "image": "string",
         "instances": [ 
            { 
               "arn": "string",
               "deviceArn": "string",
               "instanceProfile": { 
                  "arn": "string",
                  "description": "string",
                  "excludeAppPackagesFromCleanup": [ "string" ],
                  "name": "string",
                  "packageCleanup": boolean,
                  "rebootAfterUse": boolean
               },
               "labels": [ "string" ],
               "status": "string",
               "udid": "string"
            }
         ],
         "manufacturer": "string",
         "memory": number,
         "model": "string",
         "modelId": "string",
         "name": "string",
         "os": "string",
         "platform": "string",
         "radio": "string",
         "remoteAccessEnabled": boolean,
         "remoteDebugEnabled": boolean,
         "resolution": { 
            "height": number,
            "width": number
         }
      },
      "deviceMinutes": { 
         "metered": number,
         "total": number,
         "unmetered": number
      },
      "deviceProxy": { 
         "host": "string",
         "port": number
      },
      "deviceUdid": "string",
      "endpoint": "string",
      "endpoints": { 
         "interactiveEndpoint": "string",
         "remoteDriverEndpoint": "string"
      },
      "instanceArn": "string",
      "interactionMode": "string",
      "message": "string",
      "name": "string",
      "result": "string",
      "skipAppResign": boolean,
      "started": number,
      "status": "string",
      "stopped": number,
      "vpcConfig": { 
         "securityGroupIds": [ "string" ],
         "subnetIds": [ "string" ],
         "vpcId": "string"
      }
   }
}
```

## Response Elements
<a name="API_GetRemoteAccessSession_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [remoteAccessSession](#API_GetRemoteAccessSession_ResponseSyntax) **   <a name="devicefarm-GetRemoteAccessSession-response-remoteAccessSession"></a>
A container that lists detailed information about the remote access session.  
Type: [RemoteAccessSession](API_RemoteAccessSession.md) object

## Errors
<a name="API_GetRemoteAccessSession_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_GetRemoteAccessSession_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/GetRemoteAccessSession) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/GetRemoteAccessSession) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetRemoteAccessSession) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/GetRemoteAccessSession) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/GetRemoteAccessSession) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/GetRemoteAccessSession) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/GetRemoteAccessSession) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetRemoteAccessSession) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetRemoteAccessSession) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetRemoteAccessSession) 

# GetRun
<a name="API_GetRun"></a>

Gets information about a run.

## Request Syntax
<a name="API_GetRun_RequestSyntax"></a>

```
{
   "arn": "string"
}
```

## Request Parameters
<a name="API_GetRun_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_GetRun_RequestSyntax) **   <a name="devicefarm-GetRun-request-arn"></a>
The run's ARN.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Syntax
<a name="API_GetRun_ResponseSyntax"></a>

```
{
   "run": { 
      "appUpload": "string",
      "arn": "string",
      "billingMethod": "string",
      "completedJobs": number,
      "counters": { 
         "errored": number,
         "failed": number,
         "passed": number,
         "skipped": number,
         "stopped": number,
         "total": number,
         "warned": number
      },
      "created": number,
      "customerArtifactPaths": { 
         "androidPaths": [ "string" ],
         "deviceHostPaths": [ "string" ],
         "iosPaths": [ "string" ]
      },
      "deviceMinutes": { 
         "metered": number,
         "total": number,
         "unmetered": number
      },
      "devicePoolArn": "string",
      "deviceProxy": { 
         "host": "string",
         "port": number
      },
      "deviceSelectionResult": { 
         "filters": [ 
            { 
               "attribute": "string",
               "operator": "string",
               "values": [ "string" ]
            }
         ],
         "matchedDevicesCount": number,
         "maxDevices": number
      },
      "environmentVariables": [ 
         { 
            "name": "string",
            "value": "string"
         }
      ],
      "eventCount": number,
      "executionRoleArn": "string",
      "jobTimeoutMinutes": number,
      "locale": "string",
      "location": { 
         "latitude": number,
         "longitude": number
      },
      "message": "string",
      "name": "string",
      "networkProfile": { 
         "arn": "string",
         "description": "string",
         "downlinkBandwidthBits": number,
         "downlinkDelayMs": number,
         "downlinkJitterMs": number,
         "downlinkLossPercent": number,
         "name": "string",
         "type": "string",
         "uplinkBandwidthBits": number,
         "uplinkDelayMs": number,
         "uplinkJitterMs": number,
         "uplinkLossPercent": number
      },
      "parsingResultUrl": "string",
      "platform": "string",
      "radios": { 
         "bluetooth": boolean,
         "gps": boolean,
         "nfc": boolean,
         "wifi": boolean
      },
      "result": "string",
      "resultCode": "string",
      "seed": number,
      "skipAppResign": boolean,
      "started": number,
      "status": "string",
      "stopped": number,
      "testSpecArn": "string",
      "totalJobs": number,
      "type": "string",
      "vpcConfig": { 
         "securityGroupIds": [ "string" ],
         "subnetIds": [ "string" ],
         "vpcId": "string"
      },
      "webUrl": "string"
   }
}
```

## Response Elements
<a name="API_GetRun_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [run](#API_GetRun_ResponseSyntax) **   <a name="devicefarm-GetRun-response-run"></a>
The run to get results from.  
Type: [Run](API_Run.md) object

## Errors
<a name="API_GetRun_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_GetRun_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/GetRun) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/GetRun) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetRun) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/GetRun) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/GetRun) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/GetRun) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/GetRun) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetRun) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetRun) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetRun) 

# GetSuite
<a name="API_GetSuite"></a>

Gets information about a suite.

## Request Syntax
<a name="API_GetSuite_RequestSyntax"></a>

```
{
   "arn": "string"
}
```

## Request Parameters
<a name="API_GetSuite_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_GetSuite_RequestSyntax) **   <a name="devicefarm-GetSuite-request-arn"></a>
The suite's ARN.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Syntax
<a name="API_GetSuite_ResponseSyntax"></a>

```
{
   "suite": { 
      "arn": "string",
      "counters": { 
         "errored": number,
         "failed": number,
         "passed": number,
         "skipped": number,
         "stopped": number,
         "total": number,
         "warned": number
      },
      "created": number,
      "deviceMinutes": { 
         "metered": number,
         "total": number,
         "unmetered": number
      },
      "message": "string",
      "name": "string",
      "result": "string",
      "started": number,
      "status": "string",
      "stopped": number,
      "type": "string"
   }
}
```

## Response Elements
<a name="API_GetSuite_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [suite](#API_GetSuite_ResponseSyntax) **   <a name="devicefarm-GetSuite-response-suite"></a>
A collection of one or more tests.  
Type: [Suite](API_Suite.md) object

## Errors
<a name="API_GetSuite_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_GetSuite_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/GetSuite) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/GetSuite) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetSuite) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/GetSuite) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/GetSuite) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/GetSuite) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/GetSuite) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetSuite) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetSuite) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetSuite) 

# GetTest
<a name="API_GetTest"></a>

Gets information about a test.

## Request Syntax
<a name="API_GetTest_RequestSyntax"></a>

```
{
   "arn": "string"
}
```

## Request Parameters
<a name="API_GetTest_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_GetTest_RequestSyntax) **   <a name="devicefarm-GetTest-request-arn"></a>
The test's ARN.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Syntax
<a name="API_GetTest_ResponseSyntax"></a>

```
{
   "test": { 
      "arn": "string",
      "counters": { 
         "errored": number,
         "failed": number,
         "passed": number,
         "skipped": number,
         "stopped": number,
         "total": number,
         "warned": number
      },
      "created": number,
      "deviceMinutes": { 
         "metered": number,
         "total": number,
         "unmetered": number
      },
      "message": "string",
      "name": "string",
      "result": "string",
      "started": number,
      "status": "string",
      "stopped": number,
      "type": "string"
   }
}
```

## Response Elements
<a name="API_GetTest_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [test](#API_GetTest_ResponseSyntax) **   <a name="devicefarm-GetTest-response-test"></a>
A test condition that is evaluated.  
Type: [Test](API_Test.md) object

## Errors
<a name="API_GetTest_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_GetTest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/GetTest) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/GetTest) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetTest) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/GetTest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/GetTest) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/GetTest) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/GetTest) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetTest) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetTest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetTest) 

# GetTestGridProject
<a name="API_GetTestGridProject"></a>

Retrieves information about a Selenium testing project.

## Request Syntax
<a name="API_GetTestGridProject_RequestSyntax"></a>

```
{
   "projectArn": "string"
}
```

## Request Parameters
<a name="API_GetTestGridProject_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [projectArn](#API_GetTestGridProject_RequestSyntax) **   <a name="devicefarm-GetTestGridProject-request-projectArn"></a>
The ARN of the Selenium testing project, from either [CreateTestGridProject](API_CreateTestGridProject.md) or [ListTestGridProjects](API_ListTestGridProjects.md).  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Syntax
<a name="API_GetTestGridProject_ResponseSyntax"></a>

```
{
   "testGridProject": { 
      "arn": "string",
      "created": number,
      "description": "string",
      "name": "string",
      "vpcConfig": { 
         "securityGroupIds": [ "string" ],
         "subnetIds": [ "string" ],
         "vpcId": "string"
      }
   }
}
```

## Response Elements
<a name="API_GetTestGridProject_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [testGridProject](#API_GetTestGridProject_ResponseSyntax) **   <a name="devicefarm-GetTestGridProject-response-testGridProject"></a>
A [TestGridProject](API_TestGridProject.md).  
Type: [TestGridProject](API_TestGridProject.md) object

## Errors
<a name="API_GetTestGridProject_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ArgumentException **   
An invalid argument was specified.    
 ** message **   
Any additional information about the exception.
HTTP Status Code: 400

 ** InternalServiceException **   
An internal exception was raised in the service. Contact [aws-devicefarm-support@amazon.com](mailto:aws-devicefarm-support@amazon.com) if you see this error.   
HTTP Status Code: 500

 ** NotFoundException **   
The specified entity was not found.    
 ** message **   
Any additional information about the exception.
HTTP Status Code: 400

## See Also
<a name="API_GetTestGridProject_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/GetTestGridProject) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/GetTestGridProject) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetTestGridProject) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/GetTestGridProject) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/GetTestGridProject) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/GetTestGridProject) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/GetTestGridProject) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetTestGridProject) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetTestGridProject) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetTestGridProject) 

# GetTestGridSession
<a name="API_GetTestGridSession"></a>

A session is an instance of a browser created through a `RemoteWebDriver` with the URL from [CreateTestGridUrl:url](API_CreateTestGridUrl.md#devicefarm-CreateTestGridUrl-response-url). You can use the following to look up sessions:
+ The session ARN ([GetTestGridSession:sessionArn](#devicefarm-GetTestGridSession-request-sessionArn)).
+ The project ARN and a session ID ([GetTestGridSession:projectArn](#devicefarm-GetTestGridSession-request-projectArn) and [GetTestGridSession:sessionId](#devicefarm-GetTestGridSession-request-sessionId)).



## Request Syntax
<a name="API_GetTestGridSession_RequestSyntax"></a>

```
{
   "projectArn": "string",
   "sessionArn": "string",
   "sessionId": "string"
}
```

## Request Parameters
<a name="API_GetTestGridSession_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [projectArn](#API_GetTestGridSession_RequestSyntax) **   <a name="devicefarm-GetTestGridSession-request-projectArn"></a>
The ARN for the project that this session belongs to. See [CreateTestGridProject](API_CreateTestGridProject.md) and [ListTestGridProjects](API_ListTestGridProjects.md).  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: No

 ** [sessionArn](#API_GetTestGridSession_RequestSyntax) **   <a name="devicefarm-GetTestGridSession-request-sessionArn"></a>
An ARN that uniquely identifies a [TestGridSession](API_TestGridSession.md).  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: No

 ** [sessionId](#API_GetTestGridSession_RequestSyntax) **   <a name="devicefarm-GetTestGridSession-request-sessionId"></a>
An ID associated with this session.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `.*\S.*`   
Required: No

## Response Syntax
<a name="API_GetTestGridSession_ResponseSyntax"></a>

```
{
   "testGridSession": { 
      "arn": "string",
      "billingMinutes": number,
      "created": number,
      "ended": number,
      "seleniumProperties": "string",
      "status": "string"
   }
}
```

## Response Elements
<a name="API_GetTestGridSession_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [testGridSession](#API_GetTestGridSession_ResponseSyntax) **   <a name="devicefarm-GetTestGridSession-response-testGridSession"></a>
The [TestGridSession](API_TestGridSession.md) that was requested.  
Type: [TestGridSession](API_TestGridSession.md) object

## Errors
<a name="API_GetTestGridSession_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ArgumentException **   
An invalid argument was specified.    
 ** message **   
Any additional information about the exception.
HTTP Status Code: 400

 ** InternalServiceException **   
An internal exception was raised in the service. Contact [aws-devicefarm-support@amazon.com](mailto:aws-devicefarm-support@amazon.com) if you see this error.   
HTTP Status Code: 500

 ** NotFoundException **   
The specified entity was not found.    
 ** message **   
Any additional information about the exception.
HTTP Status Code: 400

## See Also
<a name="API_GetTestGridSession_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/GetTestGridSession) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/GetTestGridSession) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetTestGridSession) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/GetTestGridSession) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/GetTestGridSession) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/GetTestGridSession) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/GetTestGridSession) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetTestGridSession) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetTestGridSession) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetTestGridSession) 

# GetUpload
<a name="API_GetUpload"></a>

Gets information about an upload.

## Request Syntax
<a name="API_GetUpload_RequestSyntax"></a>

```
{
   "arn": "string"
}
```

## Request Parameters
<a name="API_GetUpload_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_GetUpload_RequestSyntax) **   <a name="devicefarm-GetUpload-request-arn"></a>
The upload's ARN.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Syntax
<a name="API_GetUpload_ResponseSyntax"></a>

```
{
   "upload": { 
      "arn": "string",
      "category": "string",
      "contentType": "string",
      "created": number,
      "message": "string",
      "metadata": "string",
      "name": "string",
      "status": "string",
      "type": "string",
      "url": "string"
   }
}
```

## Response Elements
<a name="API_GetUpload_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [upload](#API_GetUpload_ResponseSyntax) **   <a name="devicefarm-GetUpload-response-upload"></a>
An app or a set of one or more tests to upload or that have been uploaded.  
Type: [Upload](API_Upload.md) object

## Errors
<a name="API_GetUpload_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_GetUpload_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/GetUpload) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/GetUpload) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetUpload) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/GetUpload) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/GetUpload) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/GetUpload) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/GetUpload) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetUpload) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetUpload) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetUpload) 

# GetVPCEConfiguration
<a name="API_GetVPCEConfiguration"></a>

Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.

## Request Syntax
<a name="API_GetVPCEConfiguration_RequestSyntax"></a>

```
{
   "arn": "string"
}
```

## Request Parameters
<a name="API_GetVPCEConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_GetVPCEConfiguration_RequestSyntax) **   <a name="devicefarm-GetVPCEConfiguration-request-arn"></a>
The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to describe.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Syntax
<a name="API_GetVPCEConfiguration_ResponseSyntax"></a>

```
{
   "vpceConfiguration": { 
      "arn": "string",
      "serviceDnsName": "string",
      "vpceConfigurationDescription": "string",
      "vpceConfigurationName": "string",
      "vpceServiceName": "string"
   }
}
```

## Response Elements
<a name="API_GetVPCEConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [vpceConfiguration](#API_GetVPCEConfiguration_ResponseSyntax) **   <a name="devicefarm-GetVPCEConfiguration-response-vpceConfiguration"></a>
An object that contains information about your VPC endpoint configuration.  
Type: [VPCEConfiguration](API_VPCEConfiguration.md) object

## Errors
<a name="API_GetVPCEConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ArgumentException **   
An invalid argument was specified.    
 ** 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

## See Also
<a name="API_GetVPCEConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/GetVPCEConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/GetVPCEConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetVPCEConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/GetVPCEConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/GetVPCEConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/GetVPCEConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/GetVPCEConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetVPCEConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetVPCEConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetVPCEConfiguration) 

# InstallToRemoteAccessSession
<a name="API_InstallToRemoteAccessSession"></a>

Installs an application to the device in a remote access session. For Android applications, the file must be in .apk format. For iOS applications, the file must be in .ipa format.

## Request Syntax
<a name="API_InstallToRemoteAccessSession_RequestSyntax"></a>

```
{
   "appArn": "string",
   "remoteAccessSessionArn": "string"
}
```

## Request Parameters
<a name="API_InstallToRemoteAccessSession_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [appArn](#API_InstallToRemoteAccessSession_RequestSyntax) **   <a name="devicefarm-InstallToRemoteAccessSession-request-appArn"></a>
The ARN of the app about which you are requesting information.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [remoteAccessSessionArn](#API_InstallToRemoteAccessSession_RequestSyntax) **   <a name="devicefarm-InstallToRemoteAccessSession-request-remoteAccessSessionArn"></a>
The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Syntax
<a name="API_InstallToRemoteAccessSession_ResponseSyntax"></a>

```
{
   "appUpload": { 
      "arn": "string",
      "category": "string",
      "contentType": "string",
      "created": number,
      "message": "string",
      "metadata": "string",
      "name": "string",
      "status": "string",
      "type": "string",
      "url": "string"
   }
}
```

## Response Elements
<a name="API_InstallToRemoteAccessSession_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [appUpload](#API_InstallToRemoteAccessSession_ResponseSyntax) **   <a name="devicefarm-InstallToRemoteAccessSession-response-appUpload"></a>
An app to upload or that has been uploaded.  
Type: [Upload](API_Upload.md) object

## Errors
<a name="API_InstallToRemoteAccessSession_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_InstallToRemoteAccessSession_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/InstallToRemoteAccessSession) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/InstallToRemoteAccessSession) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/InstallToRemoteAccessSession) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/InstallToRemoteAccessSession) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/InstallToRemoteAccessSession) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/InstallToRemoteAccessSession) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/InstallToRemoteAccessSession) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/InstallToRemoteAccessSession) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/InstallToRemoteAccessSession) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/InstallToRemoteAccessSession) 

# ListArtifacts
<a name="API_ListArtifacts"></a>

Gets information about artifacts.

## Request Syntax
<a name="API_ListArtifacts_RequestSyntax"></a>

```
{
   "arn": "string",
   "nextToken": "string",
   "type": "string"
}
```

## Request Parameters
<a name="API_ListArtifacts_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_ListArtifacts_RequestSyntax) **   <a name="devicefarm-ListArtifacts-request-arn"></a>
The run, job, suite, or test ARN.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [nextToken](#API_ListArtifacts_RequestSyntax) **   <a name="devicefarm-ListArtifacts-request-nextToken"></a>
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Required: No

 ** [type](#API_ListArtifacts_RequestSyntax) **   <a name="devicefarm-ListArtifacts-request-type"></a>
The artifacts' type.  
Allowed values include:  
+ FILE
+ LOG
+ SCREENSHOT
Type: String  
Valid Values: `SCREENSHOT | FILE | LOG`   
Required: Yes

## Response Syntax
<a name="API_ListArtifacts_ResponseSyntax"></a>

```
{
   "artifacts": [ 
      { 
         "arn": "string",
         "extension": "string",
         "name": "string",
         "type": "string",
         "url": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListArtifacts_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [artifacts](#API_ListArtifacts_ResponseSyntax) **   <a name="devicefarm-ListArtifacts-response-artifacts"></a>
Information about the artifacts.  
Type: Array of [Artifact](API_Artifact.md) objects

 ** [nextToken](#API_ListArtifacts_ResponseSyntax) **   <a name="devicefarm-ListArtifacts-response-nextToken"></a>
If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.

## Errors
<a name="API_ListArtifacts_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_ListArtifacts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/ListArtifacts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/ListArtifacts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListArtifacts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/ListArtifacts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/ListArtifacts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/ListArtifacts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/ListArtifacts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListArtifacts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListArtifacts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListArtifacts) 

# ListDeviceInstances
<a name="API_ListDeviceInstances"></a>

Returns information about the private device instances associated with one or more AWS accounts.

## Request Syntax
<a name="API_ListDeviceInstances_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListDeviceInstances_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListDeviceInstances_RequestSyntax) **   <a name="devicefarm-ListDeviceInstances-request-maxResults"></a>
An integer that specifies the maximum number of items you want to return in the API response.  
Type: Integer  
Required: No

 ** [nextToken](#API_ListDeviceInstances_RequestSyntax) **   <a name="devicefarm-ListDeviceInstances-request-nextToken"></a>
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_ListDeviceInstances_ResponseSyntax"></a>

```
{
   "deviceInstances": [ 
      { 
         "arn": "string",
         "deviceArn": "string",
         "instanceProfile": { 
            "arn": "string",
            "description": "string",
            "excludeAppPackagesFromCleanup": [ "string" ],
            "name": "string",
            "packageCleanup": boolean,
            "rebootAfterUse": boolean
         },
         "labels": [ "string" ],
         "status": "string",
         "udid": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListDeviceInstances_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [deviceInstances](#API_ListDeviceInstances_ResponseSyntax) **   <a name="devicefarm-ListDeviceInstances-response-deviceInstances"></a>
An object that contains information about your device instances.  
Type: Array of [DeviceInstance](API_DeviceInstance.md) objects

 ** [nextToken](#API_ListDeviceInstances_ResponseSyntax) **   <a name="devicefarm-ListDeviceInstances-response-nextToken"></a>
An identifier that can be used in the next call to this operation to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.

## Errors
<a name="API_ListDeviceInstances_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_ListDeviceInstances_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/ListDeviceInstances) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/ListDeviceInstances) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListDeviceInstances) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/ListDeviceInstances) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/ListDeviceInstances) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/ListDeviceInstances) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/ListDeviceInstances) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListDeviceInstances) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListDeviceInstances) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListDeviceInstances) 

# ListDevicePools
<a name="API_ListDevicePools"></a>

Gets information about device pools.

## Request Syntax
<a name="API_ListDevicePools_RequestSyntax"></a>

```
{
   "arn": "string",
   "nextToken": "string",
   "type": "string"
}
```

## Request Parameters
<a name="API_ListDevicePools_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_ListDevicePools_RequestSyntax) **   <a name="devicefarm-ListDevicePools-request-arn"></a>
The project ARN.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [nextToken](#API_ListDevicePools_RequestSyntax) **   <a name="devicefarm-ListDevicePools-request-nextToken"></a>
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Required: No

 ** [type](#API_ListDevicePools_RequestSyntax) **   <a name="devicefarm-ListDevicePools-request-type"></a>
The device pools' type.  
Allowed values include:  
+ CURATED: A device pool that is created and managed by AWS Device Farm.
+ PRIVATE: A device pool that is created and managed by the device pool developer.
Type: String  
Valid Values: `CURATED | PRIVATE`   
Required: No

## Response Syntax
<a name="API_ListDevicePools_ResponseSyntax"></a>

```
{
   "devicePools": [ 
      { 
         "arn": "string",
         "description": "string",
         "maxDevices": number,
         "name": "string",
         "rules": [ 
            { 
               "attribute": "string",
               "operator": "string",
               "value": "string"
            }
         ],
         "type": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListDevicePools_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [devicePools](#API_ListDevicePools_ResponseSyntax) **   <a name="devicefarm-ListDevicePools-response-devicePools"></a>
Information about the device pools.  
Type: Array of [DevicePool](API_DevicePool.md) objects

 ** [nextToken](#API_ListDevicePools_ResponseSyntax) **   <a name="devicefarm-ListDevicePools-response-nextToken"></a>
If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.

## Errors
<a name="API_ListDevicePools_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_ListDevicePools_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/ListDevicePools) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/ListDevicePools) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListDevicePools) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/ListDevicePools) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/ListDevicePools) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/ListDevicePools) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/ListDevicePools) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListDevicePools) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListDevicePools) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListDevicePools) 

# ListDevices
<a name="API_ListDevices"></a>

Gets information about unique device types.

## Request Syntax
<a name="API_ListDevices_RequestSyntax"></a>

```
{
   "arn": "string",
   "filters": [ 
      { 
         "attribute": "string",
         "operator": "string",
         "values": [ "string" ]
      }
   ],
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListDevices_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_ListDevices_RequestSyntax) **   <a name="devicefarm-ListDevices-request-arn"></a>
The Amazon Resource Name (ARN) of the project.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: No

 ** [filters](#API_ListDevices_RequestSyntax) **   <a name="devicefarm-ListDevices-request-filters"></a>
Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.  
+ Attribute: The aspect of a device such as platform or model used as the selection criteria in a device filter.

  Allowed values include:
  + ARN: The Amazon Resource Name (ARN) of the device (for example, `arn:aws:devicefarm:us-west-2::device:12345Example`).
  + PLATFORM: The device platform. Valid values are ANDROID or IOS.
  + OS\$1VERSION: The operating system version (for example, 10.3.2).
  + MODEL: The device model (for example, iPad 5th Gen).
  + AVAILABILITY: The current availability of the device. Valid values are AVAILABLE, HIGHLY\$1AVAILABLE, BUSY, or TEMPORARY\$1NOT\$1AVAILABLE.
  + FORM\$1FACTOR: The device form factor. Valid values are PHONE or TABLET.
  + MANUFACTURER: The device manufacturer (for example, Apple).
  + REMOTE\$1ACCESS\$1ENABLED: Whether the device is enabled for remote access. Valid values are TRUE or FALSE.
  + REMOTE\$1DEBUG\$1ENABLED: Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE. Because remote debugging is [no longer supported](https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html), this attribute is ignored.
  + INSTANCE\$1ARN: The Amazon Resource Name (ARN) of the device instance.
  + INSTANCE\$1LABELS: The label of the device instance.
  + FLEET\$1TYPE: The fleet type. Valid values are PUBLIC or PRIVATE.
+ Operator: The filter operator.
  + The EQUALS operator is available for every attribute except INSTANCE\$1LABELS.
  + The CONTAINS operator is available for the INSTANCE\$1LABELS and MODEL attributes.
  + The IN and NOT\$1IN operators are available for the ARN, OS\$1VERSION, MODEL, MANUFACTURER, and INSTANCE\$1ARN attributes.
  + The LESS\$1THAN, GREATER\$1THAN, LESS\$1THAN\$1OR\$1EQUALS, and GREATER\$1THAN\$1OR\$1EQUALS operators are also available for the OS\$1VERSION attribute.
+ Values: An array of one or more filter values.
  + The IN and NOT\$1IN operators take a values array that has one or more elements.
  + The other operators require an array with a single element.
  + In a request, the AVAILABILITY attribute takes the following values: AVAILABLE, HIGHLY\$1AVAILABLE, BUSY, or TEMPORARY\$1NOT\$1AVAILABLE.
Type: Array of [DeviceFilter](API_DeviceFilter.md) objects  
Required: No

 ** [nextToken](#API_ListDevices_RequestSyntax) **   <a name="devicefarm-ListDevices-request-nextToken"></a>
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_ListDevices_ResponseSyntax"></a>

```
{
   "devices": [ 
      { 
         "arn": "string",
         "availability": "string",
         "carrier": "string",
         "cpu": { 
            "architecture": "string",
            "clock": number,
            "frequency": "string"
         },
         "fleetName": "string",
         "fleetType": "string",
         "formFactor": "string",
         "heapSize": number,
         "image": "string",
         "instances": [ 
            { 
               "arn": "string",
               "deviceArn": "string",
               "instanceProfile": { 
                  "arn": "string",
                  "description": "string",
                  "excludeAppPackagesFromCleanup": [ "string" ],
                  "name": "string",
                  "packageCleanup": boolean,
                  "rebootAfterUse": boolean
               },
               "labels": [ "string" ],
               "status": "string",
               "udid": "string"
            }
         ],
         "manufacturer": "string",
         "memory": number,
         "model": "string",
         "modelId": "string",
         "name": "string",
         "os": "string",
         "platform": "string",
         "radio": "string",
         "remoteAccessEnabled": boolean,
         "remoteDebugEnabled": boolean,
         "resolution": { 
            "height": number,
            "width": number
         }
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListDevices_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [devices](#API_ListDevices_ResponseSyntax) **   <a name="devicefarm-ListDevices-response-devices"></a>
Information about the devices.  
Type: Array of [Device](API_Device.md) objects

 ** [nextToken](#API_ListDevices_ResponseSyntax) **   <a name="devicefarm-ListDevices-response-nextToken"></a>
If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.

## Errors
<a name="API_ListDevices_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_ListDevices_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/ListDevices) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/ListDevices) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListDevices) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/ListDevices) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/ListDevices) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/ListDevices) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/ListDevices) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListDevices) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListDevices) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListDevices) 

# ListInstanceProfiles
<a name="API_ListInstanceProfiles"></a>

Returns information about all the instance profiles in an AWS account.

## Request Syntax
<a name="API_ListInstanceProfiles_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListInstanceProfiles_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListInstanceProfiles_RequestSyntax) **   <a name="devicefarm-ListInstanceProfiles-request-maxResults"></a>
An integer that specifies the maximum number of items you want to return in the API response.  
Type: Integer  
Required: No

 ** [nextToken](#API_ListInstanceProfiles_RequestSyntax) **   <a name="devicefarm-ListInstanceProfiles-request-nextToken"></a>
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_ListInstanceProfiles_ResponseSyntax"></a>

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

## Response Elements
<a name="API_ListInstanceProfiles_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [instanceProfiles](#API_ListInstanceProfiles_ResponseSyntax) **   <a name="devicefarm-ListInstanceProfiles-response-instanceProfiles"></a>
An object that contains information about your instance profiles.  
Type: Array of [InstanceProfile](API_InstanceProfile.md) objects

 ** [nextToken](#API_ListInstanceProfiles_ResponseSyntax) **   <a name="devicefarm-ListInstanceProfiles-response-nextToken"></a>
An identifier that can be used in the next call to this operation to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.

## Errors
<a name="API_ListInstanceProfiles_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_ListInstanceProfiles_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/ListInstanceProfiles) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/ListInstanceProfiles) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListInstanceProfiles) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/ListInstanceProfiles) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/ListInstanceProfiles) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/ListInstanceProfiles) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/ListInstanceProfiles) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListInstanceProfiles) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListInstanceProfiles) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListInstanceProfiles) 

# ListJobs
<a name="API_ListJobs"></a>

Gets information about jobs for a given test run.

## Request Syntax
<a name="API_ListJobs_RequestSyntax"></a>

```
{
   "arn": "string",
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListJobs_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_ListJobs_RequestSyntax) **   <a name="devicefarm-ListJobs-request-arn"></a>
The run's Amazon Resource Name (ARN).  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [nextToken](#API_ListJobs_RequestSyntax) **   <a name="devicefarm-ListJobs-request-nextToken"></a>
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_ListJobs_ResponseSyntax"></a>

```
{
   "jobs": [ 
      { 
         "arn": "string",
         "counters": { 
            "errored": number,
            "failed": number,
            "passed": number,
            "skipped": number,
            "stopped": number,
            "total": number,
            "warned": number
         },
         "created": number,
         "device": { 
            "arn": "string",
            "availability": "string",
            "carrier": "string",
            "cpu": { 
               "architecture": "string",
               "clock": number,
               "frequency": "string"
            },
            "fleetName": "string",
            "fleetType": "string",
            "formFactor": "string",
            "heapSize": number,
            "image": "string",
            "instances": [ 
               { 
                  "arn": "string",
                  "deviceArn": "string",
                  "instanceProfile": { 
                     "arn": "string",
                     "description": "string",
                     "excludeAppPackagesFromCleanup": [ "string" ],
                     "name": "string",
                     "packageCleanup": boolean,
                     "rebootAfterUse": boolean
                  },
                  "labels": [ "string" ],
                  "status": "string",
                  "udid": "string"
               }
            ],
            "manufacturer": "string",
            "memory": number,
            "model": "string",
            "modelId": "string",
            "name": "string",
            "os": "string",
            "platform": "string",
            "radio": "string",
            "remoteAccessEnabled": boolean,
            "remoteDebugEnabled": boolean,
            "resolution": { 
               "height": number,
               "width": number
            }
         },
         "deviceMinutes": { 
            "metered": number,
            "total": number,
            "unmetered": number
         },
         "instanceArn": "string",
         "message": "string",
         "name": "string",
         "result": "string",
         "started": number,
         "status": "string",
         "stopped": number,
         "type": "string",
         "videoCapture": boolean,
         "videoEndpoint": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListJobs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [jobs](#API_ListJobs_ResponseSyntax) **   <a name="devicefarm-ListJobs-response-jobs"></a>
Information about the jobs.  
Type: Array of [Job](API_Job.md) objects

 ** [nextToken](#API_ListJobs_ResponseSyntax) **   <a name="devicefarm-ListJobs-response-nextToken"></a>
If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.

## Errors
<a name="API_ListJobs_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_ListJobs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/ListJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/ListJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/ListJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/ListJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/ListJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/ListJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListJobs) 

# ListNetworkProfiles
<a name="API_ListNetworkProfiles"></a>

Returns the list of available network profiles.

## Request Syntax
<a name="API_ListNetworkProfiles_RequestSyntax"></a>

```
{
   "arn": "string",
   "nextToken": "string",
   "type": "string"
}
```

## Request Parameters
<a name="API_ListNetworkProfiles_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_ListNetworkProfiles_RequestSyntax) **   <a name="devicefarm-ListNetworkProfiles-request-arn"></a>
The Amazon Resource Name (ARN) of the project for which you want to list network profiles.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [nextToken](#API_ListNetworkProfiles_RequestSyntax) **   <a name="devicefarm-ListNetworkProfiles-request-nextToken"></a>
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Required: No

 ** [type](#API_ListNetworkProfiles_RequestSyntax) **   <a name="devicefarm-ListNetworkProfiles-request-type"></a>
The type of network profile to return information about. Valid values are listed here.  
Type: String  
Valid Values: `CURATED | PRIVATE`   
Required: No

## Response Syntax
<a name="API_ListNetworkProfiles_ResponseSyntax"></a>

```
{
   "networkProfiles": [ 
      { 
         "arn": "string",
         "description": "string",
         "downlinkBandwidthBits": number,
         "downlinkDelayMs": number,
         "downlinkJitterMs": number,
         "downlinkLossPercent": number,
         "name": "string",
         "type": "string",
         "uplinkBandwidthBits": number,
         "uplinkDelayMs": number,
         "uplinkJitterMs": number,
         "uplinkLossPercent": number
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListNetworkProfiles_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [networkProfiles](#API_ListNetworkProfiles_ResponseSyntax) **   <a name="devicefarm-ListNetworkProfiles-response-networkProfiles"></a>
A list of the available network profiles.  
Type: Array of [NetworkProfile](API_NetworkProfile.md) objects

 ** [nextToken](#API_ListNetworkProfiles_ResponseSyntax) **   <a name="devicefarm-ListNetworkProfiles-response-nextToken"></a>
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.

## Errors
<a name="API_ListNetworkProfiles_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_ListNetworkProfiles_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/ListNetworkProfiles) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/ListNetworkProfiles) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListNetworkProfiles) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/ListNetworkProfiles) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/ListNetworkProfiles) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/ListNetworkProfiles) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/ListNetworkProfiles) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListNetworkProfiles) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListNetworkProfiles) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListNetworkProfiles) 

# ListOfferingPromotions
<a name="API_ListOfferingPromotions"></a>

Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a `NotEligible` error if the caller is not permitted to invoke the operation. Contact [aws-devicefarm-support@amazon.com](mailto:aws-devicefarm-support@amazon.com) if you must be able to invoke this operation.

## Request Syntax
<a name="API_ListOfferingPromotions_RequestSyntax"></a>

```
{
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListOfferingPromotions_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [nextToken](#API_ListOfferingPromotions_RequestSyntax) **   <a name="devicefarm-ListOfferingPromotions-request-nextToken"></a>
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_ListOfferingPromotions_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "offeringPromotions": [ 
      { 
         "description": "string",
         "id": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListOfferingPromotions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListOfferingPromotions_ResponseSyntax) **   <a name="devicefarm-ListOfferingPromotions-response-nextToken"></a>
An identifier to be used in the next call to this operation, to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.

 ** [offeringPromotions](#API_ListOfferingPromotions_ResponseSyntax) **   <a name="devicefarm-ListOfferingPromotions-response-offeringPromotions"></a>
Information about the offering promotions.  
Type: Array of [OfferingPromotion](API_OfferingPromotion.md) objects

## Errors
<a name="API_ListOfferingPromotions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** NotEligibleException **   
Exception gets thrown when a user is not eligible to perform the specified transaction.    
 ** message **   
The HTTP response code of a Not Eligible 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

## See Also
<a name="API_ListOfferingPromotions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/ListOfferingPromotions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/ListOfferingPromotions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListOfferingPromotions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/ListOfferingPromotions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/ListOfferingPromotions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/ListOfferingPromotions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/ListOfferingPromotions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListOfferingPromotions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListOfferingPromotions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListOfferingPromotions) 

# ListOfferings
<a name="API_ListOfferings"></a>

Returns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the frequency for that offering. The API returns a `NotEligible` error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact [aws-devicefarm-support@amazon.com](mailto:aws-devicefarm-support@amazon.com).

## Request Syntax
<a name="API_ListOfferings_RequestSyntax"></a>

```
{
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListOfferings_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [nextToken](#API_ListOfferings_RequestSyntax) **   <a name="devicefarm-ListOfferings-request-nextToken"></a>
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_ListOfferings_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "offerings": [ 
      { 
         "description": "string",
         "id": "string",
         "platform": "string",
         "recurringCharges": [ 
            { 
               "cost": { 
                  "amount": number,
                  "currencyCode": "string"
               },
               "frequency": "string"
            }
         ],
         "type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListOfferings_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListOfferings_ResponseSyntax) **   <a name="devicefarm-ListOfferings-response-nextToken"></a>
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.

 ** [offerings](#API_ListOfferings_ResponseSyntax) **   <a name="devicefarm-ListOfferings-response-offerings"></a>
A value that represents the list offering results.  
Type: Array of [Offering](API_Offering.md) objects

## Errors
<a name="API_ListOfferings_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** NotEligibleException **   
Exception gets thrown when a user is not eligible to perform the specified transaction.    
 ** message **   
The HTTP response code of a Not Eligible 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

## Examples
<a name="API_ListOfferings_Examples"></a>

### Example
<a name="API_ListOfferings_Example_1"></a>

The following example response shows a list of device offerings for the user's account.

#### Sample Response
<a name="API_ListOfferings_Example_1_Response"></a>

```
{
    "offerings": [
        {
           "recurringCharges": [
               {
                   "cost": {
                       "amount": 250.0,
                       "currencyCode": "USD"
                   },
                   "frequency": "MONTHLY"
               }
           ],
           "platform": "IOS",
           "type": "RECURRING",
           "id": "offering-id-ios",
           "description": "iOS Unmetered Device Slot"
       },
       {
           "recurringCharges": [
               {
                   "cost": {
                       "amount": 250.0,
                       "currencyCode": "USD"
                   },
                  "frequency": "MONTHLY"
                }
            ],
           "platform": "ANDROID",
           "type": "RECURRING",
           "id": "offering-id-android",
           "description": "Android Unmetered Device Slot"
        }
    ]
}
```

## See Also
<a name="API_ListOfferings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/ListOfferings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/ListOfferings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListOfferings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/ListOfferings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/ListOfferings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/ListOfferings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/ListOfferings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListOfferings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListOfferings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListOfferings) 

# ListOfferingTransactions
<a name="API_ListOfferingTransactions"></a>

Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account. The list is paginated and ordered by a descending timestamp (most recent transactions are first). The API returns a `NotEligible` error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact [aws-devicefarm-support@amazon.com](mailto:aws-devicefarm-support@amazon.com).

## Request Syntax
<a name="API_ListOfferingTransactions_RequestSyntax"></a>

```
{
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListOfferingTransactions_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [nextToken](#API_ListOfferingTransactions_RequestSyntax) **   <a name="devicefarm-ListOfferingTransactions-request-nextToken"></a>
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_ListOfferingTransactions_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "offeringTransactions": [ 
      { 
         "cost": { 
            "amount": number,
            "currencyCode": "string"
         },
         "createdOn": number,
         "offeringPromotionId": "string",
         "offeringStatus": { 
            "effectiveOn": number,
            "offering": { 
               "description": "string",
               "id": "string",
               "platform": "string",
               "recurringCharges": [ 
                  { 
                     "cost": { 
                        "amount": number,
                        "currencyCode": "string"
                     },
                     "frequency": "string"
                  }
               ],
               "type": "string"
            },
            "quantity": number,
            "type": "string"
         },
         "transactionId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListOfferingTransactions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListOfferingTransactions_ResponseSyntax) **   <a name="devicefarm-ListOfferingTransactions-response-nextToken"></a>
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.

 ** [offeringTransactions](#API_ListOfferingTransactions_ResponseSyntax) **   <a name="devicefarm-ListOfferingTransactions-response-offeringTransactions"></a>
The audit log of subscriptions you have purchased and modified through AWS Device Farm.  
Type: Array of [OfferingTransaction](API_OfferingTransaction.md) objects

## Errors
<a name="API_ListOfferingTransactions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** NotEligibleException **   
Exception gets thrown when a user is not eligible to perform the specified transaction.    
 ** message **   
The HTTP response code of a Not Eligible 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

## Examples
<a name="API_ListOfferingTransactions_Examples"></a>

### Example
<a name="API_ListOfferingTransactions_Example_1"></a>

The following example response contains all the transactions that the customer has made. 

#### Sample Response
<a name="API_ListOfferingTransactions_Example_1_Response"></a>

```
{
    "offeringTransactions": [
        {
            "createdOn": 1458596241.001, 
            "offeringStatus": {
                "effectiveOn": 1458596240.974, 
                "type": "PURCHASE", 
                "offering": {
                    "platform": "IOS", 
                    "type": "RECURRING", 
                    "id": "offering-id-ios", 
                    "description": "iOS Unmetered Device Slot"
                }, 
                "quantity": 1
            }, 
            "cost": {
                "amount": 80.65, 
                "currencyCode": "USD"
            }, 
            "transactionId": "transaction-id"
        }, 
        {
            "createdOn": 1458587590.308, 
            "offeringStatus": {
                "effectiveOn": 1458587590.24, 
                "type": "PURCHASE", 
                "offering": {
                    "platform": "IOS", 
                    "type": "RECURRING", 
                    "id": "offering-id-ios", 
                    "description": "iOS Unmetered Device Slot"
                }, 
                "quantity": 1
            }, 
            "cost": {
                "amount": 80.65, 
                "currencyCode": "USD"
            }, 
            "transactionId": "transaction-id"
        }, 
        {
            "createdOn": 1458541943.395, 
            "offeringStatus": {
                "effectiveOn": 1458541943.34, 
                "type": "PURCHASE", 
                "offering": {
                    "platform": "ANDROID", 
                    "type": "RECURRING", 
                    "id": "offering-id-android", 
                    "description": "Android Unmetered Device Slot"
                }, 
                "quantity": 10
            }, 
            "cost": {
                "amount": 806.45, 
                "currencyCode": "USD"
            }, 
            "transactionId": "transaction-id"
        }, 
        {
            "createdOn": 1458584276.849, 
            "offeringStatus": {
                "effectiveOn": 1458584276.811, 
                "type": "PURCHASE", 
                "offering": {
                    "platform": "ANDROID", 
                    "type": "RECURRING", 
                    "id": "offering-id-android", 
                    "description": "Android Unmetered Device Slot"
                }, 
                "quantity": 2
            }, 
            "cost": {
                "amount": 161.29, 
                "currencyCode": "USD"
            }, 
            "transactionId": "transaction-id"
        }, 
        {
            "createdOn": 1458592981.171, 
            "offeringStatus": {
                "effectiveOn": 1458592981.137, 
                "type": "PURCHASE", 
                "offering": {
                    "platform": "IOS", 
                    "type": "RECURRING", 
                    "id": "offering-id-ios", 
                    "description": "iOS Unmetered Device Slot"
                }, 
                "quantity": 1
            }, 
            "cost": {
                "amount": 80.65, 
                "currencyCode": "USD"
            }, 
            "transactionId": "transaction-id"
        }, 
        {
            "createdOn": 1458591927.511, 
            "offeringStatus": {
                "effectiveOn": 1458591927.468, 
                "type": "PURCHASE", 
                "offering": {
                    "platform": "IOS", 
                    "type": "RECURRING", 
                    "id": "offering-id-ios", 
                    "description": "iOS Unmetered Device Slot"
                }, 
                "quantity": 1
            }, 
            "cost": {
                "amount": 80.65, 
                "currencyCode": "USD"
            }, 
            "transactionId": "transaction-id"
        }, 
        {
            "createdOn": 1458581880.117, 
            "offeringStatus": {
                "effectiveOn": 1459468800.0, 
                "type": "RENEW", 
                "offering": {
                    "platform": "IOS", 
                    "type": "RECURRING", 
                    "id": "offering-id-ios", 
                    "description": "iOS Unmetered Device Slot"
                }, 
                "quantity": 0
            }, 
            "cost": {
                "amount": 0.0, 
                "currencyCode": "USD"
            }, 
            "transactionId": "transaction-id"
        }, 
        {
            "createdOn": 1458587390.031, 
            "offeringStatus": {
                "effectiveOn": 1458587390.008, 
                "type": "PURCHASE", 
                "offering": {
                    "platform": "ANDROID", 
                    "type": "RECURRING", 
                    "id": "offering-id-android", 
                    "description": "Android Unmetered Device Slot"
                }, 
                "quantity": 1
            }, 
            "cost": {
                "amount": 80.65, 
                "currencyCode": "USD"
            }, 
            "transactionId": "transaction-id"
        }, 
        {
            "createdOn": 1458591927.99, 
            "offeringStatus": {
                "effectiveOn": 1459468800.0, 
                "type": "RENEW", 
                "offering": {
                    "platform": "ANDROID", 
                    "type": "RECURRING", 
                    "id": "offering-id-android", 
                    "description": "Android Unmetered Device Slot"
                }, 
                "quantity": 3
            }, 
            "cost": {
                "amount": 750.0, 
                "currencyCode": "USD"
            }, 
            "transactionId": "transaction-id"
        }, 
        {
            "createdOn": 1458581580.426, 
            "offeringStatus": {
                "effectiveOn": 1458581580.377, 
                "type": "PURCHASE", 
                "offering": {
                    "platform": "ANDROID", 
                    "type": "RECURRING", 
                    "id": "offering-id-android", 
                    "description": "Android Unmetered Device Slot"
                }, 
                "quantity": 1
            }, 
            "cost": {
                "amount": 80.65, 
                "currencyCode": "USD"
            }, 
            "transactionId": "transaction-id"
        }, 
        {
            "createdOn": 1458582235.794, 
            "offeringStatus": {
                "effectiveOn": 1459468800.0, 
                "type": "RENEW", 
                "offering": {
                    "platform": "ANDROID", 
                    "type": "RECURRING", 
                    "id": "offering-id-android", 
                    "description": "Android Unmetered Device Slot"
                }, 
                "quantity": 1
            }, 
            "cost": {
                "amount": 250.0, 
                "currencyCode": "USD"
            }, 
            "transactionId": "transaction-id"
        }, 
        {
            "createdOn": 1458581580.429, 
            "offeringStatus": {
                "effectiveOn": 1458581580.372, 
                "type": "PURCHASE", 
                "offering": {
                    "platform": "IOS", 
                    "type": "RECURRING", 
                    "id": "offering-id-ios", 
                    "description": "iOS Unmetered Device Slot"
                }, 
                "quantity": 1
            }, 
            "cost": {
                "amount": 80.65, 
                "currencyCode": "USD"
            }, 
            "transactionId": "transaction-id"
        }, 
        {
            "createdOn": 1458593014.881, 
            "offeringStatus": {
                "effectiveOn": 1458593014.856, 
                "type": "PURCHASE", 
                "offering": {
                    "platform": "IOS", 
                    "type": "RECURRING", 
                    "id": "offering-id-ios", 
                    "description": "iOS Unmetered Device Slot"
                }, 
                "quantity": 2
            }, 
            "cost": {
                "amount": 161.29, 
                "currencyCode": "USD"
            }, 
            "transactionId": "transaction-id"
        }, 
        {
            "createdOn": 1458581880.415, 
            "offeringStatus": {
                "effectiveOn": 1459468800.0, 
                "type": "RENEW", 
                "offering": {
                    "platform": "ANDROID", 
                    "type": "RECURRING", 
                    "id": "offering-id-android", 
                    "description": "Android Unmetered Device Slot"
                }, 
                "quantity": 0
            }, 
            "cost": {
                "amount": 0.0, 
                "currencyCode": "USD"
            }, 
            "transactionId": "transaction-id"
        }, 
        {
            "createdOn": 1458591927.662, 
            "offeringStatus": {
                "effectiveOn": 1458591927.491, 
                "type": "PURCHASE", 
                "offering": {
                    "platform": "ANDROID", 
                    "type": "RECURRING", 
                    "id": "offering-id-android", 
                    "description": "Android Unmetered Device Slot"
                }, 
                "quantity": 1
            }, 
            "cost": {
                "amount": 80.65, 
                "currencyCode": "USD"
            }, 
            "transactionId": "transaction-id"
        }, 
        {
            "createdOn": 1458582235.834, 
            "offeringStatus": {
                "effectiveOn": 1459468800.0, 
                "type": "RENEW", 
                "offering": {
                    "platform": "IOS", 
                    "type": "RECURRING", 
                    "id": "offering-id-ios", 
                    "description": "iOS Unmetered Device Slot"
                }, 
                "quantity": 1
            }, 
            "cost": {
                "amount": 250.0, 
                "currencyCode": "USD"
            }, 
            "transactionId": "transaction-id"
        }, 
        {
            "createdOn": 1458583642.184, 
            "offeringStatus": {
                "effectiveOn": 1459468800.0, 
                "type": "RENEW", 
                "offering": {
                    "platform": "IOS", 
                    "type": "RECURRING", 
                    "id": "offering-id-ios", 
                    "description": "iOS Unmetered Device Slot"
                }, 
                "quantity": 0
            }, 
            "cost": {
                "amount": 0.0, 
                "currencyCode": "USD"
            }, 
            "transactionId": "transaction-id"
        }, 
        {
            "createdOn": 1458581880.007, 
            "offeringStatus": {
                "effectiveOn": 1458581879.937, 
                "type": "PURCHASE", 
                "offering": {
                    "platform": "ANDROID", 
                    "type": "RECURRING", 
                    "id": "offering-id-android", 
                    "description": "Android Unmetered Device Slot"
                }, 
                "quantity": 1
            }, 
            "cost": {
                "amount": 80.65, 
                "currencyCode": "USD"
            }, 
            "transactionId": "transaction-id"
        }
    ]
}
```

## See Also
<a name="API_ListOfferingTransactions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/ListOfferingTransactions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/ListOfferingTransactions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListOfferingTransactions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/ListOfferingTransactions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/ListOfferingTransactions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/ListOfferingTransactions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/ListOfferingTransactions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListOfferingTransactions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListOfferingTransactions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListOfferingTransactions) 

# ListProjects
<a name="API_ListProjects"></a>

Gets information about projects.

## Request Syntax
<a name="API_ListProjects_RequestSyntax"></a>

```
{
   "arn": "string",
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListProjects_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_ListProjects_RequestSyntax) **   <a name="devicefarm-ListProjects-request-arn"></a>
Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device Farm returns a list of all projects for the AWS account. You can also specify a project ARN.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: No

 ** [nextToken](#API_ListProjects_RequestSyntax) **   <a name="devicefarm-ListProjects-request-nextToken"></a>
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_ListProjects_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "projects": [ 
      { 
         "arn": "string",
         "created": number,
         "defaultJobTimeoutMinutes": number,
         "environmentVariables": [ 
            { 
               "name": "string",
               "value": "string"
            }
         ],
         "executionRoleArn": "string",
         "name": "string",
         "vpcConfig": { 
            "securityGroupIds": [ "string" ],
            "subnetIds": [ "string" ],
            "vpcId": "string"
         }
      }
   ]
}
```

## Response Elements
<a name="API_ListProjects_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListProjects_ResponseSyntax) **   <a name="devicefarm-ListProjects-response-nextToken"></a>
If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.

 ** [projects](#API_ListProjects_ResponseSyntax) **   <a name="devicefarm-ListProjects-response-projects"></a>
Information about the projects.  
Type: Array of [Project](API_Project.md) objects

## Errors
<a name="API_ListProjects_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_ListProjects_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/ListProjects) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/ListProjects) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListProjects) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/ListProjects) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/ListProjects) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/ListProjects) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/ListProjects) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListProjects) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListProjects) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListProjects) 

# ListRemoteAccessSessions
<a name="API_ListRemoteAccessSessions"></a>

Returns a list of all currently running remote access sessions.

## Request Syntax
<a name="API_ListRemoteAccessSessions_RequestSyntax"></a>

```
{
   "arn": "string",
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListRemoteAccessSessions_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_ListRemoteAccessSessions_RequestSyntax) **   <a name="devicefarm-ListRemoteAccessSessions-request-arn"></a>
The Amazon Resource Name (ARN) of the project about which you are requesting information.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [nextToken](#API_ListRemoteAccessSessions_RequestSyntax) **   <a name="devicefarm-ListRemoteAccessSessions-request-nextToken"></a>
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_ListRemoteAccessSessions_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "remoteAccessSessions": [ 
      { 
         "appUpload": "string",
         "arn": "string",
         "billingMethod": "string",
         "created": number,
         "device": { 
            "arn": "string",
            "availability": "string",
            "carrier": "string",
            "cpu": { 
               "architecture": "string",
               "clock": number,
               "frequency": "string"
            },
            "fleetName": "string",
            "fleetType": "string",
            "formFactor": "string",
            "heapSize": number,
            "image": "string",
            "instances": [ 
               { 
                  "arn": "string",
                  "deviceArn": "string",
                  "instanceProfile": { 
                     "arn": "string",
                     "description": "string",
                     "excludeAppPackagesFromCleanup": [ "string" ],
                     "name": "string",
                     "packageCleanup": boolean,
                     "rebootAfterUse": boolean
                  },
                  "labels": [ "string" ],
                  "status": "string",
                  "udid": "string"
               }
            ],
            "manufacturer": "string",
            "memory": number,
            "model": "string",
            "modelId": "string",
            "name": "string",
            "os": "string",
            "platform": "string",
            "radio": "string",
            "remoteAccessEnabled": boolean,
            "remoteDebugEnabled": boolean,
            "resolution": { 
               "height": number,
               "width": number
            }
         },
         "deviceMinutes": { 
            "metered": number,
            "total": number,
            "unmetered": number
         },
         "deviceProxy": { 
            "host": "string",
            "port": number
         },
         "deviceUdid": "string",
         "endpoint": "string",
         "endpoints": { 
            "interactiveEndpoint": "string",
            "remoteDriverEndpoint": "string"
         },
         "instanceArn": "string",
         "interactionMode": "string",
         "message": "string",
         "name": "string",
         "result": "string",
         "skipAppResign": boolean,
         "started": number,
         "status": "string",
         "stopped": number,
         "vpcConfig": { 
            "securityGroupIds": [ "string" ],
            "subnetIds": [ "string" ],
            "vpcId": "string"
         }
      }
   ]
}
```

## Response Elements
<a name="API_ListRemoteAccessSessions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListRemoteAccessSessions_ResponseSyntax) **   <a name="devicefarm-ListRemoteAccessSessions-response-nextToken"></a>
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.

 ** [remoteAccessSessions](#API_ListRemoteAccessSessions_ResponseSyntax) **   <a name="devicefarm-ListRemoteAccessSessions-response-remoteAccessSessions"></a>
A container that represents the metadata from the service about each remote access session you are requesting.  
Type: Array of [RemoteAccessSession](API_RemoteAccessSession.md) objects

## Errors
<a name="API_ListRemoteAccessSessions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_ListRemoteAccessSessions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/ListRemoteAccessSessions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/ListRemoteAccessSessions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListRemoteAccessSessions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/ListRemoteAccessSessions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/ListRemoteAccessSessions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/ListRemoteAccessSessions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/ListRemoteAccessSessions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListRemoteAccessSessions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListRemoteAccessSessions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListRemoteAccessSessions) 

# ListRuns
<a name="API_ListRuns"></a>

Gets information about runs, given an AWS Device Farm project ARN.

## Request Syntax
<a name="API_ListRuns_RequestSyntax"></a>

```
{
   "arn": "string",
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListRuns_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_ListRuns_RequestSyntax) **   <a name="devicefarm-ListRuns-request-arn"></a>
The Amazon Resource Name (ARN) of the project for which you want to list runs.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [nextToken](#API_ListRuns_RequestSyntax) **   <a name="devicefarm-ListRuns-request-nextToken"></a>
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_ListRuns_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "runs": [ 
      { 
         "appUpload": "string",
         "arn": "string",
         "billingMethod": "string",
         "completedJobs": number,
         "counters": { 
            "errored": number,
            "failed": number,
            "passed": number,
            "skipped": number,
            "stopped": number,
            "total": number,
            "warned": number
         },
         "created": number,
         "customerArtifactPaths": { 
            "androidPaths": [ "string" ],
            "deviceHostPaths": [ "string" ],
            "iosPaths": [ "string" ]
         },
         "deviceMinutes": { 
            "metered": number,
            "total": number,
            "unmetered": number
         },
         "devicePoolArn": "string",
         "deviceProxy": { 
            "host": "string",
            "port": number
         },
         "deviceSelectionResult": { 
            "filters": [ 
               { 
                  "attribute": "string",
                  "operator": "string",
                  "values": [ "string" ]
               }
            ],
            "matchedDevicesCount": number,
            "maxDevices": number
         },
         "environmentVariables": [ 
            { 
               "name": "string",
               "value": "string"
            }
         ],
         "eventCount": number,
         "executionRoleArn": "string",
         "jobTimeoutMinutes": number,
         "locale": "string",
         "location": { 
            "latitude": number,
            "longitude": number
         },
         "message": "string",
         "name": "string",
         "networkProfile": { 
            "arn": "string",
            "description": "string",
            "downlinkBandwidthBits": number,
            "downlinkDelayMs": number,
            "downlinkJitterMs": number,
            "downlinkLossPercent": number,
            "name": "string",
            "type": "string",
            "uplinkBandwidthBits": number,
            "uplinkDelayMs": number,
            "uplinkJitterMs": number,
            "uplinkLossPercent": number
         },
         "parsingResultUrl": "string",
         "platform": "string",
         "radios": { 
            "bluetooth": boolean,
            "gps": boolean,
            "nfc": boolean,
            "wifi": boolean
         },
         "result": "string",
         "resultCode": "string",
         "seed": number,
         "skipAppResign": boolean,
         "started": number,
         "status": "string",
         "stopped": number,
         "testSpecArn": "string",
         "totalJobs": number,
         "type": "string",
         "vpcConfig": { 
            "securityGroupIds": [ "string" ],
            "subnetIds": [ "string" ],
            "vpcId": "string"
         },
         "webUrl": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListRuns_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListRuns_ResponseSyntax) **   <a name="devicefarm-ListRuns-response-nextToken"></a>
If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.

 ** [runs](#API_ListRuns_ResponseSyntax) **   <a name="devicefarm-ListRuns-response-runs"></a>
Information about the runs.  
Type: Array of [Run](API_Run.md) objects

## Errors
<a name="API_ListRuns_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_ListRuns_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/ListRuns) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/ListRuns) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListRuns) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/ListRuns) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/ListRuns) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/ListRuns) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/ListRuns) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListRuns) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListRuns) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListRuns) 

# ListSamples
<a name="API_ListSamples"></a>

Gets information about samples, given an AWS Device Farm job ARN.

## Request Syntax
<a name="API_ListSamples_RequestSyntax"></a>

```
{
   "arn": "string",
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListSamples_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_ListSamples_RequestSyntax) **   <a name="devicefarm-ListSamples-request-arn"></a>
The Amazon Resource Name (ARN) of the job used to list samples.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [nextToken](#API_ListSamples_RequestSyntax) **   <a name="devicefarm-ListSamples-request-nextToken"></a>
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_ListSamples_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "samples": [ 
      { 
         "arn": "string",
         "type": "string",
         "url": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListSamples_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListSamples_ResponseSyntax) **   <a name="devicefarm-ListSamples-response-nextToken"></a>
If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.

 ** [samples](#API_ListSamples_ResponseSyntax) **   <a name="devicefarm-ListSamples-response-samples"></a>
Information about the samples.  
Type: Array of [Sample](API_Sample.md) objects

## Errors
<a name="API_ListSamples_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_ListSamples_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/ListSamples) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/ListSamples) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListSamples) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/ListSamples) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/ListSamples) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/ListSamples) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/ListSamples) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListSamples) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListSamples) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListSamples) 

# ListSuites
<a name="API_ListSuites"></a>

Gets information about test suites for a given job.

## Request Syntax
<a name="API_ListSuites_RequestSyntax"></a>

```
{
   "arn": "string",
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListSuites_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_ListSuites_RequestSyntax) **   <a name="devicefarm-ListSuites-request-arn"></a>
The job's Amazon Resource Name (ARN).  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [nextToken](#API_ListSuites_RequestSyntax) **   <a name="devicefarm-ListSuites-request-nextToken"></a>
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_ListSuites_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "suites": [ 
      { 
         "arn": "string",
         "counters": { 
            "errored": number,
            "failed": number,
            "passed": number,
            "skipped": number,
            "stopped": number,
            "total": number,
            "warned": number
         },
         "created": number,
         "deviceMinutes": { 
            "metered": number,
            "total": number,
            "unmetered": number
         },
         "message": "string",
         "name": "string",
         "result": "string",
         "started": number,
         "status": "string",
         "stopped": number,
         "type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListSuites_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListSuites_ResponseSyntax) **   <a name="devicefarm-ListSuites-response-nextToken"></a>
If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.

 ** [suites](#API_ListSuites_ResponseSyntax) **   <a name="devicefarm-ListSuites-response-suites"></a>
Information about the suites.  
Type: Array of [Suite](API_Suite.md) objects

## Errors
<a name="API_ListSuites_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_ListSuites_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/ListSuites) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/ListSuites) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListSuites) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/ListSuites) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/ListSuites) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/ListSuites) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/ListSuites) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListSuites) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListSuites) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListSuites) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

List the tags for an AWS Device Farm resource.

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
{
   "ResourceARN": "string"
}
```

## Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_ListTagsForResource_RequestSyntax) **   <a name="devicefarm-ListTagsForResource-request-ResourceARN"></a>
The Amazon Resource Name (ARN) of the resource or resources for which to list tags. You can associate tags with the following Device Farm resources: `PROJECT`, `TESTGRID_PROJECT`, `RUN`, `NETWORK_PROFILE`, `INSTANCE_PROFILE`, `DEVICE_INSTANCE`, `SESSION`, `DEVICE_POOL`, `DEVICE`, and `VPCE_CONFIGURATION`.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
{
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="devicefarm-ListTagsForResource-response-Tags"></a>
The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters. Tag values can have a maximum length of 256 characters.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 150 items.

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ArgumentException **   
An invalid argument was specified.    
 ** 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

 ** TagOperationException **   
The operation was not successful. Try again.  
HTTP Status Code: 400

## See Also
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListTagsForResource) 

# ListTestGridProjects
<a name="API_ListTestGridProjects"></a>

Gets a list of all Selenium testing projects in your account.

## Request Syntax
<a name="API_ListTestGridProjects_RequestSyntax"></a>

```
{
   "maxResult": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListTestGridProjects_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResult](#API_ListTestGridProjects_RequestSyntax) **   <a name="devicefarm-ListTestGridProjects-request-maxResult"></a>
Return no more than this number of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [nextToken](#API_ListTestGridProjects_RequestSyntax) **   <a name="devicefarm-ListTestGridProjects-request-nextToken"></a>
From a response, used to continue a paginated listing.   
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_ListTestGridProjects_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "testGridProjects": [ 
      { 
         "arn": "string",
         "created": number,
         "description": "string",
         "name": "string",
         "vpcConfig": { 
            "securityGroupIds": [ "string" ],
            "subnetIds": [ "string" ],
            "vpcId": "string"
         }
      }
   ]
}
```

## Response Elements
<a name="API_ListTestGridProjects_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListTestGridProjects_ResponseSyntax) **   <a name="devicefarm-ListTestGridProjects-response-nextToken"></a>
Used for pagination. Pass into [ListTestGridProjects](#API_ListTestGridProjects) to get more results in a paginated request.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.

 ** [testGridProjects](#API_ListTestGridProjects_ResponseSyntax) **   <a name="devicefarm-ListTestGridProjects-response-testGridProjects"></a>
The list of TestGridProjects, based on a [ListTestGridProjectsRequest](API_ListTestGridProjectsRequest.md).  
Type: Array of [TestGridProject](API_TestGridProject.md) objects

## Errors
<a name="API_ListTestGridProjects_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ArgumentException **   
An invalid argument was specified.    
 ** message **   
Any additional information about the exception.
HTTP Status Code: 400

 ** InternalServiceException **   
An internal exception was raised in the service. Contact [aws-devicefarm-support@amazon.com](mailto:aws-devicefarm-support@amazon.com) if you see this error.   
HTTP Status Code: 500

## See Also
<a name="API_ListTestGridProjects_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/ListTestGridProjects) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/ListTestGridProjects) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListTestGridProjects) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/ListTestGridProjects) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/ListTestGridProjects) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/ListTestGridProjects) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/ListTestGridProjects) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListTestGridProjects) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListTestGridProjects) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListTestGridProjects) 

# ListTestGridSessionActions
<a name="API_ListTestGridSessionActions"></a>

Returns a list of the actions taken in a [TestGridSession](API_TestGridSession.md).

## Request Syntax
<a name="API_ListTestGridSessionActions_RequestSyntax"></a>

```
{
   "maxResult": number,
   "nextToken": "string",
   "sessionArn": "string"
}
```

## Request Parameters
<a name="API_ListTestGridSessionActions_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResult](#API_ListTestGridSessionActions_RequestSyntax) **   <a name="devicefarm-ListTestGridSessionActions-request-maxResult"></a>
The maximum number of sessions to return per response.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [nextToken](#API_ListTestGridSessionActions_RequestSyntax) **   <a name="devicefarm-ListTestGridSessionActions-request-nextToken"></a>
Pagination token.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Required: No

 ** [sessionArn](#API_ListTestGridSessionActions_RequestSyntax) **   <a name="devicefarm-ListTestGridSessionActions-request-sessionArn"></a>
The ARN of the session to retrieve.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Syntax
<a name="API_ListTestGridSessionActions_ResponseSyntax"></a>

```
{
   "actions": [ 
      { 
         "action": "string",
         "duration": number,
         "requestMethod": "string",
         "started": number,
         "statusCode": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListTestGridSessionActions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [actions](#API_ListTestGridSessionActions_ResponseSyntax) **   <a name="devicefarm-ListTestGridSessionActions-response-actions"></a>
The action taken by the session.  
Type: Array of [TestGridSessionAction](API_TestGridSessionAction.md) objects

 ** [nextToken](#API_ListTestGridSessionActions_ResponseSyntax) **   <a name="devicefarm-ListTestGridSessionActions-response-nextToken"></a>
Pagination token.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.

## Errors
<a name="API_ListTestGridSessionActions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ArgumentException **   
An invalid argument was specified.    
 ** message **   
Any additional information about the exception.
HTTP Status Code: 400

 ** InternalServiceException **   
An internal exception was raised in the service. Contact [aws-devicefarm-support@amazon.com](mailto:aws-devicefarm-support@amazon.com) if you see this error.   
HTTP Status Code: 500

 ** NotFoundException **   
The specified entity was not found.    
 ** message **   
Any additional information about the exception.
HTTP Status Code: 400

## See Also
<a name="API_ListTestGridSessionActions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/ListTestGridSessionActions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/ListTestGridSessionActions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListTestGridSessionActions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/ListTestGridSessionActions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/ListTestGridSessionActions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/ListTestGridSessionActions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/ListTestGridSessionActions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListTestGridSessionActions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListTestGridSessionActions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListTestGridSessionActions) 

# ListTestGridSessionArtifacts
<a name="API_ListTestGridSessionArtifacts"></a>

Retrieves a list of artifacts created during the session.

## Request Syntax
<a name="API_ListTestGridSessionArtifacts_RequestSyntax"></a>

```
{
   "maxResult": number,
   "nextToken": "string",
   "sessionArn": "string",
   "type": "string"
}
```

## Request Parameters
<a name="API_ListTestGridSessionArtifacts_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResult](#API_ListTestGridSessionArtifacts_RequestSyntax) **   <a name="devicefarm-ListTestGridSessionArtifacts-request-maxResult"></a>
The maximum number of results to be returned by a request.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [nextToken](#API_ListTestGridSessionArtifacts_RequestSyntax) **   <a name="devicefarm-ListTestGridSessionArtifacts-request-nextToken"></a>
Pagination token.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Required: No

 ** [sessionArn](#API_ListTestGridSessionArtifacts_RequestSyntax) **   <a name="devicefarm-ListTestGridSessionArtifacts-request-sessionArn"></a>
The ARN of a [TestGridSession](API_TestGridSession.md).   
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [type](#API_ListTestGridSessionArtifacts_RequestSyntax) **   <a name="devicefarm-ListTestGridSessionArtifacts-request-type"></a>
Limit results to a specified type of artifact.  
Type: String  
Valid Values: `VIDEO | LOG`   
Required: No

## Response Syntax
<a name="API_ListTestGridSessionArtifacts_ResponseSyntax"></a>

```
{
   "artifacts": [ 
      { 
         "filename": "string",
         "type": "string",
         "url": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListTestGridSessionArtifacts_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [artifacts](#API_ListTestGridSessionArtifacts_ResponseSyntax) **   <a name="devicefarm-ListTestGridSessionArtifacts-response-artifacts"></a>
A list of test grid session artifacts for a [TestGridSession](API_TestGridSession.md).  
Type: Array of [TestGridSessionArtifact](API_TestGridSessionArtifact.md) objects

 ** [nextToken](#API_ListTestGridSessionArtifacts_ResponseSyntax) **   <a name="devicefarm-ListTestGridSessionArtifacts-response-nextToken"></a>
Pagination token.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.

## Errors
<a name="API_ListTestGridSessionArtifacts_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ArgumentException **   
An invalid argument was specified.    
 ** message **   
Any additional information about the exception.
HTTP Status Code: 400

 ** InternalServiceException **   
An internal exception was raised in the service. Contact [aws-devicefarm-support@amazon.com](mailto:aws-devicefarm-support@amazon.com) if you see this error.   
HTTP Status Code: 500

 ** NotFoundException **   
The specified entity was not found.    
 ** message **   
Any additional information about the exception.
HTTP Status Code: 400

## See Also
<a name="API_ListTestGridSessionArtifacts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/ListTestGridSessionArtifacts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/ListTestGridSessionArtifacts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListTestGridSessionArtifacts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/ListTestGridSessionArtifacts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/ListTestGridSessionArtifacts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/ListTestGridSessionArtifacts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/ListTestGridSessionArtifacts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListTestGridSessionArtifacts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListTestGridSessionArtifacts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListTestGridSessionArtifacts) 

# ListTestGridSessions
<a name="API_ListTestGridSessions"></a>

Retrieves a list of sessions for a [TestGridProject](API_TestGridProject.md).

## Request Syntax
<a name="API_ListTestGridSessions_RequestSyntax"></a>

```
{
   "creationTimeAfter": number,
   "creationTimeBefore": number,
   "endTimeAfter": number,
   "endTimeBefore": number,
   "maxResult": number,
   "nextToken": "string",
   "projectArn": "string",
   "status": "string"
}
```

## Request Parameters
<a name="API_ListTestGridSessions_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [creationTimeAfter](#API_ListTestGridSessions_RequestSyntax) **   <a name="devicefarm-ListTestGridSessions-request-creationTimeAfter"></a>
Return only sessions created after this time.  
Type: Timestamp  
Required: No

 ** [creationTimeBefore](#API_ListTestGridSessions_RequestSyntax) **   <a name="devicefarm-ListTestGridSessions-request-creationTimeBefore"></a>
Return only sessions created before this time.  
Type: Timestamp  
Required: No

 ** [endTimeAfter](#API_ListTestGridSessions_RequestSyntax) **   <a name="devicefarm-ListTestGridSessions-request-endTimeAfter"></a>
Return only sessions that ended after this time.  
Type: Timestamp  
Required: No

 ** [endTimeBefore](#API_ListTestGridSessions_RequestSyntax) **   <a name="devicefarm-ListTestGridSessions-request-endTimeBefore"></a>
Return only sessions that ended before this time.  
Type: Timestamp  
Required: No

 ** [maxResult](#API_ListTestGridSessions_RequestSyntax) **   <a name="devicefarm-ListTestGridSessions-request-maxResult"></a>
Return only this many results at a time.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [nextToken](#API_ListTestGridSessions_RequestSyntax) **   <a name="devicefarm-ListTestGridSessions-request-nextToken"></a>
Pagination token.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Required: No

 ** [projectArn](#API_ListTestGridSessions_RequestSyntax) **   <a name="devicefarm-ListTestGridSessions-request-projectArn"></a>
ARN of a [TestGridProject](API_TestGridProject.md).  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [status](#API_ListTestGridSessions_RequestSyntax) **   <a name="devicefarm-ListTestGridSessions-request-status"></a>
Return only sessions in this state.  
Type: String  
Valid Values: `ACTIVE | CLOSED | ERRORED`   
Required: No

## Response Syntax
<a name="API_ListTestGridSessions_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "testGridSessions": [ 
      { 
         "arn": "string",
         "billingMinutes": number,
         "created": number,
         "ended": number,
         "seleniumProperties": "string",
         "status": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTestGridSessions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListTestGridSessions_ResponseSyntax) **   <a name="devicefarm-ListTestGridSessions-response-nextToken"></a>
Pagination token.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.

 ** [testGridSessions](#API_ListTestGridSessions_ResponseSyntax) **   <a name="devicefarm-ListTestGridSessions-response-testGridSessions"></a>
The sessions that match the criteria in a [ListTestGridSessionsRequest](API_ListTestGridSessionsRequest.md).   
Type: Array of [TestGridSession](API_TestGridSession.md) objects

## Errors
<a name="API_ListTestGridSessions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ArgumentException **   
An invalid argument was specified.    
 ** message **   
Any additional information about the exception.
HTTP Status Code: 400

 ** InternalServiceException **   
An internal exception was raised in the service. Contact [aws-devicefarm-support@amazon.com](mailto:aws-devicefarm-support@amazon.com) if you see this error.   
HTTP Status Code: 500

 ** NotFoundException **   
The specified entity was not found.    
 ** message **   
Any additional information about the exception.
HTTP Status Code: 400

## See Also
<a name="API_ListTestGridSessions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/ListTestGridSessions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/ListTestGridSessions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListTestGridSessions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/ListTestGridSessions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/ListTestGridSessions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/ListTestGridSessions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/ListTestGridSessions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListTestGridSessions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListTestGridSessions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListTestGridSessions) 

# ListTests
<a name="API_ListTests"></a>

Gets information about tests in a given test suite.

## Request Syntax
<a name="API_ListTests_RequestSyntax"></a>

```
{
   "arn": "string",
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListTests_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_ListTests_RequestSyntax) **   <a name="devicefarm-ListTests-request-arn"></a>
The test suite's Amazon Resource Name (ARN).  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [nextToken](#API_ListTests_RequestSyntax) **   <a name="devicefarm-ListTests-request-nextToken"></a>
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_ListTests_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "tests": [ 
      { 
         "arn": "string",
         "counters": { 
            "errored": number,
            "failed": number,
            "passed": number,
            "skipped": number,
            "stopped": number,
            "total": number,
            "warned": number
         },
         "created": number,
         "deviceMinutes": { 
            "metered": number,
            "total": number,
            "unmetered": number
         },
         "message": "string",
         "name": "string",
         "result": "string",
         "started": number,
         "status": "string",
         "stopped": number,
         "type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTests_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListTests_ResponseSyntax) **   <a name="devicefarm-ListTests-response-nextToken"></a>
If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.

 ** [tests](#API_ListTests_ResponseSyntax) **   <a name="devicefarm-ListTests-response-tests"></a>
Information about the tests.  
Type: Array of [Test](API_Test.md) objects

## Errors
<a name="API_ListTests_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_ListTests_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/ListTests) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/ListTests) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListTests) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/ListTests) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/ListTests) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/ListTests) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/ListTests) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListTests) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListTests) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListTests) 

# ListUniqueProblems
<a name="API_ListUniqueProblems"></a>

Gets information about unique problems, such as exceptions or crashes.

Unique problems are defined as a single instance of an error across a run, job, or suite. For example, if a call in your application consistently raises an exception (`OutOfBoundsException in MyActivity.java:386`), `ListUniqueProblems` returns a single entry instead of many individual entries for that exception.

## Request Syntax
<a name="API_ListUniqueProblems_RequestSyntax"></a>

```
{
   "arn": "string",
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListUniqueProblems_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_ListUniqueProblems_RequestSyntax) **   <a name="devicefarm-ListUniqueProblems-request-arn"></a>
The unique problems' ARNs.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [nextToken](#API_ListUniqueProblems_RequestSyntax) **   <a name="devicefarm-ListUniqueProblems-request-nextToken"></a>
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_ListUniqueProblems_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "uniqueProblems": { 
      "string" : [ 
         { 
            "message": "string",
            "problems": [ 
               { 
                  "device": { 
                     "arn": "string",
                     "availability": "string",
                     "carrier": "string",
                     "cpu": { 
                        "architecture": "string",
                        "clock": number,
                        "frequency": "string"
                     },
                     "fleetName": "string",
                     "fleetType": "string",
                     "formFactor": "string",
                     "heapSize": number,
                     "image": "string",
                     "instances": [ 
                        { 
                           "arn": "string",
                           "deviceArn": "string",
                           "instanceProfile": { 
                              "arn": "string",
                              "description": "string",
                              "excludeAppPackagesFromCleanup": [ "string" ],
                              "name": "string",
                              "packageCleanup": boolean,
                              "rebootAfterUse": boolean
                           },
                           "labels": [ "string" ],
                           "status": "string",
                           "udid": "string"
                        }
                     ],
                     "manufacturer": "string",
                     "memory": number,
                     "model": "string",
                     "modelId": "string",
                     "name": "string",
                     "os": "string",
                     "platform": "string",
                     "radio": "string",
                     "remoteAccessEnabled": boolean,
                     "remoteDebugEnabled": boolean,
                     "resolution": { 
                        "height": number,
                        "width": number
                     }
                  },
                  "job": { 
                     "arn": "string",
                     "name": "string"
                  },
                  "message": "string",
                  "result": "string",
                  "run": { 
                     "arn": "string",
                     "name": "string"
                  },
                  "suite": { 
                     "arn": "string",
                     "name": "string"
                  },
                  "test": { 
                     "arn": "string",
                     "name": "string"
                  }
               }
            ]
         }
      ]
   }
}
```

## Response Elements
<a name="API_ListUniqueProblems_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListUniqueProblems_ResponseSyntax) **   <a name="devicefarm-ListUniqueProblems-response-nextToken"></a>
If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.

 ** [uniqueProblems](#API_ListUniqueProblems_ResponseSyntax) **   <a name="devicefarm-ListUniqueProblems-response-uniqueProblems"></a>
Information about the unique problems.  
Allowed values include:  
+ PENDING
+ PASSED
+ WARNED
+ FAILED
+ SKIPPED
+ ERRORED
+ STOPPED
Type: String to array of [UniqueProblem](API_UniqueProblem.md) objects map  
Valid Keys: `PENDING | PASSED | WARNED | FAILED | SKIPPED | ERRORED | STOPPED` 

## Errors
<a name="API_ListUniqueProblems_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_ListUniqueProblems_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/ListUniqueProblems) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/ListUniqueProblems) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListUniqueProblems) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/ListUniqueProblems) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/ListUniqueProblems) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/ListUniqueProblems) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/ListUniqueProblems) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListUniqueProblems) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListUniqueProblems) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListUniqueProblems) 

# ListUploads
<a name="API_ListUploads"></a>

Gets information about uploads, given an AWS Device Farm project ARN.

## Request Syntax
<a name="API_ListUploads_RequestSyntax"></a>

```
{
   "arn": "string",
   "nextToken": "string",
   "type": "string"
}
```

## Request Parameters
<a name="API_ListUploads_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_ListUploads_RequestSyntax) **   <a name="devicefarm-ListUploads-request-arn"></a>
The Amazon Resource Name (ARN) of the project for which you want to list uploads.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [nextToken](#API_ListUploads_RequestSyntax) **   <a name="devicefarm-ListUploads-request-nextToken"></a>
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Required: No

 ** [type](#API_ListUploads_RequestSyntax) **   <a name="devicefarm-ListUploads-request-type"></a>
The type of upload.  
Must be one of the following values:  
+ ANDROID\$1APP
+ IOS\$1APP
+ WEB\$1APP
+ EXTERNAL\$1DATA
+ APPIUM\$1JAVA\$1JUNIT\$1TEST\$1PACKAGE
+ APPIUM\$1JAVA\$1TESTNG\$1TEST\$1PACKAGE
+ APPIUM\$1PYTHON\$1TEST\$1PACKAGE
+ APPIUM\$1NODE\$1TEST\$1PACKAGE
+ APPIUM\$1RUBY\$1TEST\$1PACKAGE
+ APPIUM\$1WEB\$1JAVA\$1JUNIT\$1TEST\$1PACKAGE
+ APPIUM\$1WEB\$1JAVA\$1TESTNG\$1TEST\$1PACKAGE
+ APPIUM\$1WEB\$1PYTHON\$1TEST\$1PACKAGE
+ APPIUM\$1WEB\$1NODE\$1TEST\$1PACKAGE
+ APPIUM\$1WEB\$1RUBY\$1TEST\$1PACKAGE
+ INSTRUMENTATION\$1TEST\$1PACKAGE
+ XCTEST\$1TEST\$1PACKAGE
+ XCTEST\$1UI\$1TEST\$1PACKAGE
+ APPIUM\$1JAVA\$1JUNIT\$1TEST\$1SPEC
+ APPIUM\$1JAVA\$1TESTNG\$1TEST\$1SPEC
+ APPIUM\$1PYTHON\$1TEST\$1SPEC
+ APPIUM\$1NODE\$1TEST\$1SPEC
+  APPIUM\$1RUBY\$1TEST\$1SPEC
+ APPIUM\$1WEB\$1JAVA\$1JUNIT\$1TEST\$1SPEC
+ APPIUM\$1WEB\$1JAVA\$1TESTNG\$1TEST\$1SPEC
+ APPIUM\$1WEB\$1PYTHON\$1TEST\$1SPEC
+ APPIUM\$1WEB\$1NODE\$1TEST\$1SPEC
+ APPIUM\$1WEB\$1RUBY\$1TEST\$1SPEC
+ INSTRUMENTATION\$1TEST\$1SPEC
+ XCTEST\$1UI\$1TEST\$1SPEC
Type: String  
Valid Values: `ANDROID_APP | IOS_APP | WEB_APP | EXTERNAL_DATA | APPIUM_JAVA_JUNIT_TEST_PACKAGE | APPIUM_JAVA_TESTNG_TEST_PACKAGE | APPIUM_PYTHON_TEST_PACKAGE | APPIUM_NODE_TEST_PACKAGE | APPIUM_RUBY_TEST_PACKAGE | APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE | APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE | APPIUM_WEB_PYTHON_TEST_PACKAGE | APPIUM_WEB_NODE_TEST_PACKAGE | APPIUM_WEB_RUBY_TEST_PACKAGE | CALABASH_TEST_PACKAGE | INSTRUMENTATION_TEST_PACKAGE | UIAUTOMATION_TEST_PACKAGE | UIAUTOMATOR_TEST_PACKAGE | XCTEST_TEST_PACKAGE | XCTEST_UI_TEST_PACKAGE | APPIUM_JAVA_JUNIT_TEST_SPEC | APPIUM_JAVA_TESTNG_TEST_SPEC | APPIUM_PYTHON_TEST_SPEC | APPIUM_NODE_TEST_SPEC | APPIUM_RUBY_TEST_SPEC | APPIUM_WEB_JAVA_JUNIT_TEST_SPEC | APPIUM_WEB_JAVA_TESTNG_TEST_SPEC | APPIUM_WEB_PYTHON_TEST_SPEC | APPIUM_WEB_NODE_TEST_SPEC | APPIUM_WEB_RUBY_TEST_SPEC | INSTRUMENTATION_TEST_SPEC | XCTEST_UI_TEST_SPEC`   
Required: No

## Response Syntax
<a name="API_ListUploads_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "uploads": [ 
      { 
         "arn": "string",
         "category": "string",
         "contentType": "string",
         "created": number,
         "message": "string",
         "metadata": "string",
         "name": "string",
         "status": "string",
         "type": "string",
         "url": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListUploads_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListUploads_ResponseSyntax) **   <a name="devicefarm-ListUploads-response-nextToken"></a>
If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.

 ** [uploads](#API_ListUploads_ResponseSyntax) **   <a name="devicefarm-ListUploads-response-uploads"></a>
Information about the uploads.  
Type: Array of [Upload](API_Upload.md) objects

## Errors
<a name="API_ListUploads_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_ListUploads_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/ListUploads) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/ListUploads) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListUploads) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/ListUploads) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/ListUploads) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/ListUploads) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/ListUploads) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListUploads) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListUploads) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListUploads) 

# ListVPCEConfigurations
<a name="API_ListVPCEConfigurations"></a>

Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.

## Request Syntax
<a name="API_ListVPCEConfigurations_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListVPCEConfigurations_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListVPCEConfigurations_RequestSyntax) **   <a name="devicefarm-ListVPCEConfigurations-request-maxResults"></a>
An integer that specifies the maximum number of items you want to return in the API response.  
Type: Integer  
Required: No

 ** [nextToken](#API_ListVPCEConfigurations_RequestSyntax) **   <a name="devicefarm-ListVPCEConfigurations-request-nextToken"></a>
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_ListVPCEConfigurations_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "vpceConfigurations": [ 
      { 
         "arn": "string",
         "serviceDnsName": "string",
         "vpceConfigurationDescription": "string",
         "vpceConfigurationName": "string",
         "vpceServiceName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListVPCEConfigurations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListVPCEConfigurations_ResponseSyntax) **   <a name="devicefarm-ListVPCEConfigurations-response-nextToken"></a>
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 1024.

 ** [vpceConfigurations](#API_ListVPCEConfigurations_ResponseSyntax) **   <a name="devicefarm-ListVPCEConfigurations-response-vpceConfigurations"></a>
An array of `VPCEConfiguration` objects that contain information about your VPC endpoint configuration.  
Type: Array of [VPCEConfiguration](API_VPCEConfiguration.md) objects

## Errors
<a name="API_ListVPCEConfigurations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ArgumentException **   
An invalid argument was specified.    
 ** 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

## See Also
<a name="API_ListVPCEConfigurations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/ListVPCEConfigurations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/ListVPCEConfigurations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListVPCEConfigurations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/ListVPCEConfigurations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/ListVPCEConfigurations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/ListVPCEConfigurations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/ListVPCEConfigurations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListVPCEConfigurations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListVPCEConfigurations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListVPCEConfigurations) 

# PurchaseOffering
<a name="API_PurchaseOffering"></a>

Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. The API returns a `NotEligible` error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact [aws-devicefarm-support@amazon.com](mailto:aws-devicefarm-support@amazon.com).

## Request Syntax
<a name="API_PurchaseOffering_RequestSyntax"></a>

```
{
   "offeringId": "string",
   "offeringPromotionId": "string",
   "quantity": number
}
```

## Request Parameters
<a name="API_PurchaseOffering_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [offeringId](#API_PurchaseOffering_RequestSyntax) **   <a name="devicefarm-PurchaseOffering-request-offeringId"></a>
The ID of the offering.  
Type: String  
Length Constraints: Minimum length of 32.  
Required: Yes

 ** [offeringPromotionId](#API_PurchaseOffering_RequestSyntax) **   <a name="devicefarm-PurchaseOffering-request-offeringPromotionId"></a>
The ID of the offering promotion to be applied to the purchase.  
Type: String  
Length Constraints: Minimum length of 4.  
Required: No

 ** [quantity](#API_PurchaseOffering_RequestSyntax) **   <a name="devicefarm-PurchaseOffering-request-quantity"></a>
The number of device slots to purchase in an offering request.  
Type: Integer  
Required: Yes

## Response Syntax
<a name="API_PurchaseOffering_ResponseSyntax"></a>

```
{
   "offeringTransaction": { 
      "cost": { 
         "amount": number,
         "currencyCode": "string"
      },
      "createdOn": number,
      "offeringPromotionId": "string",
      "offeringStatus": { 
         "effectiveOn": number,
         "offering": { 
            "description": "string",
            "id": "string",
            "platform": "string",
            "recurringCharges": [ 
               { 
                  "cost": { 
                     "amount": number,
                     "currencyCode": "string"
                  },
                  "frequency": "string"
               }
            ],
            "type": "string"
         },
         "quantity": number,
         "type": "string"
      },
      "transactionId": "string"
   }
}
```

## Response Elements
<a name="API_PurchaseOffering_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [offeringTransaction](#API_PurchaseOffering_ResponseSyntax) **   <a name="devicefarm-PurchaseOffering-response-offeringTransaction"></a>
Represents the offering transaction for the purchase result.  
Type: [OfferingTransaction](API_OfferingTransaction.md) object

## Errors
<a name="API_PurchaseOffering_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** NotEligibleException **   
Exception gets thrown when a user is not eligible to perform the specified transaction.    
 ** message **   
The HTTP response code of a Not Eligible 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

## Examples
<a name="API_PurchaseOffering_Examples"></a>

### Example
<a name="API_PurchaseOffering_Example_1"></a>

The following example purchases one unmetered iOS device.

#### Sample Request
<a name="API_PurchaseOffering_Example_1_Request"></a>

```
{
  "transactions": [
    "purchase": {
      "offeringId": "offering-id-ios",
      "quantity": 1
    }
  ]
}
```

#### Sample Response
<a name="API_PurchaseOffering_Example_1_Response"></a>

```
{
    "offeringTransaction": {
        "createdOn": 1458587590.308,
        "offeringStatus": {
            "effectiveOn": 1458587590.24,
            "type": "RECURRING",
            "offering": {
                "platform": "IOS",
                "type": "RECURRING",
                "id": "offering-id-ios",
                "description": "iOS Unmetered Device Slot"
            },
            "quantity": 1
        },
        "cost": {
            "amount": 80.65,
            "currencyCode": "USD"
        },
        "transactionId": "transaction-id"
    }
}
```

## See Also
<a name="API_PurchaseOffering_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/PurchaseOffering) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/PurchaseOffering) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/PurchaseOffering) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/PurchaseOffering) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/PurchaseOffering) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/PurchaseOffering) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/PurchaseOffering) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/PurchaseOffering) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/PurchaseOffering) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/PurchaseOffering) 

# RenewOffering
<a name="API_RenewOffering"></a>

Explicitly sets the quantity of devices to renew for an offering, starting from the `effectiveDate` of the next period. The API returns a `NotEligible` error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact [aws-devicefarm-support@amazon.com](mailto:aws-devicefarm-support@amazon.com).

## Request Syntax
<a name="API_RenewOffering_RequestSyntax"></a>

```
{
   "offeringId": "string",
   "quantity": number
}
```

## Request Parameters
<a name="API_RenewOffering_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [offeringId](#API_RenewOffering_RequestSyntax) **   <a name="devicefarm-RenewOffering-request-offeringId"></a>
The ID of a request to renew an offering.  
Type: String  
Length Constraints: Minimum length of 32.  
Required: Yes

 ** [quantity](#API_RenewOffering_RequestSyntax) **   <a name="devicefarm-RenewOffering-request-quantity"></a>
The quantity requested in an offering renewal.  
Type: Integer  
Required: Yes

## Response Syntax
<a name="API_RenewOffering_ResponseSyntax"></a>

```
{
   "offeringTransaction": { 
      "cost": { 
         "amount": number,
         "currencyCode": "string"
      },
      "createdOn": number,
      "offeringPromotionId": "string",
      "offeringStatus": { 
         "effectiveOn": number,
         "offering": { 
            "description": "string",
            "id": "string",
            "platform": "string",
            "recurringCharges": [ 
               { 
                  "cost": { 
                     "amount": number,
                     "currencyCode": "string"
                  },
                  "frequency": "string"
               }
            ],
            "type": "string"
         },
         "quantity": number,
         "type": "string"
      },
      "transactionId": "string"
   }
}
```

## Response Elements
<a name="API_RenewOffering_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [offeringTransaction](#API_RenewOffering_ResponseSyntax) **   <a name="devicefarm-RenewOffering-response-offeringTransaction"></a>
Represents the status of the offering transaction for the renewal.  
Type: [OfferingTransaction](API_OfferingTransaction.md) object

## Errors
<a name="API_RenewOffering_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** NotEligibleException **   
Exception gets thrown when a user is not eligible to perform the specified transaction.    
 ** message **   
The HTTP response code of a Not Eligible 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

## Examples
<a name="API_RenewOffering_Examples"></a>

### Example
<a name="API_RenewOffering_Example_1"></a>

The following example renews the offering for one unmetered iOS device.

#### Sample Request
<a name="API_RenewOffering_Example_1_Request"></a>

```
{
    "transactions": [
        "renew": {
            "offeringId": "offering-id-ios",
            "quantity": 1,
        }
    ]
}
```

#### Sample Response
<a name="API_RenewOffering_Example_1_Response"></a>

```
{
    "offeringTransaction": {
        "createdOn": 1458596930.431,
        "offeringStatus": {
            "effectiveOn": 1459468800.0,
            "type": "RECURRING",
            "offering": {
                "platform": "IOS",
                "type": "RECURRING",
                "id": "offering-id-ios",
                "description": "iOS Unmetered Device Slot"
            },
            "quantity": 1
        },
        "cost": {
            "amount": 250.0,
            "currencyCode": "USD"
        },
        "transactionId": "transaction-id"
    }
}
```

## See Also
<a name="API_RenewOffering_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/RenewOffering) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/RenewOffering) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/RenewOffering) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/RenewOffering) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/RenewOffering) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/RenewOffering) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/RenewOffering) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/RenewOffering) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/RenewOffering) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/RenewOffering) 

# ScheduleRun
<a name="API_ScheduleRun"></a>

Schedules a run.

## Request Syntax
<a name="API_ScheduleRun_RequestSyntax"></a>

```
{
   "appArn": "string",
   "configuration": { 
      "auxiliaryApps": [ "string" ],
      "billingMethod": "string",
      "customerArtifactPaths": { 
         "androidPaths": [ "string" ],
         "deviceHostPaths": [ "string" ],
         "iosPaths": [ "string" ]
      },
      "deviceProxy": { 
         "host": "string",
         "port": number
      },
      "environmentVariables": [ 
         { 
            "name": "string",
            "value": "string"
         }
      ],
      "executionRoleArn": "string",
      "extraDataPackageArn": "string",
      "locale": "string",
      "location": { 
         "latitude": number,
         "longitude": number
      },
      "networkProfileArn": "string",
      "radios": { 
         "bluetooth": boolean,
         "gps": boolean,
         "nfc": boolean,
         "wifi": boolean
      },
      "vpceConfigurationArns": [ "string" ]
   },
   "devicePoolArn": "string",
   "deviceSelectionConfiguration": { 
      "filters": [ 
         { 
            "attribute": "string",
            "operator": "string",
            "values": [ "string" ]
         }
      ],
      "maxDevices": number
   },
   "executionConfiguration": { 
      "accountsCleanup": boolean,
      "appPackagesCleanup": boolean,
      "jobTimeoutMinutes": number,
      "skipAppResign": boolean,
      "videoCapture": boolean
   },
   "name": "string",
   "projectArn": "string",
   "test": { 
      "filter": "string",
      "parameters": { 
         "string" : "string" 
      },
      "testPackageArn": "string",
      "testSpecArn": "string",
      "type": "string"
   }
}
```

## Request Parameters
<a name="API_ScheduleRun_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [appArn](#API_ScheduleRun_RequestSyntax) **   <a name="devicefarm-ScheduleRun-request-appArn"></a>
The ARN of an application package to run tests against, created with [CreateUpload](API_CreateUpload.md). See [ListUploads](API_ListUploads.md).  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: No

 ** [configuration](#API_ScheduleRun_RequestSyntax) **   <a name="devicefarm-ScheduleRun-request-configuration"></a>
Information about the settings for the run to be scheduled.  
Type: [ScheduleRunConfiguration](API_ScheduleRunConfiguration.md) object  
Required: No

 ** [devicePoolArn](#API_ScheduleRun_RequestSyntax) **   <a name="devicefarm-ScheduleRun-request-devicePoolArn"></a>
The ARN of the device pool for the run to be scheduled.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: No

 ** [deviceSelectionConfiguration](#API_ScheduleRun_RequestSyntax) **   <a name="devicefarm-ScheduleRun-request-deviceSelectionConfiguration"></a>
The filter criteria used to dynamically select a set of devices for a test run and the maximum number of devices to be included in the run.  
Either ** `devicePoolArn` ** or ** `deviceSelectionConfiguration` ** is required in a request.  
Type: [DeviceSelectionConfiguration](API_DeviceSelectionConfiguration.md) object  
Required: No

 ** [executionConfiguration](#API_ScheduleRun_RequestSyntax) **   <a name="devicefarm-ScheduleRun-request-executionConfiguration"></a>
Specifies configuration information about a test run, such as the execution timeout (in minutes).  
Type: [ExecutionConfiguration](API_ExecutionConfiguration.md) object  
Required: No

 ** [name](#API_ScheduleRun_RequestSyntax) **   <a name="devicefarm-ScheduleRun-request-name"></a>
The name for the run to be scheduled.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

 ** [projectArn](#API_ScheduleRun_RequestSyntax) **   <a name="devicefarm-ScheduleRun-request-projectArn"></a>
The ARN of the project for the run to be scheduled.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [test](#API_ScheduleRun_RequestSyntax) **   <a name="devicefarm-ScheduleRun-request-test"></a>
Information about the test for the run to be scheduled.  
Type: [ScheduleRunTest](API_ScheduleRunTest.md) object  
Required: Yes

## Response Syntax
<a name="API_ScheduleRun_ResponseSyntax"></a>

```
{
   "run": { 
      "appUpload": "string",
      "arn": "string",
      "billingMethod": "string",
      "completedJobs": number,
      "counters": { 
         "errored": number,
         "failed": number,
         "passed": number,
         "skipped": number,
         "stopped": number,
         "total": number,
         "warned": number
      },
      "created": number,
      "customerArtifactPaths": { 
         "androidPaths": [ "string" ],
         "deviceHostPaths": [ "string" ],
         "iosPaths": [ "string" ]
      },
      "deviceMinutes": { 
         "metered": number,
         "total": number,
         "unmetered": number
      },
      "devicePoolArn": "string",
      "deviceProxy": { 
         "host": "string",
         "port": number
      },
      "deviceSelectionResult": { 
         "filters": [ 
            { 
               "attribute": "string",
               "operator": "string",
               "values": [ "string" ]
            }
         ],
         "matchedDevicesCount": number,
         "maxDevices": number
      },
      "environmentVariables": [ 
         { 
            "name": "string",
            "value": "string"
         }
      ],
      "eventCount": number,
      "executionRoleArn": "string",
      "jobTimeoutMinutes": number,
      "locale": "string",
      "location": { 
         "latitude": number,
         "longitude": number
      },
      "message": "string",
      "name": "string",
      "networkProfile": { 
         "arn": "string",
         "description": "string",
         "downlinkBandwidthBits": number,
         "downlinkDelayMs": number,
         "downlinkJitterMs": number,
         "downlinkLossPercent": number,
         "name": "string",
         "type": "string",
         "uplinkBandwidthBits": number,
         "uplinkDelayMs": number,
         "uplinkJitterMs": number,
         "uplinkLossPercent": number
      },
      "parsingResultUrl": "string",
      "platform": "string",
      "radios": { 
         "bluetooth": boolean,
         "gps": boolean,
         "nfc": boolean,
         "wifi": boolean
      },
      "result": "string",
      "resultCode": "string",
      "seed": number,
      "skipAppResign": boolean,
      "started": number,
      "status": "string",
      "stopped": number,
      "testSpecArn": "string",
      "totalJobs": number,
      "type": "string",
      "vpcConfig": { 
         "securityGroupIds": [ "string" ],
         "subnetIds": [ "string" ],
         "vpcId": "string"
      },
      "webUrl": "string"
   }
}
```

## Response Elements
<a name="API_ScheduleRun_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [run](#API_ScheduleRun_ResponseSyntax) **   <a name="devicefarm-ScheduleRun-response-run"></a>
Information about the scheduled run.  
Type: [Run](API_Run.md) object

## Errors
<a name="API_ScheduleRun_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ArgumentException **   
An invalid argument was specified.    
 ** message **   
Any additional information about the exception.
HTTP Status Code: 400

 ** IdempotencyException **   
An entity with the same name already exists.    
 ** 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

## See Also
<a name="API_ScheduleRun_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/ScheduleRun) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/ScheduleRun) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ScheduleRun) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/ScheduleRun) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/ScheduleRun) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/ScheduleRun) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/ScheduleRun) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ScheduleRun) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ScheduleRun) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ScheduleRun) 

# StopJob
<a name="API_StopJob"></a>

Initiates a stop request for the current job. AWS Device Farm immediately stops the job on the device where tests have not started. You are not billed for this device. On the device where tests have started, setup suite and teardown suite tests run to completion on the device. You are billed for setup, teardown, and any tests that were in progress or already completed.

## Request Syntax
<a name="API_StopJob_RequestSyntax"></a>

```
{
   "arn": "string"
}
```

## Request Parameters
<a name="API_StopJob_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_StopJob_RequestSyntax) **   <a name="devicefarm-StopJob-request-arn"></a>
Represents the Amazon Resource Name (ARN) of the Device Farm job to stop.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Syntax
<a name="API_StopJob_ResponseSyntax"></a>

```
{
   "job": { 
      "arn": "string",
      "counters": { 
         "errored": number,
         "failed": number,
         "passed": number,
         "skipped": number,
         "stopped": number,
         "total": number,
         "warned": number
      },
      "created": number,
      "device": { 
         "arn": "string",
         "availability": "string",
         "carrier": "string",
         "cpu": { 
            "architecture": "string",
            "clock": number,
            "frequency": "string"
         },
         "fleetName": "string",
         "fleetType": "string",
         "formFactor": "string",
         "heapSize": number,
         "image": "string",
         "instances": [ 
            { 
               "arn": "string",
               "deviceArn": "string",
               "instanceProfile": { 
                  "arn": "string",
                  "description": "string",
                  "excludeAppPackagesFromCleanup": [ "string" ],
                  "name": "string",
                  "packageCleanup": boolean,
                  "rebootAfterUse": boolean
               },
               "labels": [ "string" ],
               "status": "string",
               "udid": "string"
            }
         ],
         "manufacturer": "string",
         "memory": number,
         "model": "string",
         "modelId": "string",
         "name": "string",
         "os": "string",
         "platform": "string",
         "radio": "string",
         "remoteAccessEnabled": boolean,
         "remoteDebugEnabled": boolean,
         "resolution": { 
            "height": number,
            "width": number
         }
      },
      "deviceMinutes": { 
         "metered": number,
         "total": number,
         "unmetered": number
      },
      "instanceArn": "string",
      "message": "string",
      "name": "string",
      "result": "string",
      "started": number,
      "status": "string",
      "stopped": number,
      "type": "string",
      "videoCapture": boolean,
      "videoEndpoint": "string"
   }
}
```

## Response Elements
<a name="API_StopJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [job](#API_StopJob_ResponseSyntax) **   <a name="devicefarm-StopJob-response-job"></a>
The job that was stopped.  
Type: [Job](API_Job.md) object

## Errors
<a name="API_StopJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_StopJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/StopJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/StopJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/StopJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/StopJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/StopJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/StopJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/StopJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/StopJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/StopJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/StopJob) 

# StopRemoteAccessSession
<a name="API_StopRemoteAccessSession"></a>

Ends a specified remote access session.

## Request Syntax
<a name="API_StopRemoteAccessSession_RequestSyntax"></a>

```
{
   "arn": "string"
}
```

## Request Parameters
<a name="API_StopRemoteAccessSession_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_StopRemoteAccessSession_RequestSyntax) **   <a name="devicefarm-StopRemoteAccessSession-request-arn"></a>
The Amazon Resource Name (ARN) of the remote access session to stop.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Syntax
<a name="API_StopRemoteAccessSession_ResponseSyntax"></a>

```
{
   "remoteAccessSession": { 
      "appUpload": "string",
      "arn": "string",
      "billingMethod": "string",
      "created": number,
      "device": { 
         "arn": "string",
         "availability": "string",
         "carrier": "string",
         "cpu": { 
            "architecture": "string",
            "clock": number,
            "frequency": "string"
         },
         "fleetName": "string",
         "fleetType": "string",
         "formFactor": "string",
         "heapSize": number,
         "image": "string",
         "instances": [ 
            { 
               "arn": "string",
               "deviceArn": "string",
               "instanceProfile": { 
                  "arn": "string",
                  "description": "string",
                  "excludeAppPackagesFromCleanup": [ "string" ],
                  "name": "string",
                  "packageCleanup": boolean,
                  "rebootAfterUse": boolean
               },
               "labels": [ "string" ],
               "status": "string",
               "udid": "string"
            }
         ],
         "manufacturer": "string",
         "memory": number,
         "model": "string",
         "modelId": "string",
         "name": "string",
         "os": "string",
         "platform": "string",
         "radio": "string",
         "remoteAccessEnabled": boolean,
         "remoteDebugEnabled": boolean,
         "resolution": { 
            "height": number,
            "width": number
         }
      },
      "deviceMinutes": { 
         "metered": number,
         "total": number,
         "unmetered": number
      },
      "deviceProxy": { 
         "host": "string",
         "port": number
      },
      "deviceUdid": "string",
      "endpoint": "string",
      "endpoints": { 
         "interactiveEndpoint": "string",
         "remoteDriverEndpoint": "string"
      },
      "instanceArn": "string",
      "interactionMode": "string",
      "message": "string",
      "name": "string",
      "result": "string",
      "skipAppResign": boolean,
      "started": number,
      "status": "string",
      "stopped": number,
      "vpcConfig": { 
         "securityGroupIds": [ "string" ],
         "subnetIds": [ "string" ],
         "vpcId": "string"
      }
   }
}
```

## Response Elements
<a name="API_StopRemoteAccessSession_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [remoteAccessSession](#API_StopRemoteAccessSession_ResponseSyntax) **   <a name="devicefarm-StopRemoteAccessSession-response-remoteAccessSession"></a>
A container that represents the metadata from the service about the remote access session you are stopping.  
Type: [RemoteAccessSession](API_RemoteAccessSession.md) object

## Errors
<a name="API_StopRemoteAccessSession_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_StopRemoteAccessSession_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/StopRemoteAccessSession) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/StopRemoteAccessSession) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/StopRemoteAccessSession) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/StopRemoteAccessSession) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/StopRemoteAccessSession) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/StopRemoteAccessSession) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/StopRemoteAccessSession) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/StopRemoteAccessSession) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/StopRemoteAccessSession) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/StopRemoteAccessSession) 

# StopRun
<a name="API_StopRun"></a>

Initiates a stop request for the current test run. AWS Device Farm immediately stops the run on devices where tests have not started. You are not billed for these devices. On devices where tests have started executing, setup suite and teardown suite tests run to completion on those devices. You are billed for setup, teardown, and any tests that were in progress or already completed.

## Request Syntax
<a name="API_StopRun_RequestSyntax"></a>

```
{
   "arn": "string"
}
```

## Request Parameters
<a name="API_StopRun_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_StopRun_RequestSyntax) **   <a name="devicefarm-StopRun-request-arn"></a>
Represents the Amazon Resource Name (ARN) of the Device Farm run to stop.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

## Response Syntax
<a name="API_StopRun_ResponseSyntax"></a>

```
{
   "run": { 
      "appUpload": "string",
      "arn": "string",
      "billingMethod": "string",
      "completedJobs": number,
      "counters": { 
         "errored": number,
         "failed": number,
         "passed": number,
         "skipped": number,
         "stopped": number,
         "total": number,
         "warned": number
      },
      "created": number,
      "customerArtifactPaths": { 
         "androidPaths": [ "string" ],
         "deviceHostPaths": [ "string" ],
         "iosPaths": [ "string" ]
      },
      "deviceMinutes": { 
         "metered": number,
         "total": number,
         "unmetered": number
      },
      "devicePoolArn": "string",
      "deviceProxy": { 
         "host": "string",
         "port": number
      },
      "deviceSelectionResult": { 
         "filters": [ 
            { 
               "attribute": "string",
               "operator": "string",
               "values": [ "string" ]
            }
         ],
         "matchedDevicesCount": number,
         "maxDevices": number
      },
      "environmentVariables": [ 
         { 
            "name": "string",
            "value": "string"
         }
      ],
      "eventCount": number,
      "executionRoleArn": "string",
      "jobTimeoutMinutes": number,
      "locale": "string",
      "location": { 
         "latitude": number,
         "longitude": number
      },
      "message": "string",
      "name": "string",
      "networkProfile": { 
         "arn": "string",
         "description": "string",
         "downlinkBandwidthBits": number,
         "downlinkDelayMs": number,
         "downlinkJitterMs": number,
         "downlinkLossPercent": number,
         "name": "string",
         "type": "string",
         "uplinkBandwidthBits": number,
         "uplinkDelayMs": number,
         "uplinkJitterMs": number,
         "uplinkLossPercent": number
      },
      "parsingResultUrl": "string",
      "platform": "string",
      "radios": { 
         "bluetooth": boolean,
         "gps": boolean,
         "nfc": boolean,
         "wifi": boolean
      },
      "result": "string",
      "resultCode": "string",
      "seed": number,
      "skipAppResign": boolean,
      "started": number,
      "status": "string",
      "stopped": number,
      "testSpecArn": "string",
      "totalJobs": number,
      "type": "string",
      "vpcConfig": { 
         "securityGroupIds": [ "string" ],
         "subnetIds": [ "string" ],
         "vpcId": "string"
      },
      "webUrl": "string"
   }
}
```

## Response Elements
<a name="API_StopRun_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [run](#API_StopRun_ResponseSyntax) **   <a name="devicefarm-StopRun-response-run"></a>
The run that was stopped.  
Type: [Run](API_Run.md) object

## Errors
<a name="API_StopRun_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_StopRun_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/StopRun) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/StopRun) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/StopRun) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/StopRun) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/StopRun) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/StopRun) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/StopRun) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/StopRun) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/StopRun) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/StopRun) 

# TagResource
<a name="API_TagResource"></a>

Associates the specified tags to a resource with the specified `resourceArn`. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.

## Request Syntax
<a name="API_TagResource_RequestSyntax"></a>

```
{
   "ResourceARN": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_TagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_TagResource_RequestSyntax) **   <a name="devicefarm-TagResource-request-ResourceARN"></a>
The Amazon Resource Name (ARN) of the resource or resources to which to add tags. You can associate tags with the following Device Farm resources: `PROJECT`, `TESTGRID_PROJECT`, `RUN`, `NETWORK_PROFILE`, `INSTANCE_PROFILE`, `DEVICE_INSTANCE`, `SESSION`, `DEVICE_POOL`, `DEVICE`, and `VPCE_CONFIGURATION`.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [Tags](#API_TagResource_RequestSyntax) **   <a name="devicefarm-TagResource-request-Tags"></a>
The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters. Tag values can have a maximum length of 256 characters.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 150 items.  
Required: Yes

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ArgumentException **   
An invalid argument was specified.    
 ** 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

 ** TagOperationException **   
The operation was not successful. Try again.  
HTTP Status Code: 400

 ** TagPolicyException **   
The request doesn't comply with the AWS Identity and Access Management (IAM) tag policy. Correct your request and then retry it.  
HTTP Status Code: 400

 ** TooManyTagsException **   
The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.   
HTTP Status Code: 400

## See Also
<a name="API_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

Deletes the specified tags from a resource.

## Request Syntax
<a name="API_UntagResource_RequestSyntax"></a>

```
{
   "ResourceARN": "string",
   "TagKeys": [ "string" ]
}
```

## Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_UntagResource_RequestSyntax) **   <a name="devicefarm-UntagResource-request-ResourceARN"></a>
The Amazon Resource Name (ARN) of the resource or resources from which to delete tags. You can associate tags with the following Device Farm resources: `PROJECT`, `TESTGRID_PROJECT`, `RUN`, `NETWORK_PROFILE`, `INSTANCE_PROFILE`, `DEVICE_INSTANCE`, `SESSION`, `DEVICE_POOL`, `DEVICE`, and `VPCE_CONFIGURATION`.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [TagKeys](#API_UntagResource_RequestSyntax) **   <a name="devicefarm-UntagResource-request-TagKeys"></a>
The keys of the tags to be removed.  
Type: Array of strings  
Array Members: Maximum number of 150 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ArgumentException **   
An invalid argument was specified.    
 ** 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

 ** TagOperationException **   
The operation was not successful. Try again.  
HTTP Status Code: 400

## See Also
<a name="API_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/UntagResource) 

# UpdateDeviceInstance
<a name="API_UpdateDeviceInstance"></a>

Updates information about a private device instance.

## Request Syntax
<a name="API_UpdateDeviceInstance_RequestSyntax"></a>

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

## Request Parameters
<a name="API_UpdateDeviceInstance_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_UpdateDeviceInstance_RequestSyntax) **   <a name="devicefarm-UpdateDeviceInstance-request-arn"></a>
The Amazon Resource Name (ARN) of the device instance.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [labels](#API_UpdateDeviceInstance_RequestSyntax) **   <a name="devicefarm-UpdateDeviceInstance-request-labels"></a>
An array of strings that you want to associate with the device instance.  
Type: Array of strings  
Required: No

 ** [profileArn](#API_UpdateDeviceInstance_RequestSyntax) **   <a name="devicefarm-UpdateDeviceInstance-request-profileArn"></a>
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:aws:devicefarm:.+`   
Required: No

## Response Syntax
<a name="API_UpdateDeviceInstance_ResponseSyntax"></a>

```
{
   "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
<a name="API_UpdateDeviceInstance_ResponseElements"></a>

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](#API_UpdateDeviceInstance_ResponseSyntax) **   <a name="devicefarm-UpdateDeviceInstance-response-deviceInstance"></a>
An object that contains information about your device instance.  
Type: [DeviceInstance](API_DeviceInstance.md) object

## Errors
<a name="API_UpdateDeviceInstance_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_UpdateDeviceInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/UpdateDeviceInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/UpdateDeviceInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/UpdateDeviceInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/UpdateDeviceInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/UpdateDeviceInstance) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/UpdateDeviceInstance) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/UpdateDeviceInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/UpdateDeviceInstance) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/UpdateDeviceInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/UpdateDeviceInstance) 

# UpdateDevicePool
<a name="API_UpdateDevicePool"></a>

Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all).

## Request Syntax
<a name="API_UpdateDevicePool_RequestSyntax"></a>

```
{
   "arn": "string",
   "clearMaxDevices": boolean,
   "description": "string",
   "maxDevices": number,
   "name": "string",
   "rules": [ 
      { 
         "attribute": "string",
         "operator": "string",
         "value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_UpdateDevicePool_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_UpdateDevicePool_RequestSyntax) **   <a name="devicefarm-UpdateDevicePool-request-arn"></a>
The Amazon Resource Name (ARN) of the Device Farm device pool to update.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [clearMaxDevices](#API_UpdateDevicePool_RequestSyntax) **   <a name="devicefarm-UpdateDevicePool-request-clearMaxDevices"></a>
Sets whether the `maxDevices` parameter applies to your device pool. If you set this parameter to `true`, the `maxDevices` parameter does not apply, and Device Farm does not limit the number of devices that it adds to your device pool. In this case, Device Farm adds all available devices that meet the criteria specified in the `rules` parameter.  
If you use this parameter in your request, you cannot use the `maxDevices` parameter in the same request.  
Type: Boolean  
Required: No

 ** [description](#API_UpdateDevicePool_RequestSyntax) **   <a name="devicefarm-UpdateDevicePool-request-description"></a>
A description of the device pool to update.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 16384.  
Required: No

 ** [maxDevices](#API_UpdateDevicePool_RequestSyntax) **   <a name="devicefarm-UpdateDevicePool-request-maxDevices"></a>
The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the `rules` parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.  
By specifying the maximum number of devices, you can control the costs that you incur by running tests.  
If you use this parameter in your request, you cannot use the `clearMaxDevices` parameter in the same request.  
Type: Integer  
Required: No

 ** [name](#API_UpdateDevicePool_RequestSyntax) **   <a name="devicefarm-UpdateDevicePool-request-name"></a>
A string that represents the name of the device pool to update.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

 ** [rules](#API_UpdateDevicePool_RequestSyntax) **   <a name="devicefarm-UpdateDevicePool-request-rules"></a>
Represents the rules to modify for the device pool. Updating rules is optional. If you update rules for your request, the update replaces the existing rules.  
Type: Array of [Rule](API_Rule.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateDevicePool_ResponseSyntax"></a>

```
{
   "devicePool": { 
      "arn": "string",
      "description": "string",
      "maxDevices": number,
      "name": "string",
      "rules": [ 
         { 
            "attribute": "string",
            "operator": "string",
            "value": "string"
         }
      ],
      "type": "string"
   }
}
```

## Response Elements
<a name="API_UpdateDevicePool_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [devicePool](#API_UpdateDevicePool_ResponseSyntax) **   <a name="devicefarm-UpdateDevicePool-response-devicePool"></a>
The device pool you just updated.  
Type: [DevicePool](API_DevicePool.md) object

## Errors
<a name="API_UpdateDevicePool_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_UpdateDevicePool_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/UpdateDevicePool) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/UpdateDevicePool) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/UpdateDevicePool) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/UpdateDevicePool) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/UpdateDevicePool) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/UpdateDevicePool) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/UpdateDevicePool) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/UpdateDevicePool) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/UpdateDevicePool) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/UpdateDevicePool) 

# UpdateInstanceProfile
<a name="API_UpdateInstanceProfile"></a>

Updates information about an existing private device instance profile.

## Request Syntax
<a name="API_UpdateInstanceProfile_RequestSyntax"></a>

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

## Request Parameters
<a name="API_UpdateInstanceProfile_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_UpdateInstanceProfile_RequestSyntax) **   <a name="devicefarm-UpdateInstanceProfile-request-arn"></a>
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](#API_UpdateInstanceProfile_RequestSyntax) **   <a name="devicefarm-UpdateInstanceProfile-request-description"></a>
The updated description for your instance profile.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 16384.  
Required: No

 ** [excludeAppPackagesFromCleanup](#API_UpdateInstanceProfile_RequestSyntax) **   <a name="devicefarm-UpdateInstanceProfile-request-excludeAppPackagesFromCleanup"></a>
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](#API_UpdateInstanceProfile_RequestSyntax) **   <a name="devicefarm-UpdateInstanceProfile-request-name"></a>
The updated name for your instance profile.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

 ** [packageCleanup](#API_UpdateInstanceProfile_RequestSyntax) **   <a name="devicefarm-UpdateInstanceProfile-request-packageCleanup"></a>
The updated choice for whether you want to specify package cleanup. The default value is `false` for private devices.  
Type: Boolean  
Required: No

 ** [rebootAfterUse](#API_UpdateInstanceProfile_RequestSyntax) **   <a name="devicefarm-UpdateInstanceProfile-request-rebootAfterUse"></a>
The updated choice for whether you want to reboot the device after use. The default value is `true`.  
Type: Boolean  
Required: No

## Response Syntax
<a name="API_UpdateInstanceProfile_ResponseSyntax"></a>

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

## Response Elements
<a name="API_UpdateInstanceProfile_ResponseElements"></a>

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](#API_UpdateInstanceProfile_ResponseSyntax) **   <a name="devicefarm-UpdateInstanceProfile-response-instanceProfile"></a>
An object that contains information about your instance profile.  
Type: [InstanceProfile](API_InstanceProfile.md) object

## Errors
<a name="API_UpdateInstanceProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_UpdateInstanceProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/UpdateInstanceProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/UpdateInstanceProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/UpdateInstanceProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/UpdateInstanceProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/UpdateInstanceProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/UpdateInstanceProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/UpdateInstanceProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/UpdateInstanceProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/UpdateInstanceProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/UpdateInstanceProfile) 

# UpdateNetworkProfile
<a name="API_UpdateNetworkProfile"></a>

Updates the network profile.

## Request Syntax
<a name="API_UpdateNetworkProfile_RequestSyntax"></a>

```
{
   "arn": "string",
   "description": "string",
   "downlinkBandwidthBits": number,
   "downlinkDelayMs": number,
   "downlinkJitterMs": number,
   "downlinkLossPercent": number,
   "name": "string",
   "type": "string",
   "uplinkBandwidthBits": number,
   "uplinkDelayMs": number,
   "uplinkJitterMs": number,
   "uplinkLossPercent": number
}
```

## Request Parameters
<a name="API_UpdateNetworkProfile_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_UpdateNetworkProfile_RequestSyntax) **   <a name="devicefarm-UpdateNetworkProfile-request-arn"></a>
The Amazon Resource Name (ARN) of the project for which you want to update network profile settings.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [description](#API_UpdateNetworkProfile_RequestSyntax) **   <a name="devicefarm-UpdateNetworkProfile-request-description"></a>
The description of the network profile about which you are returning information.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 16384.  
Required: No

 ** [downlinkBandwidthBits](#API_UpdateNetworkProfile_RequestSyntax) **   <a name="devicefarm-UpdateNetworkProfile-request-downlinkBandwidthBits"></a>
The data throughput rate in bits per second, as an integer from 0 to 104857600.  
Type: Long  
Required: No

 ** [downlinkDelayMs](#API_UpdateNetworkProfile_RequestSyntax) **   <a name="devicefarm-UpdateNetworkProfile-request-downlinkDelayMs"></a>
Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.  
Type: Long  
Required: No

 ** [downlinkJitterMs](#API_UpdateNetworkProfile_RequestSyntax) **   <a name="devicefarm-UpdateNetworkProfile-request-downlinkJitterMs"></a>
Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.  
Type: Long  
Required: No

 ** [downlinkLossPercent](#API_UpdateNetworkProfile_RequestSyntax) **   <a name="devicefarm-UpdateNetworkProfile-request-downlinkLossPercent"></a>
Proportion of received packets that fail to arrive from 0 to 100 percent.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** [name](#API_UpdateNetworkProfile_RequestSyntax) **   <a name="devicefarm-UpdateNetworkProfile-request-name"></a>
The name of the network profile about which you are returning information.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

 ** [type](#API_UpdateNetworkProfile_RequestSyntax) **   <a name="devicefarm-UpdateNetworkProfile-request-type"></a>
The type of network profile to return information about. Valid values are listed here.  
Type: String  
Valid Values: `CURATED | PRIVATE`   
Required: No

 ** [uplinkBandwidthBits](#API_UpdateNetworkProfile_RequestSyntax) **   <a name="devicefarm-UpdateNetworkProfile-request-uplinkBandwidthBits"></a>
The data throughput rate in bits per second, as an integer from 0 to 104857600.  
Type: Long  
Required: No

 ** [uplinkDelayMs](#API_UpdateNetworkProfile_RequestSyntax) **   <a name="devicefarm-UpdateNetworkProfile-request-uplinkDelayMs"></a>
Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.  
Type: Long  
Required: No

 ** [uplinkJitterMs](#API_UpdateNetworkProfile_RequestSyntax) **   <a name="devicefarm-UpdateNetworkProfile-request-uplinkJitterMs"></a>
Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.  
Type: Long  
Required: No

 ** [uplinkLossPercent](#API_UpdateNetworkProfile_RequestSyntax) **   <a name="devicefarm-UpdateNetworkProfile-request-uplinkLossPercent"></a>
Proportion of transmitted packets that fail to arrive from 0 to 100 percent.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

## Response Syntax
<a name="API_UpdateNetworkProfile_ResponseSyntax"></a>

```
{
   "networkProfile": { 
      "arn": "string",
      "description": "string",
      "downlinkBandwidthBits": number,
      "downlinkDelayMs": number,
      "downlinkJitterMs": number,
      "downlinkLossPercent": number,
      "name": "string",
      "type": "string",
      "uplinkBandwidthBits": number,
      "uplinkDelayMs": number,
      "uplinkJitterMs": number,
      "uplinkLossPercent": number
   }
}
```

## Response Elements
<a name="API_UpdateNetworkProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [networkProfile](#API_UpdateNetworkProfile_ResponseSyntax) **   <a name="devicefarm-UpdateNetworkProfile-response-networkProfile"></a>
A list of the available network profiles.  
Type: [NetworkProfile](API_NetworkProfile.md) object

## Errors
<a name="API_UpdateNetworkProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_UpdateNetworkProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/UpdateNetworkProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/UpdateNetworkProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/UpdateNetworkProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/UpdateNetworkProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/UpdateNetworkProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/UpdateNetworkProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/UpdateNetworkProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/UpdateNetworkProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/UpdateNetworkProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/UpdateNetworkProfile) 

# UpdateProject
<a name="API_UpdateProject"></a>

Modifies the specified project name, given the project ARN and a new name.

## Request Syntax
<a name="API_UpdateProject_RequestSyntax"></a>

```
{
   "arn": "string",
   "defaultJobTimeoutMinutes": number,
   "environmentVariables": [ 
      { 
         "name": "string",
         "value": "string"
      }
   ],
   "executionRoleArn": "string",
   "name": "string",
   "vpcConfig": { 
      "securityGroupIds": [ "string" ],
      "subnetIds": [ "string" ],
      "vpcId": "string"
   }
}
```

## Request Parameters
<a name="API_UpdateProject_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_UpdateProject_RequestSyntax) **   <a name="devicefarm-UpdateProject-request-arn"></a>
The Amazon Resource Name (ARN) of the project whose name to update.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [defaultJobTimeoutMinutes](#API_UpdateProject_RequestSyntax) **   <a name="devicefarm-UpdateProject-request-defaultJobTimeoutMinutes"></a>
The number of minutes a test run in the project executes before it times out.  
Type: Integer  
Required: No

 ** [environmentVariables](#API_UpdateProject_RequestSyntax) **   <a name="devicefarm-UpdateProject-request-environmentVariables"></a>
 A set of environment variables which are used by default for all runs in the project. These environment variables are applied to the test run during the execution of a test spec file.   
 For more information about using test spec files, please see [Custom test environments ](https://docs.aws.amazon.com/devicefarm/latest/developerguide/custom-test-environments.html) in *AWS Device Farm.*   
Type: Array of [EnvironmentVariable](API_EnvironmentVariable.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 32 items.  
Required: No

 ** [executionRoleArn](#API_UpdateProject_RequestSyntax) **   <a name="devicefarm-UpdateProject-request-executionRoleArn"></a>
An IAM role to be assumed by the test host for all runs in the project.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `^arn:aws:iam::[0-9]{12}:role/.+`   
Required: No

 ** [name](#API_UpdateProject_RequestSyntax) **   <a name="devicefarm-UpdateProject-request-name"></a>
A string that represents the new name of the project that you are updating.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

 ** [vpcConfig](#API_UpdateProject_RequestSyntax) **   <a name="devicefarm-UpdateProject-request-vpcConfig"></a>
The VPC security groups and subnets that are attached to a project.  
Type: [VpcConfig](API_VpcConfig.md) object  
Required: No

## Response Syntax
<a name="API_UpdateProject_ResponseSyntax"></a>

```
{
   "project": { 
      "arn": "string",
      "created": number,
      "defaultJobTimeoutMinutes": number,
      "environmentVariables": [ 
         { 
            "name": "string",
            "value": "string"
         }
      ],
      "executionRoleArn": "string",
      "name": "string",
      "vpcConfig": { 
         "securityGroupIds": [ "string" ],
         "subnetIds": [ "string" ],
         "vpcId": "string"
      }
   }
}
```

## Response Elements
<a name="API_UpdateProject_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [project](#API_UpdateProject_ResponseSyntax) **   <a name="devicefarm-UpdateProject-response-project"></a>
The project to update.  
Type: [Project](API_Project.md) object

## Errors
<a name="API_UpdateProject_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_UpdateProject_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/UpdateProject) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/UpdateProject) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/UpdateProject) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/UpdateProject) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/UpdateProject) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/UpdateProject) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/UpdateProject) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/UpdateProject) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/UpdateProject) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/UpdateProject) 

# UpdateTestGridProject
<a name="API_UpdateTestGridProject"></a>

Change details of a project.

## Request Syntax
<a name="API_UpdateTestGridProject_RequestSyntax"></a>

```
{
   "description": "string",
   "name": "string",
   "projectArn": "string",
   "vpcConfig": { 
      "securityGroupIds": [ "string" ],
      "subnetIds": [ "string" ],
      "vpcId": "string"
   }
}
```

## Request Parameters
<a name="API_UpdateTestGridProject_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [description](#API_UpdateTestGridProject_RequestSyntax) **   <a name="devicefarm-UpdateTestGridProject-request-description"></a>
Human-readable description for the project.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `.*\S.*`   
Required: No

 ** [name](#API_UpdateTestGridProject_RequestSyntax) **   <a name="devicefarm-UpdateTestGridProject-request-name"></a>
Human-readable name for the project.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `.*\S.*`   
Required: No

 ** [projectArn](#API_UpdateTestGridProject_RequestSyntax) **   <a name="devicefarm-UpdateTestGridProject-request-projectArn"></a>
ARN of the project to update.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [vpcConfig](#API_UpdateTestGridProject_RequestSyntax) **   <a name="devicefarm-UpdateTestGridProject-request-vpcConfig"></a>
The VPC security groups and subnets that are attached to a project.  
Type: [TestGridVpcConfig](API_TestGridVpcConfig.md) object  
Required: No

## Response Syntax
<a name="API_UpdateTestGridProject_ResponseSyntax"></a>

```
{
   "testGridProject": { 
      "arn": "string",
      "created": number,
      "description": "string",
      "name": "string",
      "vpcConfig": { 
         "securityGroupIds": [ "string" ],
         "subnetIds": [ "string" ],
         "vpcId": "string"
      }
   }
}
```

## Response Elements
<a name="API_UpdateTestGridProject_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [testGridProject](#API_UpdateTestGridProject_ResponseSyntax) **   <a name="devicefarm-UpdateTestGridProject-response-testGridProject"></a>
The project, including updated information.  
Type: [TestGridProject](API_TestGridProject.md) object

## Errors
<a name="API_UpdateTestGridProject_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ArgumentException **   
An invalid argument was specified.    
 ** message **   
Any additional information about the exception.
HTTP Status Code: 400

 ** InternalServiceException **   
An internal exception was raised in the service. Contact [aws-devicefarm-support@amazon.com](mailto:aws-devicefarm-support@amazon.com) if you see this error.   
HTTP Status Code: 500

 ** 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

## See Also
<a name="API_UpdateTestGridProject_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/UpdateTestGridProject) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/UpdateTestGridProject) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/UpdateTestGridProject) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/UpdateTestGridProject) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/UpdateTestGridProject) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/UpdateTestGridProject) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/UpdateTestGridProject) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/UpdateTestGridProject) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/UpdateTestGridProject) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/UpdateTestGridProject) 

# UpdateUpload
<a name="API_UpdateUpload"></a>

Updates an uploaded test spec.

## Request Syntax
<a name="API_UpdateUpload_RequestSyntax"></a>

```
{
   "arn": "string",
   "contentType": "string",
   "editContent": boolean,
   "name": "string"
}
```

## Request Parameters
<a name="API_UpdateUpload_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_UpdateUpload_RequestSyntax) **   <a name="devicefarm-UpdateUpload-request-arn"></a>
The Amazon Resource Name (ARN) of the uploaded test spec.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [contentType](#API_UpdateUpload_RequestSyntax) **   <a name="devicefarm-UpdateUpload-request-contentType"></a>
The upload's content type (for example, `application/x-yaml`).  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 64.  
Required: No

 ** [editContent](#API_UpdateUpload_RequestSyntax) **   <a name="devicefarm-UpdateUpload-request-editContent"></a>
Set to true if the YAML file has changed and must be updated. Otherwise, set to false.  
Type: Boolean  
Required: No

 ** [name](#API_UpdateUpload_RequestSyntax) **   <a name="devicefarm-UpdateUpload-request-name"></a>
The upload's test spec file name. The name must not contain any forward slashes (/). The test spec file name must end with the `.yaml` or `.yml` file extension.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_UpdateUpload_ResponseSyntax"></a>

```
{
   "upload": { 
      "arn": "string",
      "category": "string",
      "contentType": "string",
      "created": number,
      "message": "string",
      "metadata": "string",
      "name": "string",
      "status": "string",
      "type": "string",
      "url": "string"
   }
}
```

## Response Elements
<a name="API_UpdateUpload_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [upload](#API_UpdateUpload_ResponseSyntax) **   <a name="devicefarm-UpdateUpload-response-upload"></a>
A test spec uploaded to Device Farm.  
Type: [Upload](API_Upload.md) object

## Errors
<a name="API_UpdateUpload_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_UpdateUpload_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/UpdateUpload) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/UpdateUpload) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/UpdateUpload) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/UpdateUpload) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/UpdateUpload) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/UpdateUpload) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/UpdateUpload) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/UpdateUpload) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/UpdateUpload) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/UpdateUpload) 

# UpdateVPCEConfiguration
<a name="API_UpdateVPCEConfiguration"></a>

Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.

## Request Syntax
<a name="API_UpdateVPCEConfiguration_RequestSyntax"></a>

```
{
   "arn": "string",
   "serviceDnsName": "string",
   "vpceConfigurationDescription": "string",
   "vpceConfigurationName": "string",
   "vpceServiceName": "string"
}
```

## Request Parameters
<a name="API_UpdateVPCEConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [arn](#API_UpdateVPCEConfiguration_RequestSyntax) **   <a name="devicefarm-UpdateVPCEConfiguration-request-arn"></a>
The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to update.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 1011.  
Pattern: `^arn:aws:devicefarm:.+`   
Required: Yes

 ** [serviceDnsName](#API_UpdateVPCEConfiguration_RequestSyntax) **   <a name="devicefarm-UpdateVPCEConfiguration-request-serviceDnsName"></a>
The DNS (domain) name used to connect to your private service in your VPC. The DNS name must not already be in use on the internet.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** [vpceConfigurationDescription](#API_UpdateVPCEConfiguration_RequestSyntax) **   <a name="devicefarm-UpdateVPCEConfiguration-request-vpceConfigurationDescription"></a>
An optional description that provides details about your VPC endpoint configuration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** [vpceConfigurationName](#API_UpdateVPCEConfiguration_RequestSyntax) **   <a name="devicefarm-UpdateVPCEConfiguration-request-vpceConfigurationName"></a>
The friendly name you give to your VPC endpoint configuration to manage your configurations more easily.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** [vpceServiceName](#API_UpdateVPCEConfiguration_RequestSyntax) **   <a name="devicefarm-UpdateVPCEConfiguration-request-vpceServiceName"></a>
The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

## Response Syntax
<a name="API_UpdateVPCEConfiguration_ResponseSyntax"></a>

```
{
   "vpceConfiguration": { 
      "arn": "string",
      "serviceDnsName": "string",
      "vpceConfigurationDescription": "string",
      "vpceConfigurationName": "string",
      "vpceServiceName": "string"
   }
}
```

## Response Elements
<a name="API_UpdateVPCEConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [vpceConfiguration](#API_UpdateVPCEConfiguration_ResponseSyntax) **   <a name="devicefarm-UpdateVPCEConfiguration-response-vpceConfiguration"></a>
An object that contains information about your VPC endpoint configuration.  
Type: [VPCEConfiguration](API_VPCEConfiguration.md) object

## Errors
<a name="API_UpdateVPCEConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ArgumentException **   
An invalid argument was specified.    
 ** message **   
Any additional information about the exception.
HTTP Status Code: 400

 ** InvalidOperationException **   
There was an error with the update request, or you do not have sufficient permissions to update this VPC endpoint configuration.  
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

## See Also
<a name="API_UpdateVPCEConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/devicefarm-2015-06-23/UpdateVPCEConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/devicefarm-2015-06-23/UpdateVPCEConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/UpdateVPCEConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/devicefarm-2015-06-23/UpdateVPCEConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/devicefarm-2015-06-23/UpdateVPCEConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/devicefarm-2015-06-23/UpdateVPCEConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/devicefarm-2015-06-23/UpdateVPCEConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/UpdateVPCEConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/UpdateVPCEConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/UpdateVPCEConfiguration)