# AWS Device Farm Documentation API Reference

> Welcome to the AWS Device Farm API documentation, which contains APIs for:

- [Welcome](https://docs.aws.amazon.com/devicefarm/latest/APIReference/Welcome.md)
- [Common Parameters](https://docs.aws.amazon.com/devicefarm/latest/APIReference/CommonParameters.md)
- [Common Error Types](https://docs.aws.amazon.com/devicefarm/latest/APIReference/CommonErrors.md)

## [Actions](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_Operations.md)

- [CreateDevicePool](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_CreateDevicePool.md): Creates a device pool.
- [CreateInstanceProfile](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_CreateInstanceProfile.md): Creates a profile that can be applied to one or more private fleet device instances.
- [CreateNetworkProfile](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_CreateNetworkProfile.md): Creates a network profile.
- [CreateProject](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_CreateProject.md): Creates a project.
- [CreateRemoteAccessSession](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_CreateRemoteAccessSession.md): Specifies and starts a remote access session.
- [CreateTestGridProject](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_CreateTestGridProject.md): Creates a Selenium testing project.
- [CreateTestGridUrl](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_CreateTestGridUrl.md): Creates a signed, short-term URL that can be passed to a Selenium RemoteWebDriver constructor.
- [CreateUpload](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_CreateUpload.md): Uploads an app or test scripts.
- [CreateVPCEConfiguration](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_CreateVPCEConfiguration.md): Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.
- [DeleteDevicePool](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_DeleteDevicePool.md): Deletes a device pool given the pool ARN.
- [DeleteInstanceProfile](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_DeleteInstanceProfile.md): Deletes a profile that can be applied to one or more private device instances.
- [DeleteNetworkProfile](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_DeleteNetworkProfile.md): Deletes a network profile.
- [DeleteProject](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_DeleteProject.md): Deletes an AWS Device Farm project, given the project ARN.
- [DeleteRemoteAccessSession](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_DeleteRemoteAccessSession.md): Deletes a completed remote access session and its results.
- [DeleteRun](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_DeleteRun.md): Deletes the run, given the run ARN.
- [DeleteTestGridProject](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_DeleteTestGridProject.md): Deletes a Selenium testing project and all content generated under it.
- [DeleteUpload](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_DeleteUpload.md): Deletes an upload given the upload ARN.
- [DeleteVPCEConfiguration](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_DeleteVPCEConfiguration.md): Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.
- [GetAccountSettings](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetAccountSettings.md): Returns the number of unmetered iOS or unmetered Android devices that have been purchased by the account.
- [GetDevice](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetDevice.md): Gets information about a unique device type.
- [GetDeviceInstance](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetDeviceInstance.md): Returns information about a device instance that belongs to a private device fleet.
- [GetDevicePool](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetDevicePool.md): Gets information about a device pool.
- [GetDevicePoolCompatibility](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetDevicePoolCompatibility.md): Gets information about compatibility with a device pool.
- [GetInstanceProfile](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetInstanceProfile.md): Returns information about the specified instance profile.
- [GetJob](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetJob.md): Gets information about a job.
- [GetNetworkProfile](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetNetworkProfile.md): Returns information about a network profile.
- [GetOfferingStatus](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetOfferingStatus.md): Gets the current status and future status of all offerings purchased by an AWS account.
- [GetProject](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetProject.md): Gets information about a project.
- [GetRemoteAccessSession](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetRemoteAccessSession.md): Returns a link to a currently running remote access session.
- [GetRun](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetRun.md): Gets information about a run.
- [GetSuite](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetSuite.md): Gets information about a suite.
- [GetTest](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetTest.md): Gets information about a test.
- [GetTestGridProject](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetTestGridProject.md): Retrieves information about a Selenium testing project.
- [GetTestGridSession](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetTestGridSession.md): A session is an instance of a browser created through a RemoteWebDriver with the URL from CreateTestGridUrl:url.
- [GetUpload](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetUpload.md): Gets information about an upload.
- [GetVPCEConfiguration](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_GetVPCEConfiguration.md): Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.
- [InstallToRemoteAccessSession](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_InstallToRemoteAccessSession.md): Installs an application to the device in a remote access session.
- [ListArtifacts](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListArtifacts.md): Gets information about artifacts.
- [ListDeviceInstances](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListDeviceInstances.md): Returns information about the private device instances associated with one or more AWS accounts.
- [ListDevicePools](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListDevicePools.md): Gets information about device pools.
- [ListDevices](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListDevices.md): Gets information about unique device types.
- [ListInstanceProfiles](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListInstanceProfiles.md): Returns information about all the instance profiles in an AWS account.
- [ListJobs](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListJobs.md): Gets information about jobs for a given test run.
- [ListNetworkProfiles](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListNetworkProfiles.md): Returns the list of available network profiles.
- [ListOfferingPromotions](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListOfferingPromotions.md): Returns a list of offering promotions.
- [ListOfferings](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListOfferings.md): Returns a list of products or offerings that the user can manage through the API.
- [ListOfferingTransactions](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListOfferingTransactions.md): Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account.
- [ListProjects](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListProjects.md): Gets information about projects.
- [ListRemoteAccessSessions](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListRemoteAccessSessions.md): Returns a list of all currently running remote access sessions.
- [ListRuns](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListRuns.md): Gets information about runs, given an AWS Device Farm project ARN.
- [ListSamples](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListSamples.md): Gets information about samples, given an AWS Device Farm job ARN.
- [ListSuites](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListSuites.md): Gets information about test suites for a given job.
- [ListTagsForResource](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListTagsForResource.md): List the tags for an AWS Device Farm resource.
- [ListTestGridProjects](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListTestGridProjects.md): Gets a list of all Selenium testing projects in your account.
- [ListTestGridSessionActions](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListTestGridSessionActions.md): Returns a list of the actions taken in a TestGridSession.
- [ListTestGridSessionArtifacts](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListTestGridSessionArtifacts.md): Retrieves a list of artifacts created during the session.
- [ListTestGridSessions](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListTestGridSessions.md): Retrieves a list of sessions for a TestGridProject.
- [ListTests](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListTests.md): Gets information about tests in a given test suite.
- [ListUniqueProblems](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListUniqueProblems.md): Gets information about unique problems, such as exceptions or crashes.
- [ListUploads](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListUploads.md): Gets information about uploads, given an AWS Device Farm project ARN.
- [ListVPCEConfigurations](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListVPCEConfigurations.md): Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.
- [PurchaseOffering](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_PurchaseOffering.md): Immediately purchases offerings for an AWS account.
- [RenewOffering](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_RenewOffering.md): Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period.
- [ScheduleRun](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ScheduleRun.md): Schedules a run.
- [StopJob](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_StopJob.md): Initiates a stop request for the current job.
- [StopRemoteAccessSession](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_StopRemoteAccessSession.md): Ends a specified remote access session.
- [StopRun](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_StopRun.md): Initiates a stop request for the current test run.
- [TagResource](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_TagResource.md): Associates the specified tags to a resource with the specified resourceArn.
- [UntagResource](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_UntagResource.md): Deletes the specified tags from a resource.
- [UpdateDeviceInstance](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_UpdateDeviceInstance.md): Updates information about a private device instance.
- [UpdateDevicePool](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_UpdateDevicePool.md): Modifies the name, description, and rules in a device pool given the attributes and the pool ARN.
- [UpdateInstanceProfile](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_UpdateInstanceProfile.md): Updates information about an existing private device instance profile.
- [UpdateNetworkProfile](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_UpdateNetworkProfile.md): Updates the network profile.
- [UpdateProject](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_UpdateProject.md): Modifies the specified project name, given the project ARN and a new name.
- [UpdateTestGridProject](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_UpdateTestGridProject.md): Change details of a project.
- [UpdateUpload](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_UpdateUpload.md): Updates an uploaded test spec.
- [UpdateVPCEConfiguration](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_UpdateVPCEConfiguration.md): Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.


## [Data Types](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_Types.md)

- [AccountSettings](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_AccountSettings.md): A container for account-level settings in AWS Device Farm.
- [Artifact](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_Artifact.md): Represents the output of a test.
- [Counters](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_Counters.md): Represents entity counters.
- [CPU](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_CPU.md): Represents the amount of CPU that an app is using on a physical device.
- [CreateRemoteAccessSessionConfiguration](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_CreateRemoteAccessSessionConfiguration.md): Configuration settings for a remote access session, including billing method.
- [CustomerArtifactPaths](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_CustomerArtifactPaths.md): A JSON object that specifies the paths where the artifacts generated by the customer's tests, on the device or in the test environment, are pulled from.
- [Device](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_Device.md): Represents a device type that an app is tested against.
- [DeviceFilter](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_DeviceFilter.md): Represents a device filter used to select a set of devices to be included in a test run.
- [DeviceInstance](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_DeviceInstance.md): Represents the device instance.
- [DeviceMinutes](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_DeviceMinutes.md): Represents the total (metered or unmetered) minutes used by the resource to run tests.
- [DevicePool](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_DevicePool.md): Represents a collection of device types.
- [DevicePoolCompatibilityResult](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_DevicePoolCompatibilityResult.md): Represents a device pool compatibility result.
- [DeviceProxy](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_DeviceProxy.md): Represents the http/s proxy configuration that will be applied to a device during a run.
- [DeviceSelectionConfiguration](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_DeviceSelectionConfiguration.md): Represents the device filters used in a test run and the maximum number of devices to be included in the run.
- [DeviceSelectionResult](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_DeviceSelectionResult.md): Contains the run results requested by the device selection configuration and how many devices were returned.
- [EnvironmentVariable](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_EnvironmentVariable.md): Information about an environment variable for a project or a run.
- [ExecutionConfiguration](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ExecutionConfiguration.md): Represents configuration information about a test run, such as the execution timeout (in minutes).
- [IncompatibilityMessage](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_IncompatibilityMessage.md): Represents information about incompatibility.
- [InstanceProfile](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_InstanceProfile.md): Represents the instance profile.
- [Job](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_Job.md): Represents a device.
- [JobInsights](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_JobInsights.md): Contains insights for a job, including report status, and test-level aggregated metrics such as per test execution time and median test execution time.
- [JobReport](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_JobReport.md): Contains aggregated job-level metrics for a run.
- [JobReportMetrics](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_JobReportMetrics.md): Contains aggregated metrics across all jobs in a run.
- [ListTestGridProjectsRequest](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListTestGridProjectsRequest.md)
- [ListTestGridSessionsRequest](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ListTestGridSessionsRequest.md)
- [Location](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_Location.md): Represents a latitude and longitude pair, expressed in geographic coordinate system degrees (for example, 47.6204, -122.3491).
- [MonetaryAmount](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_MonetaryAmount.md): A number that represents the monetary amount for an offering or transaction.
- [NetworkProfile](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_NetworkProfile.md): An array of settings that describes characteristics of a network profile.
- [Offering](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_Offering.md): Represents the metadata of a device offering.
- [OfferingPromotion](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_OfferingPromotion.md): Represents information about an offering promotion.
- [OfferingStatus](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_OfferingStatus.md): The status of the offering.
- [OfferingTransaction](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_OfferingTransaction.md): Represents the metadata of an offering transaction.
- [Problem](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_Problem.md): Represents a specific warning or failure.
- [ProblemDetail](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ProblemDetail.md): Information about a problem detail.
- [Project](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_Project.md): Represents an operating-system neutral workspace for running and managing tests.
- [Radios](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_Radios.md): Represents the set of radios and their states on a device.
- [RecurringCharge](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_RecurringCharge.md): Specifies whether charges for devices are recurring.
- [RemoteAccessEndpoints](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_RemoteAccessEndpoints.md): Represents the remote endpoints for viewing and controlling a device during a remote access session.
- [RemoteAccessSession](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_RemoteAccessSession.md): Represents information about the remote access session.
- [Resolution](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_Resolution.md): Represents the screen resolution of a device in height and width, expressed in pixels.
- [Rule](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_Rule.md): Represents a condition for a device pool.
- [Run](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_Run.md): Represents a test run on a set of devices with a given app package, test parameters, and so on.
- [RunInsights](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_RunInsights.md): Contains insights for a run, including report status, and job-level aggregated metrics such as per job execution time and median job execution time.
- [Sample](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_Sample.md): Represents a sample of performance data.
- [ScheduleRunConfiguration](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ScheduleRunConfiguration.md): Represents the settings for a run.
- [ScheduleRunTest](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_ScheduleRunTest.md): Represents test settings.
- [Suite](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_Suite.md): Represents a collection of one or more tests.
- [Tag](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_Tag.md): The metadata that you apply to a resource to help you categorize and organize it.
- [Test](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_Test.md): Represents a condition that is evaluated.
- [TestGridProject](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_TestGridProject.md): A Selenium testing project.
- [TestGridSession](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_TestGridSession.md): A TestGridSession is a single instance of a browser launched from the URL provided by a call to CreateTestGridUrl.
- [TestGridSessionAction](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_TestGridSessionAction.md): An action taken by a TestGridSession browser instance.
- [TestGridSessionArtifact](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_TestGridSessionArtifact.md): Artifacts are video and other files that are produced in the process of running a browser in an automated context.
- [TestGridVpcConfig](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_TestGridVpcConfig.md): The VPC security groups and subnets that are attached to a project.
- [TestReport](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_TestReport.md): Contains aggregated test-level metrics for a job.
- [TestReportMetrics](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_TestReportMetrics.md): Contains aggregated metrics across all tests in a job.
- [TrialMinutes](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_TrialMinutes.md): Represents information about free trial device minutes for an AWS account.
- [UniqueProblem](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_UniqueProblem.md): A collection of one or more problems, grouped by their result.
- [Upload](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_Upload.md): An app or a set of one or more tests to upload or that have been uploaded.
- [VpcConfig](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_VpcConfig.md): Contains the VPC configuration data necessary to interface with AWS Device Farm's services.
- [VPCEConfiguration](https://docs.aws.amazon.com/devicefarm/latest/APIReference/API_VPCEConfiguration.md): Represents an Amazon Virtual Private Cloud (VPC) endpoint configuration.


## Full content

The entire guide is also available as a single markdown file, useful for feeding the full guide to an LLM in one pass:

- [Complete guide (single file)](https://docs.aws.amazon.com/devicefarm/latest/APIReference/full.md)