com.amazonaws.services.devicefarm

Class AWSDeviceFarmClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.devicefarm.AWSDeviceFarmClient

All Implemented Interfaces:

AWSDeviceFarm

Direct Known Subclasses:

AWSDeviceFarmAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSDeviceFarmClient
extends AmazonWebServiceClient
implements AWSDeviceFarm

Client for accessing AWS Device Farm. All service calls made using this client are blocking, and will not return until the service call completes.

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.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.devicefarm.AWSDeviceFarm

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AWSDeviceFarmClient() Deprecated. use AWSDeviceFarmClientBuilder.defaultClient()
AWSDeviceFarmClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSDeviceFarmClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AWSDeviceFarmClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSDeviceFarmClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AWSDeviceFarmClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSDeviceFarmClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AWSDeviceFarmClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
static AWSDeviceFarmClientBuilder	builder()
CreateDevicePoolResult	createDevicePool(CreateDevicePoolRequest request) Creates a device pool.
CreateNetworkProfileResult	createNetworkProfile(CreateNetworkProfileRequest request) Creates a network profile.
CreateProjectResult	createProject(CreateProjectRequest request) Creates a new project.
CreateRemoteAccessSessionResult	createRemoteAccessSession(CreateRemoteAccessSessionRequest request) Specifies and starts a remote access session.
CreateUploadResult	createUpload(CreateUploadRequest request) Uploads an app or test scripts.
DeleteDevicePoolResult	deleteDevicePool(DeleteDevicePoolRequest request) Deletes a device pool given the pool ARN.
DeleteNetworkProfileResult	deleteNetworkProfile(DeleteNetworkProfileRequest request) Deletes a network profile.
DeleteProjectResult	deleteProject(DeleteProjectRequest request) Deletes an AWS Device Farm project, given the project ARN.
DeleteRemoteAccessSessionResult	deleteRemoteAccessSession(DeleteRemoteAccessSessionRequest request) Deletes a completed remote access session and its results.
DeleteRunResult	deleteRun(DeleteRunRequest request) Deletes the run, given the run ARN.
DeleteUploadResult	deleteUpload(DeleteUploadRequest request) Deletes an upload given the upload ARN.
GetAccountSettingsResult	getAccountSettings(GetAccountSettingsRequest request) Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetDeviceResult	getDevice(GetDeviceRequest request) Gets information about a unique device type.
GetDevicePoolResult	getDevicePool(GetDevicePoolRequest request) Gets information about a device pool.
GetDevicePoolCompatibilityResult	getDevicePoolCompatibility(GetDevicePoolCompatibilityRequest request) Gets information about compatibility with a device pool.
GetJobResult	getJob(GetJobRequest request) Gets information about a job.
GetNetworkProfileResult	getNetworkProfile(GetNetworkProfileRequest request) Returns information about a network profile.
GetOfferingStatusResult	getOfferingStatus(GetOfferingStatusRequest request) Gets the current status and future status of all offerings purchased by an AWS account.
GetProjectResult	getProject(GetProjectRequest request) Gets information about a project.
GetRemoteAccessSessionResult	getRemoteAccessSession(GetRemoteAccessSessionRequest request) Returns a link to a currently running remote access session.
GetRunResult	getRun(GetRunRequest request) Gets information about a run.
GetSuiteResult	getSuite(GetSuiteRequest request) Gets information about a suite.
GetTestResult	getTest(GetTestRequest request) Gets information about a test.
GetUploadResult	getUpload(GetUploadRequest request) Gets information about an upload.
InstallToRemoteAccessSessionResult	installToRemoteAccessSession(InstallToRemoteAccessSessionRequest request) Installs an application to the device in a remote access session.
ListArtifactsResult	listArtifacts(ListArtifactsRequest request) Gets information about artifacts.
ListDevicePoolsResult	listDevicePools(ListDevicePoolsRequest request) Gets information about device pools.
ListDevicesResult	listDevices(ListDevicesRequest request) Gets information about unique device types.
ListJobsResult	listJobs(ListJobsRequest request) Gets information about jobs.
ListNetworkProfilesResult	listNetworkProfiles(ListNetworkProfilesRequest request) Returns the list of available network profiles.
ListOfferingPromotionsResult	listOfferingPromotions(ListOfferingPromotionsRequest request) Returns a list of offering promotions.
ListOfferingsResult	listOfferings(ListOfferingsRequest request) Returns a list of products or offerings that the user can manage through the API.
ListOfferingTransactionsResult	listOfferingTransactions(ListOfferingTransactionsRequest request) Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account.
ListProjectsResult	listProjects(ListProjectsRequest request) Gets information about projects.
ListRemoteAccessSessionsResult	listRemoteAccessSessions(ListRemoteAccessSessionsRequest request) Returns a list of all currently running remote access sessions.
ListRunsResult	listRuns(ListRunsRequest request) Gets information about runs, given an AWS Device Farm project ARN.
ListSamplesResult	listSamples(ListSamplesRequest request) Gets information about samples, given an AWS Device Farm project ARN
ListSuitesResult	listSuites(ListSuitesRequest request) Gets information about suites.
ListTestsResult	listTests(ListTestsRequest request) Gets information about tests.
ListUniqueProblemsResult	listUniqueProblems(ListUniqueProblemsRequest request) Gets information about unique problems.
ListUploadsResult	listUploads(ListUploadsRequest request) Gets information about uploads, given an AWS Device Farm project ARN.
PurchaseOfferingResult	purchaseOffering(PurchaseOfferingRequest request) Immediately purchases offerings for an AWS account.
RenewOfferingResult	renewOffering(RenewOfferingRequest request) Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period.
ScheduleRunResult	scheduleRun(ScheduleRunRequest request) Schedules a run.
StopRemoteAccessSessionResult	stopRemoteAccessSession(StopRemoteAccessSessionRequest request) Ends a specified remote access session.
StopRunResult	stopRun(StopRunRequest request) Initiates a stop request for the current test run.
UpdateDevicePoolResult	updateDevicePool(UpdateDevicePoolRequest request) Modifies the name, description, and rules in a device pool given the attributes and the pool ARN.
UpdateNetworkProfileResult	updateNetworkProfile(UpdateNetworkProfileRequest request) Updates the network profile with specific settings.
UpdateProjectResult	updateProject(UpdateProjectRequest request) Modifies the specified project name, given the project ARN and a new name.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.devicefarm.AWSDeviceFarm

