AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing DeviceFarm AWS Device Farm is a service that enables mobile app developers to test Android, iOS, and Fire OS apps on physical phones, tablets, and other devices in the cloud.

Inheritance Hierarchy

Amazon.DeviceFarm.IAmazonDeviceFarm

Namespace: Amazon.DeviceFarm
Assembly: AWSSDK.DeviceFarm.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonDeviceFarm
         IAmazonService, IDisposable

The IAmazonDeviceFarm type exposes the following members

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CreateDevicePool(CreateDevicePoolRequest)

Creates a device pool.

Public Method CreateDevicePoolAsync(CreateDevicePoolRequest, CancellationToken)

Initiates the asynchronous execution of the CreateDevicePool operation.

Public Method CreateNetworkProfile(CreateNetworkProfileRequest)

Creates a network profile.

Public Method CreateNetworkProfileAsync(CreateNetworkProfileRequest, CancellationToken)

Initiates the asynchronous execution of the CreateNetworkProfile operation.

Public Method CreateProject(string)

Creates a new project.

Public Method CreateProject(CreateProjectRequest)

Creates a new project.

Public Method CreateProjectAsync(string, CancellationToken)

Creates a new project.

Public Method CreateProjectAsync(CreateProjectRequest, CancellationToken)

Initiates the asynchronous execution of the CreateProject operation.

Public Method CreateRemoteAccessSession(CreateRemoteAccessSessionRequest)

Specifies and starts a remote access session.

Public Method CreateRemoteAccessSessionAsync(CreateRemoteAccessSessionRequest, CancellationToken)

Initiates the asynchronous execution of the CreateRemoteAccessSession operation.

Public Method CreateUpload(CreateUploadRequest)

Uploads an app or test scripts.

Public Method CreateUploadAsync(CreateUploadRequest, CancellationToken)

Initiates the asynchronous execution of the CreateUpload operation.

Public Method DeleteDevicePool(DeleteDevicePoolRequest)

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

