AWS SDK Version 2 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.

.NET Framework 4.5
 
Implementation 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

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.DeviceFarm.AmazonDeviceFarmClient

Namespace: Amazon.DeviceFarm
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class AmazonDeviceFarmClient : AmazonServiceClient
         IAmazonDeviceFarm, IDisposable

The AmazonDeviceFarmClient type exposes the following members

Constructors

NameDescription
Public Method AmazonDeviceFarmClient() Constructs AmazonDeviceFarmClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             
Public Method AmazonDeviceFarmClient(RegionEndpoint) Constructs AmazonDeviceFarmClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             
Public Method AmazonDeviceFarmClient(AmazonDeviceFarmConfig) Constructs AmazonDeviceFarmClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             
Public Method AmazonDeviceFarmClient(AWSCredentials) Constructs AmazonDeviceFarmClient with AWS Credentials
Public Method AmazonDeviceFarmClient(AWSCredentials, RegionEndpoint) Constructs AmazonDeviceFarmClient with AWS Credentials
Public Method AmazonDeviceFarmClient(AWSCredentials, AmazonDeviceFarmConfig) Constructs AmazonDeviceFarmClient with AWS Credentials and an AmazonDeviceFarmClient Configuration object.
Public Method AmazonDeviceFarmClient(string, string) Constructs AmazonDeviceFarmClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonDeviceFarmClient(string, string, RegionEndpoint) Constructs AmazonDeviceFarmClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonDeviceFarmClient(string, string, AmazonDeviceFarmConfig) Constructs AmazonDeviceFarmClient with AWS Access Key ID, AWS Secret Key and an AmazonDeviceFarmClient Configuration object.
Public Method AmazonDeviceFarmClient(string, string, string) Constructs AmazonDeviceFarmClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonDeviceFarmClient(string, string, string, RegionEndpoint) Constructs AmazonDeviceFarmClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonDeviceFarmClient(string, string, string, AmazonDeviceFarmConfig) Constructs AmazonDeviceFarmClient with AWS Access Key ID, AWS Secret Key and an AmazonDeviceFarmClient Configuration object.

Methods

NameDescription
Public Method CreateDevicePool(CreateDevicePoolRequest) Creates a device pool.
Public Method CreateDevicePoolAsync(CreateDevicePoolRequest, CancellationToken) Initiates the asynchronous execution of the CreateDevicePool operation.
Public Method CreateProject(string) Creates a new project.
Public Method CreateProject(CreateProjectRequest) Creates a new project.
Public Method CreateProjectAsync(CreateProjectRequest, CancellationToken) Initiates the asynchronous execution of the CreateProject 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 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 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 Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
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(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(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(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(GetJobRequest, CancellationToken) Initiates the asynchronous execution of the GetJob operation.
Public Method GetProject(string) Gets information about a project.
Public Method GetProject(GetProjectRequest) Gets information about a project.
Public Method GetProjectAsync(GetProjectRequest, CancellationToken) Initiates the asynchronous execution of the GetProject operation.
Public Method GetRun(string) Gets information about a run.
Public Method GetRun(GetRunRequest) 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(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(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(GetUploadRequest, CancellationToken) Initiates the asynchronous execution of the GetUpload 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 ListProjects(ListProjectsRequest) Gets information about projects.
Public Method ListProjectsAsync(ListProjectsRequest, CancellationToken) Initiates the asynchronous execution of the ListProjects operation.
Public Method ListRuns(ListRunsRequest) Gets information about runs.
Public Method ListRunsAsync(ListRunsRequest, CancellationToken) Initiates the asynchronous execution of the ListRuns operation.
Public Method ListSamples(ListSamplesRequest) Gets information about samples.
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.
Public Method ListUploadsAsync(ListUploadsRequest, CancellationToken) Initiates the asynchronous execution of the ListUploads operation.
Public Method ScheduleRun(ScheduleRunRequest) Schedules a run.
Public Method ScheduleRunAsync(ScheduleRunRequest, CancellationToken) Initiates the asynchronous execution of the ScheduleRun 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 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.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

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