setEndpoint, setRegion, shutdown

Constructor Detail

AWSDeviceFarmClient

@Deprecated
public AWSDeviceFarmClient()

Deprecated. use AWSDeviceFarmClientBuilder.defaultClient()

Constructs a new client to invoke service methods on AWS Device Farm. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSDeviceFarmClient

@Deprecated
public AWSDeviceFarmClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on AWS Device Farm. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AWS Device Farm (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSDeviceFarmClient

@Deprecated
public AWSDeviceFarmClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSDeviceFarmClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

Constructs a new client to invoke service methods on AWS Device Farm using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSDeviceFarmClient

@Deprecated
public AWSDeviceFarmClient(AWSCredentials awsCredentials,
                                       ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on AWS Device Farm using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWS Device Farm (ex: proxy settings, retry counts, etc.).

AWSDeviceFarmClient

@Deprecated
public AWSDeviceFarmClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

Constructs a new client to invoke service methods on AWS Device Farm using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSDeviceFarmClient

@Deprecated
public AWSDeviceFarmClient(AWSCredentialsProvider awsCredentialsProvider,
                                       ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on AWS Device Farm using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWS Device Farm (ex: proxy settings, retry counts, etc.).

AWSDeviceFarmClient

@Deprecated
public AWSDeviceFarmClient(AWSCredentialsProvider awsCredentialsProvider,
                                       ClientConfiguration clientConfiguration,
                                       RequestMetricCollector requestMetricCollector)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)

Constructs a new client to invoke service methods on AWS Device Farm using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWS Device Farm (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

builder

public static AWSDeviceFarmClientBuilder builder()

createDevicePool

public CreateDevicePoolResult createDevicePool(CreateDevicePoolRequest request)

Creates a device pool.

Specified by:

createDevicePool in interface AWSDeviceFarm

Parameters:

createDevicePoolRequest - Represents a request to the create device pool operation.

Returns:

Result of the CreateDevicePool operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

createNetworkProfile

public CreateNetworkProfileResult createNetworkProfile(CreateNetworkProfileRequest request)

Creates a network profile.

Specified by:

createNetworkProfile in interface AWSDeviceFarm

Parameters:

createNetworkProfileRequest -

Returns:

Result of the CreateNetworkProfile operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

createProject

public CreateProjectResult createProject(CreateProjectRequest request)

Creates a new project.

Specified by:

createProject in interface AWSDeviceFarm

Parameters:

createProjectRequest - Represents a request to the create project operation.

Returns:

Result of the CreateProject operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

createRemoteAccessSession

public CreateRemoteAccessSessionResult createRemoteAccessSession(CreateRemoteAccessSessionRequest request)

Specifies and starts a remote access session.

Specified by:

createRemoteAccessSession in interface AWSDeviceFarm

Parameters:

createRemoteAccessSessionRequest - Creates and submits a request to start a remote access session.

Returns:

Result of the CreateRemoteAccessSession operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

createUpload

public CreateUploadResult createUpload(CreateUploadRequest request)

Uploads an app or test scripts.

Specified by:

createUpload in interface AWSDeviceFarm

Parameters:

createUploadRequest - Represents a request to the create upload operation.

Returns:

Result of the CreateUpload operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

deleteDevicePool

public DeleteDevicePoolResult deleteDevicePool(DeleteDevicePoolRequest request)

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

Specified by:

deleteDevicePool in interface AWSDeviceFarm

Parameters:

deleteDevicePoolRequest - Represents a request to the delete device pool operation.

Returns:

Result of the DeleteDevicePool operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

deleteNetworkProfile

public DeleteNetworkProfileResult deleteNetworkProfile(DeleteNetworkProfileRequest request)

Deletes a network profile.

Specified by:

deleteNetworkProfile in interface AWSDeviceFarm

Parameters:

deleteNetworkProfileRequest -

Returns:

Result of the DeleteNetworkProfile operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

deleteProject

public DeleteProjectResult deleteProject(DeleteProjectRequest request)

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

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

Specified by:

deleteProject in interface AWSDeviceFarm

Parameters:

deleteProjectRequest - Represents a request to the delete project operation.

Returns:

Result of the DeleteProject operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

deleteRemoteAccessSession

public DeleteRemoteAccessSessionResult deleteRemoteAccessSession(DeleteRemoteAccessSessionRequest request)

Deletes a completed remote access session and its results.

Specified by:

deleteRemoteAccessSession in interface AWSDeviceFarm

Parameters:

deleteRemoteAccessSessionRequest - Represents the request to delete the specified remote access session.

Returns:

Result of the DeleteRemoteAccessSession operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

deleteRun

public DeleteRunResult deleteRun(DeleteRunRequest request)

Deletes the run, given the run ARN.

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

Specified by:

deleteRun in interface AWSDeviceFarm

Parameters:

deleteRunRequest - Represents a request to the delete run operation.

Returns:

Result of the DeleteRun operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

deleteUpload

public DeleteUploadResult deleteUpload(DeleteUploadRequest request)

Deletes an upload given the upload ARN.

Specified by:

deleteUpload in interface AWSDeviceFarm

Parameters:

deleteUploadRequest - Represents a request to the delete upload operation.

Returns:

Result of the DeleteUpload operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

getAccountSettings

public GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest request)

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

Specified by:

getAccountSettings in interface AWSDeviceFarm

Parameters:

getAccountSettingsRequest - Represents the request sent to retrieve the account settings.

Returns:

Result of the GetAccountSettings operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

getDevice

public GetDeviceResult getDevice(GetDeviceRequest request)

Gets information about a unique device type.

Specified by:

getDevice in interface AWSDeviceFarm

Parameters:

getDeviceRequest - Represents a request to the get device request.

Returns:

Result of the GetDevice operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

getDevicePool

public GetDevicePoolResult getDevicePool(GetDevicePoolRequest request)

Gets information about a device pool.

Specified by:

getDevicePool in interface AWSDeviceFarm

Parameters:

getDevicePoolRequest - Represents a request to the get device pool operation.

Returns:

Result of the GetDevicePool operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

getDevicePoolCompatibility

public GetDevicePoolCompatibilityResult getDevicePoolCompatibility(GetDevicePoolCompatibilityRequest request)

Gets information about compatibility with a device pool.

Specified by:

getDevicePoolCompatibility in interface AWSDeviceFarm

Parameters:

getDevicePoolCompatibilityRequest - Represents a request to the get device pool compatibility operation.

Returns:

Result of the GetDevicePoolCompatibility operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

getJob

public GetJobResult getJob(GetJobRequest request)

Gets information about a job.

Specified by:

getJob in interface AWSDeviceFarm

Parameters:

getJobRequest - Represents a request to the get job operation.

Returns:

Result of the GetJob operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

getNetworkProfile

public GetNetworkProfileResult getNetworkProfile(GetNetworkProfileRequest request)

Returns information about a network profile.

Specified by:

getNetworkProfile in interface AWSDeviceFarm

Parameters:

getNetworkProfileRequest -

Returns:

Result of the GetNetworkProfile operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

getOfferingStatus

public GetOfferingStatusResult getOfferingStatus(GetOfferingStatusRequest request)

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.

Specified by:

getOfferingStatus in interface AWSDeviceFarm

Parameters:

getOfferingStatusRequest - Represents the request to retrieve the offering status for the specified customer or account.

Returns:

Result of the GetOfferingStatus operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

NotEligibleException - Exception gets thrown when a user is not eligible to perform the specified transaction.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

getProject

public GetProjectResult getProject(GetProjectRequest request)

Gets information about a project.

Specified by:

getProject in interface AWSDeviceFarm

Parameters:

getProjectRequest - Represents a request to the get project operation.

Returns:

Result of the GetProject operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

getRemoteAccessSession

public GetRemoteAccessSessionResult getRemoteAccessSession(GetRemoteAccessSessionRequest request)

Returns a link to a currently running remote access session.

Specified by:

getRemoteAccessSession in interface AWSDeviceFarm

Parameters:

getRemoteAccessSessionRequest - Represents the request to get information about the specified remote access session.

Returns:

Result of the GetRemoteAccessSession operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

getRun

public GetRunResult getRun(GetRunRequest request)

Gets information about a run.

Specified by:

getRun in interface AWSDeviceFarm

Parameters:

getRunRequest - Represents a request to the get run operation.

Returns:

Result of the GetRun operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

getSuite

public GetSuiteResult getSuite(GetSuiteRequest request)

Gets information about a suite.

Specified by:

getSuite in interface AWSDeviceFarm

Parameters:

getSuiteRequest - Represents a request to the get suite operation.

Returns:

Result of the GetSuite operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

getTest

public GetTestResult getTest(GetTestRequest request)

Gets information about a test.

Specified by:

getTest in interface AWSDeviceFarm

Parameters:

getTestRequest - Represents a request to the get test operation.

Returns:

Result of the GetTest operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

getUpload

public GetUploadResult getUpload(GetUploadRequest request)

Gets information about an upload.

Specified by:

getUpload in interface AWSDeviceFarm

Parameters:

getUploadRequest - Represents a request to the get upload operation.

Returns:

Result of the GetUpload operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

installToRemoteAccessSession

public InstallToRemoteAccessSessionResult installToRemoteAccessSession(InstallToRemoteAccessSessionRequest request)

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.

Specified by:

installToRemoteAccessSession in interface AWSDeviceFarm

Parameters:

installToRemoteAccessSessionRequest - Represents the request to install an Android application (in .apk format) or an iOS application (in .ipa format) as part of a remote access session.

Returns:

Result of the InstallToRemoteAccessSession operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

listArtifacts

public ListArtifactsResult listArtifacts(ListArtifactsRequest request)

Gets information about artifacts.

Specified by:

listArtifacts in interface AWSDeviceFarm

Parameters:

listArtifactsRequest - Represents a request to the list artifacts operation.

Returns:

Result of the ListArtifacts operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

listDevicePools

public ListDevicePoolsResult listDevicePools(ListDevicePoolsRequest request)

Gets information about device pools.

Specified by:

listDevicePools in interface AWSDeviceFarm

Parameters:

listDevicePoolsRequest - Represents the result of a list device pools request.

Returns:

Result of the ListDevicePools operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

listDevices

public ListDevicesResult listDevices(ListDevicesRequest request)

Gets information about unique device types.

Specified by:

listDevices in interface AWSDeviceFarm

Parameters:

listDevicesRequest - Represents the result of a list devices request.

Returns:

Result of the ListDevices operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

listJobs

public ListJobsResult listJobs(ListJobsRequest request)

Gets information about jobs.

Specified by:

listJobs in interface AWSDeviceFarm

Parameters:

listJobsRequest - Represents a request to the list jobs operation.

Returns:

Result of the ListJobs operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

listNetworkProfiles

public ListNetworkProfilesResult listNetworkProfiles(ListNetworkProfilesRequest request)

Returns the list of available network profiles.

Specified by:

listNetworkProfiles in interface AWSDeviceFarm

Parameters:

listNetworkProfilesRequest -

Returns:

Result of the ListNetworkProfiles operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

listOfferingPromotions

public ListOfferingPromotionsResult listOfferingPromotions(ListOfferingPromotionsRequest request)

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.

Specified by:

listOfferingPromotions in interface AWSDeviceFarm

Parameters:

listOfferingPromotionsRequest -

Returns:

Result of the ListOfferingPromotions operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

NotEligibleException - Exception gets thrown when a user is not eligible to perform the specified transaction.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

listOfferingTransactions

public ListOfferingTransactionsResult listOfferingTransactions(ListOfferingTransactionsRequest request)

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.

Specified by:

listOfferingTransactions in interface AWSDeviceFarm

Parameters:

listOfferingTransactionsRequest - Represents the request to list the offering transaction history.

Returns:

Result of the ListOfferingTransactions operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

NotEligibleException - Exception gets thrown when a user is not eligible to perform the specified transaction.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

listOfferings

public ListOfferingsResult listOfferings(ListOfferingsRequest request)

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.

Specified by:

listOfferings in interface AWSDeviceFarm

Parameters:

listOfferingsRequest - Represents the request to list all offerings.

Returns:

Result of the ListOfferings operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

NotEligibleException - Exception gets thrown when a user is not eligible to perform the specified transaction.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

listProjects

public ListProjectsResult listProjects(ListProjectsRequest request)

Gets information about projects.

Specified by:

listProjects in interface AWSDeviceFarm

Parameters:

listProjectsRequest - Represents a request to the list projects operation.

Returns:

Result of the ListProjects operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

listRemoteAccessSessions

public ListRemoteAccessSessionsResult listRemoteAccessSessions(ListRemoteAccessSessionsRequest request)

Returns a list of all currently running remote access sessions.

Specified by:

listRemoteAccessSessions in interface AWSDeviceFarm

Parameters:

listRemoteAccessSessionsRequest - Represents the request to return information about the remote access session.

Returns:

Result of the ListRemoteAccessSessions operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

listRuns

public ListRunsResult listRuns(ListRunsRequest request)

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

Specified by:

listRuns in interface AWSDeviceFarm

Parameters:

listRunsRequest - Represents a request to the list runs operation.

Returns:

Result of the ListRuns operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

listSamples

public ListSamplesResult listSamples(ListSamplesRequest request)

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

Specified by:

listSamples in interface AWSDeviceFarm

Parameters:

listSamplesRequest - Represents a request to the list samples operation.

Returns:

Result of the ListSamples operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

listSuites

public ListSuitesResult listSuites(ListSuitesRequest request)

Gets information about suites.

Specified by:

listSuites in interface AWSDeviceFarm

Parameters:

listSuitesRequest - Represents a request to the list suites operation.

Returns:

Result of the ListSuites operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

listTests

public ListTestsResult listTests(ListTestsRequest request)

Gets information about tests.

Specified by:

listTests in interface AWSDeviceFarm

Parameters:

listTestsRequest - Represents a request to the list tests operation.

Returns:

Result of the ListTests operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

listUniqueProblems

public ListUniqueProblemsResult listUniqueProblems(ListUniqueProblemsRequest request)

Gets information about unique problems.

Specified by:

listUniqueProblems in interface AWSDeviceFarm

Parameters:

listUniqueProblemsRequest - Represents a request to the list unique problems operation.

Returns:

Result of the ListUniqueProblems operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

listUploads

public ListUploadsResult listUploads(ListUploadsRequest request)

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

Specified by:

listUploads in interface AWSDeviceFarm

Parameters:

listUploadsRequest - Represents a request to the list uploads operation.

Returns:

Result of the ListUploads operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

purchaseOffering

public PurchaseOfferingResult purchaseOffering(PurchaseOfferingRequest request)

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.

Specified by:

purchaseOffering in interface AWSDeviceFarm

Parameters:

purchaseOfferingRequest - Represents a request for a purchase offering.

Returns:

Result of the PurchaseOffering operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

NotEligibleException - Exception gets thrown when a user is not eligible to perform the specified transaction.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

renewOffering

public RenewOfferingResult renewOffering(RenewOfferingRequest request)

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.

Specified by:

renewOffering in interface AWSDeviceFarm

Parameters:

renewOfferingRequest - A request representing an offering renewal.

Returns:

Result of the RenewOffering operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

NotEligibleException - Exception gets thrown when a user is not eligible to perform the specified transaction.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

scheduleRun

public ScheduleRunResult scheduleRun(ScheduleRunRequest request)

Schedules a run.

Specified by:

scheduleRun in interface AWSDeviceFarm

Parameters:

scheduleRunRequest - Represents a request to the schedule run operation.

Returns:

Result of the ScheduleRun operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

IdempotencyException - An entity with the same name already exists.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

stopRemoteAccessSession

public StopRemoteAccessSessionResult stopRemoteAccessSession(StopRemoteAccessSessionRequest request)

Ends a specified remote access session.

Specified by:

stopRemoteAccessSession in interface AWSDeviceFarm

Parameters:

stopRemoteAccessSessionRequest - Represents the request to stop the remote access session.

Returns:

Result of the StopRemoteAccessSession operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

stopRun

public StopRunResult stopRun(StopRunRequest request)

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.

Specified by:

stopRun in interface AWSDeviceFarm

Parameters:

stopRunRequest - Represents the request to stop a specific run.

Returns:

Result of the StopRun operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

updateDevicePool

public UpdateDevicePoolResult updateDevicePool(UpdateDevicePoolRequest request)

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

Specified by:

updateDevicePool in interface AWSDeviceFarm

Parameters:

updateDevicePoolRequest - Represents a request to the update device pool operation.

Returns:

Result of the UpdateDevicePool operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

updateNetworkProfile

public UpdateNetworkProfileResult updateNetworkProfile(UpdateNetworkProfileRequest request)

Updates the network profile with specific settings.

Specified by:

updateNetworkProfile in interface AWSDeviceFarm

Parameters:

updateNetworkProfileRequest -

Returns:

Result of the UpdateNetworkProfile operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

updateProject

public UpdateProjectResult updateProject(UpdateProjectRequest request)

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

Specified by:

updateProject in interface AWSDeviceFarm

Parameters:

updateProjectRequest - Represents a request to the update project operation.

Returns:

Result of the UpdateProject operation returned by the service.

Throws:

ArgumentException - An invalid argument was specified.

NotFoundException - The specified entity was not found.

LimitExceededException - A limit was exceeded.

ServiceAccountException - There was a problem with the service account.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSDeviceFarm

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.