Public Method DeleteDevicePoolAsync(DeleteDevicePoolRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteDevicePool operation.

Public Method DeleteNetworkProfile(DeleteNetworkProfileRequest)

Deletes a network profile.

Public Method DeleteNetworkProfileAsync(DeleteNetworkProfileRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteNetworkProfile operation.

Public Method DeleteProject(DeleteProjectRequest)

Deletes an AWS Device Farm project, given the project ARN.

Note Deleting this resource does not stop an in-progress run.

Public Method DeleteProjectAsync(DeleteProjectRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteProject operation.

Public Method DeleteRemoteAccessSession(DeleteRemoteAccessSessionRequest)

Deletes a completed remote access session and its results.

Public Method DeleteRemoteAccessSessionAsync(DeleteRemoteAccessSessionRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteRemoteAccessSession operation.

Public Method DeleteRun(DeleteRunRequest)

Deletes the run, given the run ARN.

Note Deleting this resource does not stop an in-progress run.

Public Method DeleteRunAsync(DeleteRunRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteRun operation.

Public Method DeleteUpload(DeleteUploadRequest)

Deletes an upload given the upload ARN.

Public Method DeleteUploadAsync(DeleteUploadRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteUpload operation.

Public Method GetAccountSettings()

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

Public Method GetAccountSettings(GetAccountSettingsRequest)

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

Public Method GetAccountSettingsAsync(CancellationToken)

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

Public Method GetAccountSettingsAsync(GetAccountSettingsRequest, CancellationToken)

Initiates the asynchronous execution of the GetAccountSettings operation.

Public Method GetDevice(string)

Gets information about a unique device type.

Public Method GetDevice(GetDeviceRequest)

Gets information about a unique device type.

Public Method GetDeviceAsync(string, CancellationToken)

Gets information about a unique device type.

Public Method GetDeviceAsync(GetDeviceRequest, CancellationToken)

Initiates the asynchronous execution of the GetDevice operation.

Public Method GetDevicePool(string)

Gets information about a device pool.

Public Method GetDevicePool(GetDevicePoolRequest)

Gets information about a device pool.

Public Method GetDevicePoolAsync(string, CancellationToken)

Gets information about a device pool.

Public Method GetDevicePoolAsync(GetDevicePoolRequest, CancellationToken)

Initiates the asynchronous execution of the GetDevicePool operation.

Public Method GetDevicePoolCompatibility(GetDevicePoolCompatibilityRequest)

Gets information about compatibility with a device pool.

Public Method GetDevicePoolCompatibilityAsync(GetDevicePoolCompatibilityRequest, CancellationToken)

Initiates the asynchronous execution of the GetDevicePoolCompatibility operation.

Public Method GetJob(string)

Gets information about a job.

Public Method GetJob(GetJobRequest)

Gets information about a job.

Public Method GetJobAsync(string, CancellationToken)

Gets information about a job.

Public Method GetJobAsync(GetJobRequest, CancellationToken)

Initiates the asynchronous execution of the GetJob operation.

Public Method GetNetworkProfile(GetNetworkProfileRequest)

Returns information about a network profile.

Public Method GetNetworkProfileAsync(GetNetworkProfileRequest, CancellationToken)

Initiates the asynchronous execution of the GetNetworkProfile operation.

Public Method GetOfferingStatus(GetOfferingStatusRequest)

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. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

Public Method GetOfferingStatusAsync(GetOfferingStatusRequest, CancellationToken)

Initiates the asynchronous execution of the GetOfferingStatus operation.

Public Method GetProject(string)

Gets information about a project.

Public Method GetProject(GetProjectRequest)

Gets information about a project.

Public Method GetProjectAsync(string, CancellationToken)

Gets information about a project.

Public Method GetProjectAsync(GetProjectRequest, CancellationToken)

Initiates the asynchronous execution of the GetProject operation.

Public Method GetRemoteAccessSession(GetRemoteAccessSessionRequest)

Returns a link to a currently running remote access session.

Public Method GetRemoteAccessSessionAsync(GetRemoteAccessSessionRequest, CancellationToken)

Initiates the asynchronous execution of the GetRemoteAccessSession operation.

Public Method GetRun(string)

Gets information about a run.

Public Method GetRun(GetRunRequest)

Gets information about a run.

Public Method GetRunAsync(string, CancellationToken)

Gets information about a run.

Public Method GetRunAsync(GetRunRequest, CancellationToken)

Initiates the asynchronous execution of the GetRun operation.

Public Method GetSuite(string)

Gets information about a suite.

Public Method GetSuite(GetSuiteRequest)

Gets information about a suite.

Public Method GetSuiteAsync(string, CancellationToken)

Gets information about a suite.

Public Method GetSuiteAsync(GetSuiteRequest, CancellationToken)

Initiates the asynchronous execution of the GetSuite operation.

Public Method GetTest(string)

Gets information about a test.

Public Method GetTest(GetTestRequest)

Gets information about a test.

Public Method GetTestAsync(string, CancellationToken)

Gets information about a test.

Public Method GetTestAsync(GetTestRequest, CancellationToken)

Initiates the asynchronous execution of the GetTest operation.

Public Method GetUpload(string)

Gets information about an upload.

Public Method GetUpload(GetUploadRequest)

Gets information about an upload.

Public Method GetUploadAsync(string, CancellationToken)

Gets information about an upload.

Public Method GetUploadAsync(GetUploadRequest, CancellationToken)

Initiates the asynchronous execution of the GetUpload operation.

Public Method InstallToRemoteAccessSession(InstallToRemoteAccessSessionRequest)

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.

Public Method InstallToRemoteAccessSessionAsync(InstallToRemoteAccessSessionRequest, CancellationToken)

Initiates the asynchronous execution of the InstallToRemoteAccessSession operation.

Public Method ListArtifacts(ListArtifactsRequest)

Gets information about artifacts.

Public Method ListArtifactsAsync(ListArtifactsRequest, CancellationToken)

Initiates the asynchronous execution of the ListArtifacts operation.

Public Method ListDevicePools(ListDevicePoolsRequest)

Gets information about device pools.

Public Method ListDevicePoolsAsync(ListDevicePoolsRequest, CancellationToken)

Initiates the asynchronous execution of the ListDevicePools operation.

Public Method ListDevices(ListDevicesRequest)

Gets information about unique device types.

Public Method ListDevicesAsync(ListDevicesRequest, CancellationToken)

Initiates the asynchronous execution of the ListDevices operation.

Public Method ListJobs(ListJobsRequest)

Gets information about jobs.

Public Method ListJobsAsync(ListJobsRequest, CancellationToken)

Initiates the asynchronous execution of the ListJobs operation.

Public Method ListNetworkProfiles(ListNetworkProfilesRequest)

Returns the list of available network profiles.

Public Method ListNetworkProfilesAsync(ListNetworkProfilesRequest, CancellationToken)

Initiates the asynchronous execution of the ListNetworkProfiles operation.

Public Method ListOfferingPromotions(ListOfferingPromotionsRequest)

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 if you believe that you should be able to invoke this operation.

Public Method ListOfferingPromotionsAsync(ListOfferingPromotionsRequest, CancellationToken)

Initiates the asynchronous execution of the ListOfferingPromotions operation.

Public Method ListOfferings(ListOfferingsRequest)

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. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

Public Method ListOfferingsAsync(ListOfferingsRequest, CancellationToken)

Initiates the asynchronous execution of the ListOfferings operation.

Public Method ListOfferingTransactions(ListOfferingTransactionsRequest)

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. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

Public Method ListOfferingTransactionsAsync(ListOfferingTransactionsRequest, CancellationToken)

Initiates the asynchronous execution of the ListOfferingTransactions operation.

Public Method ListProjects(ListProjectsRequest)

Gets information about projects.

Public Method ListProjectsAsync(ListProjectsRequest, CancellationToken)

Initiates the asynchronous execution of the ListProjects operation.

Public Method ListRemoteAccessSessions(ListRemoteAccessSessionsRequest)

Returns a list of all currently running remote access sessions.

Public Method ListRemoteAccessSessionsAsync(ListRemoteAccessSessionsRequest, CancellationToken)

Initiates the asynchronous execution of the ListRemoteAccessSessions operation.

Public Method ListRuns(ListRunsRequest)

Gets information about runs, given an AWS Device Farm project ARN.

Public Method ListRunsAsync(ListRunsRequest, CancellationToken)

Initiates the asynchronous execution of the ListRuns operation.

Public Method ListSamples(ListSamplesRequest)

Gets information about samples, given an AWS Device Farm project ARN

Public Method ListSamplesAsync(ListSamplesRequest, CancellationToken)

Initiates the asynchronous execution of the ListSamples operation.

Public Method ListSuites(ListSuitesRequest)

Gets information about suites.

Public Method ListSuitesAsync(ListSuitesRequest, CancellationToken)

Initiates the asynchronous execution of the ListSuites operation.

Public Method ListTests(ListTestsRequest)

Gets information about tests.

Public Method ListTestsAsync(ListTestsRequest, CancellationToken)

Initiates the asynchronous execution of the ListTests operation.

Public Method ListUniqueProblems(ListUniqueProblemsRequest)

Gets information about unique problems.

Public Method ListUniqueProblemsAsync(ListUniqueProblemsRequest, CancellationToken)

Initiates the asynchronous execution of the ListUniqueProblems operation.

Public Method ListUploads(ListUploadsRequest)

Gets information about uploads, given an AWS Device Farm project ARN.

Public Method ListUploadsAsync(ListUploadsRequest, CancellationToken)

Initiates the asynchronous execution of the ListUploads operation.

Public Method PurchaseOffering(PurchaseOfferingRequest)

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. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

Public Method PurchaseOfferingAsync(PurchaseOfferingRequest, CancellationToken)

Initiates the asynchronous execution of the PurchaseOffering operation.

Public Method RenewOffering(RenewOfferingRequest)

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. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

Public Method RenewOfferingAsync(RenewOfferingRequest, CancellationToken)

Initiates the asynchronous execution of the RenewOffering operation.

Public Method ScheduleRun(ScheduleRunRequest)

Schedules a run.

Public Method ScheduleRunAsync(ScheduleRunRequest, CancellationToken)

Initiates the asynchronous execution of the ScheduleRun operation.

Public Method StopRemoteAccessSession(StopRemoteAccessSessionRequest)

Ends a specified remote access session.

Public Method StopRemoteAccessSessionAsync(StopRemoteAccessSessionRequest, CancellationToken)

Initiates the asynchronous execution of the StopRemoteAccessSession operation.

Public Method StopRun(StopRunRequest)

Initiates a stop request for the current test run. AWS Device Farm will immediately stop the run on devices where tests have not started executing, and you will not be billed for these devices. On devices where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on those devices. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.

Public Method StopRunAsync(StopRunRequest, CancellationToken)

Initiates the asynchronous execution of the StopRun operation.

Public Method UpdateDevicePool(UpdateDevicePoolRequest)

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).

Public Method UpdateDevicePoolAsync(UpdateDevicePoolRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateDevicePool operation.

Public Method UpdateNetworkProfile(UpdateNetworkProfileRequest)

Updates the network profile with specific settings.

Public Method UpdateNetworkProfileAsync(UpdateNetworkProfileRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateNetworkProfile operation.

Public Method UpdateProject(UpdateProjectRequest)

Modifies the specified project name, given the project ARN and a new name.

Public Method UpdateProjectAsync(UpdateProjectRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateProject operation.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms