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 3.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 BeginCreateDevicePool(CreateDevicePoolRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreateDevicePool operation.
Public Method BeginCreateProject(CreateProjectRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreateProject operation.
Public Method BeginCreateUpload(CreateUploadRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreateUpload operation.
Public Method BeginDeleteDevicePool(DeleteDevicePoolRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteDevicePool operation.
Public Method BeginDeleteProject(DeleteProjectRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteProject operation.
Public Method BeginDeleteRun(DeleteRunRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteRun operation.
Public Method BeginDeleteUpload(DeleteUploadRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteUpload operation.
Public Method BeginGetAccountSettings(GetAccountSettingsRequest, AsyncCallback, object) Initiates the asynchronous execution of the GetAccountSettings operation.
Public Method BeginGetDevice(GetDeviceRequest, AsyncCallback, object) Initiates the asynchronous execution of the GetDevice operation.
Public Method BeginGetDevicePool(GetDevicePoolRequest, AsyncCallback, object) Initiates the asynchronous execution of the GetDevicePool operation.
Public Method BeginGetDevicePoolCompatibility(GetDevicePoolCompatibilityRequest, AsyncCallback, object) Initiates the asynchronous execution of the GetDevicePoolCompatibility operation.
Public Method BeginGetJob(GetJobRequest, AsyncCallback, object) Initiates the asynchronous execution of the GetJob operation.
Public Method BeginGetProject(GetProjectRequest, AsyncCallback, object) Initiates the asynchronous execution of the GetProject operation.
Public Method BeginGetRun(GetRunRequest, AsyncCallback, object) Initiates the asynchronous execution of the GetRun operation.
Public Method BeginGetSuite(GetSuiteRequest, AsyncCallback, object) Initiates the asynchronous execution of the GetSuite operation.
Public Method BeginGetTest(GetTestRequest, AsyncCallback, object) Initiates the asynchronous execution of the GetTest operation.
Public Method BeginGetUpload(GetUploadRequest, AsyncCallback, object) Initiates the asynchronous execution of the GetUpload operation.
Public Method BeginListArtifacts(ListArtifactsRequest, AsyncCallback, object) Initiates the asynchronous execution of the ListArtifacts operation.
Public Method BeginListDevicePools(ListDevicePoolsRequest, AsyncCallback, object) Initiates the asynchronous execution of the ListDevicePools operation.
Public Method BeginListDevices(ListDevicesRequest, AsyncCallback, object) Initiates the asynchronous execution of the ListDevices operation.
Public Method BeginListJobs(ListJobsRequest, AsyncCallback, object) Initiates the asynchronous execution of the ListJobs operation.
Public Method BeginListProjects(ListProjectsRequest, AsyncCallback, object) Initiates the asynchronous execution of the ListProjects operation.
Public Method BeginListRuns(ListRunsRequest, AsyncCallback, object) Initiates the asynchronous execution of the ListRuns operation.
Public Method BeginListSamples(ListSamplesRequest, AsyncCallback, object) Initiates the asynchronous execution of the ListSamples operation.
Public Method BeginListSuites(ListSuitesRequest, AsyncCallback, object) Initiates the asynchronous execution of the ListSuites operation.
Public Method BeginListTests(ListTestsRequest, AsyncCallback, object) Initiates the asynchronous execution of the ListTests operation.
Public Method BeginListUniqueProblems(ListUniqueProblemsRequest, AsyncCallback, object) Initiates the asynchronous execution of the ListUniqueProblems operation.
Public Method BeginListUploads(ListUploadsRequest, AsyncCallback, object) Initiates the asynchronous execution of the ListUploads operation.
Public Method BeginScheduleRun(ScheduleRunRequest, AsyncCallback, object) Initiates the asynchronous execution of the ScheduleRun operation.
Public Method BeginUpdateDevicePool(UpdateDevicePoolRequest, AsyncCallback, object) Initiates the asynchronous execution of the UpdateDevicePool operation.
Public Method BeginUpdateProject(UpdateProjectRequest, AsyncCallback, object) Initiates the asynchronous execution of the UpdateProject operation.
Public Method CreateDevicePool(CreateDevicePoolRequest) Creates a device pool.
Public Method CreateProject(string) Creates a new project.
Public Method CreateProject(CreateProjectRequest) Creates a new project.
Public Method CreateUpload(CreateUploadRequest) Uploads an app or test scripts.
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 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 DeleteRun(DeleteRunRequest) Deletes the run, given the run ARN.

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

Public Method DeleteUpload(DeleteUploadRequest) Deletes an upload given the upload ARN.
Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method EndCreateDevicePool(IAsyncResult) Finishes the asynchronous execution of the CreateDevicePool operation.
Public Method EndCreateProject(IAsyncResult) Finishes the asynchronous execution of the CreateProject operation.
Public Method EndCreateUpload(IAsyncResult) Finishes the asynchronous execution of the CreateUpload operation.
Public Method EndDeleteDevicePool(IAsyncResult) Finishes the asynchronous execution of the DeleteDevicePool operation.
Public Method EndDeleteProject(IAsyncResult) Finishes the asynchronous execution of the DeleteProject operation.
Public Method EndDeleteRun(IAsyncResult) Finishes the asynchronous execution of the DeleteRun operation.
Public Method EndDeleteUpload(IAsyncResult) Finishes the asynchronous execution of the DeleteUpload operation.
Public Method EndGetAccountSettings(IAsyncResult) Finishes the asynchronous execution of the GetAccountSettings operation.
Public Method EndGetDevice(IAsyncResult) Finishes the asynchronous execution of the GetDevice operation.
Public Method EndGetDevicePool(IAsyncResult) Finishes the asynchronous execution of the GetDevicePool operation.
Public Method EndGetDevicePoolCompatibility(IAsyncResult) Finishes the asynchronous execution of the GetDevicePoolCompatibility operation.
Public Method EndGetJob(IAsyncResult) Finishes the asynchronous execution of the GetJob operation.
Public Method EndGetProject(IAsyncResult) Finishes the asynchronous execution of the GetProject operation.
Public Method EndGetRun(IAsyncResult) Finishes the asynchronous execution of the GetRun operation.
Public Method EndGetSuite(IAsyncResult) Finishes the asynchronous execution of the GetSuite operation.
Public Method EndGetTest(IAsyncResult) Finishes the asynchronous execution of the GetTest operation.
Public Method EndGetUpload(IAsyncResult) Finishes the asynchronous execution of the GetUpload operation.
Public Method EndListArtifacts(IAsyncResult) Finishes the asynchronous execution of the ListArtifacts operation.
Public Method EndListDevicePools(IAsyncResult) Finishes the asynchronous execution of the ListDevicePools operation.
Public Method EndListDevices(IAsyncResult) Finishes the asynchronous execution of the ListDevices operation.
Public Method EndListJobs(IAsyncResult) Finishes the asynchronous execution of the ListJobs operation.
Public Method EndListProjects(IAsyncResult) Finishes the asynchronous execution of the ListProjects operation.
Public Method EndListRuns(IAsyncResult) Finishes the asynchronous execution of the ListRuns operation.
Public Method EndListSamples(IAsyncResult) Finishes the asynchronous execution of the ListSamples operation.
Public Method EndListSuites(IAsyncResult) Finishes the asynchronous execution of the ListSuites operation.
Public Method EndListTests(IAsyncResult) Finishes the asynchronous execution of the ListTests operation.
Public Method EndListUniqueProblems(IAsyncResult) Finishes the asynchronous execution of the ListUniqueProblems operation.
Public Method EndListUploads(IAsyncResult) Finishes the asynchronous execution of the ListUploads operation.
Public Method EndScheduleRun(IAsyncResult) Finishes the asynchronous execution of the ScheduleRun operation.
Public Method EndUpdateDevicePool(IAsyncResult) Finishes the asynchronous execution of the UpdateDevicePool operation.
Public Method EndUpdateProject(IAsyncResult) Finishes the asynchronous execution of the UpdateProject 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 GetDevice(string) Gets information about a unique device type.
Public Method GetDevice(GetDeviceRequest) Gets information about a unique device type.
Public Method GetDevicePool(string) Gets information about a device pool.
Public Method GetDevicePool(GetDevicePoolRequest) Gets information about a device pool.
Public Method GetDevicePoolCompatibility(GetDevicePoolCompatibilityRequest) Gets information about compatibility with a device pool.
Public Method GetJob(string) Gets information about a job.
Public Method GetJob(GetJobRequest) Gets information about a job.
Public Method GetProject(string) Gets information about a project.
Public Method GetProject(GetProjectRequest) Gets information about a project.
Public Method GetRun(string) Gets information about a run.
Public Method GetRun(GetRunRequest) Gets information about a run.
Public Method GetSuite(string) Gets information about a suite.
Public Method GetSuite(GetSuiteRequest) Gets information about a suite.
Public Method GetTest(string) Gets information about a test.
Public Method GetTest(GetTestRequest) Gets information about a test.
Public Method GetUpload(string) Gets information about an upload.
Public Method GetUpload(GetUploadRequest) Gets information about an upload.
Public Method ListArtifacts(ListArtifactsRequest) Gets information about artifacts.
Public Method ListDevicePools(ListDevicePoolsRequest) Gets information about device pools.
Public Method ListDevices(ListDevicesRequest) Gets information about unique device types.
Public Method ListJobs(ListJobsRequest) Gets information about jobs.
Public Method ListProjects(ListProjectsRequest) Gets information about projects.
Public Method ListRuns(ListRunsRequest) Gets information about runs.
Public Method ListSamples(ListSamplesRequest) Gets information about samples.
Public Method ListSuites(ListSuitesRequest) Gets information about suites.
Public Method ListTests(ListTestsRequest) Gets information about tests.
Public Method ListUniqueProblems(ListUniqueProblemsRequest) Gets information about unique problems.
Public Method ListUploads(ListUploadsRequest) Gets information about uploads.
Public Method ScheduleRun(ScheduleRunRequest) Schedules a run.
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 UpdateProject(UpdateProjectRequest) Modifies the specified project name, given the project ARN and a new name.

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