Package software.amazon.awssdk.services.devicefarm

Interface DeviceFarmAsyncClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface DeviceFarmAsyncClient
extends AutoCloseable

Service client for accessing null asynchronously. This can be created using the static builder() method.

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.

Method Summary

Modifier and Type	Method	Description
static DeviceFarmAsyncClientBuilder	builder()	Create a builder that can be used to configure and create a DeviceFarmAsyncClient.
static DeviceFarmAsyncClient	create()	Create a DeviceFarmAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateDevicePoolResponse>	createDevicePool(CreateDevicePoolRequest createDevicePoolRequest)	Creates a device pool.
default CompletableFuture<CreateNetworkProfileResponse>	createNetworkProfile(CreateNetworkProfileRequest createNetworkProfileRequest)	Creates a network profile.
default CompletableFuture<CreateProjectResponse>	createProject(CreateProjectRequest createProjectRequest)	Creates a new project.
default CompletableFuture<CreateRemoteAccessSessionResponse>	createRemoteAccessSession(CreateRemoteAccessSessionRequest createRemoteAccessSessionRequest)	Specifies and starts a remote access session.
default CompletableFuture<CreateUploadResponse>	createUpload(CreateUploadRequest createUploadRequest)	Uploads an app or test scripts.
default CompletableFuture<DeleteDevicePoolResponse>	deleteDevicePool(DeleteDevicePoolRequest deleteDevicePoolRequest)	Deletes a device pool given the pool ARN.
default CompletableFuture<DeleteNetworkProfileResponse>	deleteNetworkProfile(DeleteNetworkProfileRequest deleteNetworkProfileRequest)	Deletes a network profile.
default CompletableFuture<DeleteProjectResponse>	deleteProject(DeleteProjectRequest deleteProjectRequest)	Deletes an AWS Device Farm project, given the project ARN.
default CompletableFuture<DeleteRemoteAccessSessionResponse>	deleteRemoteAccessSession(DeleteRemoteAccessSessionRequest deleteRemoteAccessSessionRequest)	Deletes a completed remote access session and its results.
default CompletableFuture<DeleteRunResponse>	deleteRun(DeleteRunRequest deleteRunRequest)	Deletes the run, given the run ARN.
default CompletableFuture<DeleteUploadResponse>	deleteUpload(DeleteUploadRequest deleteUploadRequest)	Deletes an upload given the upload ARN.
default CompletableFuture<GetAccountSettingsResponse>	getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)	Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account.
default CompletableFuture<GetDeviceResponse>	getDevice(GetDeviceRequest getDeviceRequest)	Gets information about a unique device type.
default CompletableFuture<GetDevicePoolResponse>	getDevicePool(GetDevicePoolRequest getDevicePoolRequest)	Gets information about a device pool.
default CompletableFuture<GetDevicePoolCompatibilityResponse>	getDevicePoolCompatibility(GetDevicePoolCompatibilityRequest getDevicePoolCompatibilityRequest)	Gets information about compatibility with a device pool.
default CompletableFuture<GetJobResponse>	getJob(GetJobRequest getJobRequest)	Gets information about a job.
default CompletableFuture<GetNetworkProfileResponse>	getNetworkProfile(GetNetworkProfileRequest getNetworkProfileRequest)	Returns information about a network profile.
default CompletableFuture<GetOfferingStatusResponse>	getOfferingStatus(GetOfferingStatusRequest getOfferingStatusRequest)	Gets the current status and future status of all offerings purchased by an AWS account.
default CompletableFuture<GetProjectResponse>	getProject(GetProjectRequest getProjectRequest)	Gets information about a project.
default CompletableFuture<GetRemoteAccessSessionResponse>	getRemoteAccessSession(GetRemoteAccessSessionRequest getRemoteAccessSessionRequest)	Returns a link to a currently running remote access session.
default CompletableFuture<GetRunResponse>	getRun(GetRunRequest getRunRequest)	Gets information about a run.
default CompletableFuture<GetSuiteResponse>	getSuite(GetSuiteRequest getSuiteRequest)	Gets information about a suite.
default CompletableFuture<GetTestResponse>	getTest(GetTestRequest getTestRequest)	Gets information about a test.
default CompletableFuture<GetUploadResponse>	getUpload(GetUploadRequest getUploadRequest)	Gets information about an upload.
default CompletableFuture<InstallToRemoteAccessSessionResponse>	installToRemoteAccessSession(InstallToRemoteAccessSessionRequest installToRemoteAccessSessionRequest)	Installs an application to the device in a remote access session.
default CompletableFuture<ListArtifactsResponse>	listArtifacts(ListArtifactsRequest listArtifactsRequest)	Gets information about artifacts.
default CompletableFuture<ListDevicePoolsResponse>	listDevicePools(ListDevicePoolsRequest listDevicePoolsRequest)	Gets information about device pools.
default CompletableFuture<ListDevicesResponse>	listDevices(ListDevicesRequest listDevicesRequest)	Gets information about unique device types.
default CompletableFuture<ListJobsResponse>	listJobs(ListJobsRequest listJobsRequest)	Gets information about jobs.
default CompletableFuture<ListNetworkProfilesResponse>	listNetworkProfiles(ListNetworkProfilesRequest listNetworkProfilesRequest)	Returns the list of available network profiles.
default CompletableFuture<ListOfferingPromotionsResponse>	listOfferingPromotions(ListOfferingPromotionsRequest listOfferingPromotionsRequest)	Returns a list of offering promotions.
default CompletableFuture<ListOfferingsResponse>	listOfferings(ListOfferingsRequest listOfferingsRequest)	Returns a list of products or offerings that the user can manage through the API.
default CompletableFuture<ListOfferingTransactionsResponse>	listOfferingTransactions(ListOfferingTransactionsRequest listOfferingTransactionsRequest)	Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account.
default CompletableFuture<ListProjectsResponse>	listProjects(ListProjectsRequest listProjectsRequest)	Gets information about projects.
default CompletableFuture<ListRemoteAccessSessionsResponse>	listRemoteAccessSessions(ListRemoteAccessSessionsRequest listRemoteAccessSessionsRequest)	Returns a list of all currently running remote access sessions.
default CompletableFuture<ListRunsResponse>	listRuns(ListRunsRequest listRunsRequest)	Gets information about runs, given an AWS Device Farm project ARN.
default CompletableFuture<ListSamplesResponse>	listSamples(ListSamplesRequest listSamplesRequest)	Gets information about samples, given an AWS Device Farm project ARN
default CompletableFuture<ListSuitesResponse>	listSuites(ListSuitesRequest listSuitesRequest)	Gets information about suites.
default CompletableFuture<ListTestsResponse>	listTests(ListTestsRequest listTestsRequest)	Gets information about tests.
default CompletableFuture<ListUniqueProblemsResponse>	listUniqueProblems(ListUniqueProblemsRequest listUniqueProblemsRequest)	Gets information about unique problems.
default CompletableFuture<ListUploadsResponse>	listUploads(ListUploadsRequest listUploadsRequest)	Gets information about uploads, given an AWS Device Farm project ARN.
default CompletableFuture<PurchaseOfferingResponse>	purchaseOffering(PurchaseOfferingRequest purchaseOfferingRequest)	Immediately purchases offerings for an AWS account.
default CompletableFuture<RenewOfferingResponse>	renewOffering(RenewOfferingRequest renewOfferingRequest)	Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period.
default CompletableFuture<ScheduleRunResponse>	scheduleRun(ScheduleRunRequest scheduleRunRequest)	Schedules a run.
default CompletableFuture<StopRemoteAccessSessionResponse>	stopRemoteAccessSession(StopRemoteAccessSessionRequest stopRemoteAccessSessionRequest)	Ends a specified remote access session.
default CompletableFuture<StopRunResponse>	stopRun(StopRunRequest stopRunRequest)	Initiates a stop request for the current test run.
default CompletableFuture<UpdateDevicePoolResponse>	updateDevicePool(UpdateDevicePoolRequest updateDevicePoolRequest)	Modifies the name, description, and rules in a device pool given the attributes and the pool ARN.
default CompletableFuture<UpdateNetworkProfileResponse>	updateNetworkProfile(UpdateNetworkProfileRequest updateNetworkProfileRequest)	Updates the network profile with specific settings.
default CompletableFuture<UpdateProjectResponse>	updateProject(UpdateProjectRequest updateProjectRequest)	Modifies the specified project name, given the project ARN and a new name.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

create

static DeviceFarmAsyncClient create()

Create a DeviceFarmAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static DeviceFarmAsyncClientBuilder builder()

Create a builder that can be used to configure and create a DeviceFarmAsyncClient.

createDevicePool

default CompletableFuture<CreateDevicePoolResponse> createDevicePool(CreateDevicePoolRequest createDevicePoolRequest)

Creates a device pool.

Parameters:

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

Returns:

A Java Future containing the result of the CreateDevicePool operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createNetworkProfile

default CompletableFuture<CreateNetworkProfileResponse> createNetworkProfile(CreateNetworkProfileRequest createNetworkProfileRequest)

Creates a network profile.

Parameters:

createNetworkProfileRequest -

Returns:

A Java Future containing the result of the CreateNetworkProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createProject

default CompletableFuture<CreateProjectResponse> createProject(CreateProjectRequest createProjectRequest)

Creates a new project.

Parameters:

createProjectRequest - Represents a request to the create project operation.

Returns:

A Java Future containing the result of the CreateProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createRemoteAccessSession

default CompletableFuture<CreateRemoteAccessSessionResponse> createRemoteAccessSession(CreateRemoteAccessSessionRequest createRemoteAccessSessionRequest)

Specifies and starts a remote access session.

Parameters:

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

Returns:

A Java Future containing the result of the CreateRemoteAccessSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createUpload

default CompletableFuture<CreateUploadResponse> createUpload(CreateUploadRequest createUploadRequest)

Uploads an app or test scripts.

Parameters:

createUploadRequest - Represents a request to the create upload operation.

Returns:

A Java Future containing the result of the CreateUpload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteDevicePool

default CompletableFuture<DeleteDevicePoolResponse> deleteDevicePool(DeleteDevicePoolRequest deleteDevicePoolRequest)

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

Parameters:

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

Returns:

A Java Future containing the result of the DeleteDevicePool operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteNetworkProfile

default CompletableFuture<DeleteNetworkProfileResponse> deleteNetworkProfile(DeleteNetworkProfileRequest deleteNetworkProfileRequest)

Deletes a network profile.

Parameters:

deleteNetworkProfileRequest -

Returns:

A Java Future containing the result of the DeleteNetworkProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteProject

default CompletableFuture<DeleteProjectResponse> deleteProject(DeleteProjectRequest deleteProjectRequest)

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

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

Parameters:

deleteProjectRequest - Represents a request to the delete project operation.

Returns:

A Java Future containing the result of the DeleteProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteRemoteAccessSession

default CompletableFuture<DeleteRemoteAccessSessionResponse> deleteRemoteAccessSession(DeleteRemoteAccessSessionRequest deleteRemoteAccessSessionRequest)

Deletes a completed remote access session and its results.

Parameters:

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

Returns:

A Java Future containing the result of the DeleteRemoteAccessSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteRun

default CompletableFuture<DeleteRunResponse> deleteRun(DeleteRunRequest deleteRunRequest)

Deletes the run, given the run ARN.

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

Parameters:

deleteRunRequest - Represents a request to the delete run operation.

Returns:

A Java Future containing the result of the DeleteRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteUpload

default CompletableFuture<DeleteUploadResponse> deleteUpload(DeleteUploadRequest deleteUploadRequest)

Deletes an upload given the upload ARN.

Parameters:

deleteUploadRequest - Represents a request to the delete upload operation.

Returns:

A Java Future containing the result of the DeleteUpload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getAccountSettings

default CompletableFuture<GetAccountSettingsResponse> getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)

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

Parameters:

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

Returns:

A Java Future containing the result of the GetAccountSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getDevice

default CompletableFuture<GetDeviceResponse> getDevice(GetDeviceRequest getDeviceRequest)

Gets information about a unique device type.

Parameters:

getDeviceRequest - Represents a request to the get device request.

Returns:

A Java Future containing the result of the GetDevice operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getDevicePool

default CompletableFuture<GetDevicePoolResponse> getDevicePool(GetDevicePoolRequest getDevicePoolRequest)

Gets information about a device pool.

Parameters:

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

Returns:

A Java Future containing the result of the GetDevicePool operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getDevicePoolCompatibility

default CompletableFuture<GetDevicePoolCompatibilityResponse> getDevicePoolCompatibility(GetDevicePoolCompatibilityRequest getDevicePoolCompatibilityRequest)

Gets information about compatibility with a device pool.

Parameters:

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

Returns:

A Java Future containing the result of the GetDevicePoolCompatibility operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getJob

default CompletableFuture<GetJobResponse> getJob(GetJobRequest getJobRequest)

Gets information about a job.

Parameters:

getJobRequest - Represents a request to the get job operation.

Returns:

A Java Future containing the result of the GetJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getNetworkProfile

default CompletableFuture<GetNetworkProfileResponse> getNetworkProfile(GetNetworkProfileRequest getNetworkProfileRequest)

Returns information about a network profile.

Parameters:

getNetworkProfileRequest -

Returns:

A Java Future containing the result of the GetNetworkProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getOfferingStatus

default CompletableFuture<GetOfferingStatusResponse> getOfferingStatus(GetOfferingStatusRequest 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.

Parameters:

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

Returns:

A Java Future containing the result of the GetOfferingStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getProject

default CompletableFuture<GetProjectResponse> getProject(GetProjectRequest getProjectRequest)

Gets information about a project.

Parameters:

getProjectRequest - Represents a request to the get project operation.

Returns:

A Java Future containing the result of the GetProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getRemoteAccessSession

default CompletableFuture<GetRemoteAccessSessionResponse> getRemoteAccessSession(GetRemoteAccessSessionRequest getRemoteAccessSessionRequest)

Returns a link to a currently running remote access session.

Parameters:

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

Returns:

A Java Future containing the result of the GetRemoteAccessSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getRun

default CompletableFuture<GetRunResponse> getRun(GetRunRequest getRunRequest)

Gets information about a run.

Parameters:

getRunRequest - Represents a request to the get run operation.

Returns:

A Java Future containing the result of the GetRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getSuite

default CompletableFuture<GetSuiteResponse> getSuite(GetSuiteRequest getSuiteRequest)

Gets information about a suite.

Parameters:

getSuiteRequest - Represents a request to the get suite operation.

Returns:

A Java Future containing the result of the GetSuite operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getTest

default CompletableFuture<GetTestResponse> getTest(GetTestRequest getTestRequest)

Gets information about a test.

Parameters:

getTestRequest - Represents a request to the get test operation.

Returns:

A Java Future containing the result of the GetTest operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getUpload

default CompletableFuture<GetUploadResponse> getUpload(GetUploadRequest getUploadRequest)

Gets information about an upload.

Parameters:

getUploadRequest - Represents a request to the get upload operation.

Returns:

A Java Future containing the result of the GetUpload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

installToRemoteAccessSession

default CompletableFuture<InstallToRemoteAccessSessionResponse> installToRemoteAccessSession(InstallToRemoteAccessSessionRequest 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.

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:

A Java Future containing the result of the InstallToRemoteAccessSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listArtifacts

default CompletableFuture<ListArtifactsResponse> listArtifacts(ListArtifactsRequest listArtifactsRequest)

Gets information about artifacts.

Parameters:

listArtifactsRequest - Represents a request to the list artifacts operation.

Returns:

A Java Future containing the result of the ListArtifacts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listDevicePools

default CompletableFuture<ListDevicePoolsResponse> listDevicePools(ListDevicePoolsRequest listDevicePoolsRequest)

Gets information about device pools.

Parameters:

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

Returns:

A Java Future containing the result of the ListDevicePools operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listDevices

default CompletableFuture<ListDevicesResponse> listDevices(ListDevicesRequest listDevicesRequest)

Gets information about unique device types.

Parameters:

listDevicesRequest - Represents the result of a list devices request.

Returns:

A Java Future containing the result of the ListDevices operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listJobs

default CompletableFuture<ListJobsResponse> listJobs(ListJobsRequest listJobsRequest)

Gets information about jobs.

Parameters:

listJobsRequest - Represents a request to the list jobs operation.

Returns:

A Java Future containing the result of the ListJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listNetworkProfiles

default CompletableFuture<ListNetworkProfilesResponse> listNetworkProfiles(ListNetworkProfilesRequest listNetworkProfilesRequest)

Returns the list of available network profiles.

Parameters:

listNetworkProfilesRequest -

Returns:

A Java Future containing the result of the ListNetworkProfiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listOfferingPromotions

default CompletableFuture<ListOfferingPromotionsResponse> listOfferingPromotions(ListOfferingPromotionsRequest 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.

Parameters:

listOfferingPromotionsRequest -

Returns:

A Java Future containing the result of the ListOfferingPromotions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listOfferingTransactions

default CompletableFuture<ListOfferingTransactionsResponse> listOfferingTransactions(ListOfferingTransactionsRequest 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.

Parameters:

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

Returns:

A Java Future containing the result of the ListOfferingTransactions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listOfferings

default CompletableFuture<ListOfferingsResponse> listOfferings(ListOfferingsRequest 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.

Parameters:

listOfferingsRequest - Represents the request to list all offerings.

Returns:

A Java Future containing the result of the ListOfferings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listProjects

default CompletableFuture<ListProjectsResponse> listProjects(ListProjectsRequest listProjectsRequest)

Gets information about projects.

Parameters:

listProjectsRequest - Represents a request to the list projects operation.

Returns:

A Java Future containing the result of the ListProjects operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listRemoteAccessSessions

default CompletableFuture<ListRemoteAccessSessionsResponse> listRemoteAccessSessions(ListRemoteAccessSessionsRequest listRemoteAccessSessionsRequest)

Returns a list of all currently running remote access sessions.

Parameters:

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

Returns:

A Java Future containing the result of the ListRemoteAccessSessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listRuns

default CompletableFuture<ListRunsResponse> listRuns(ListRunsRequest listRunsRequest)

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

Parameters:

listRunsRequest - Represents a request to the list runs operation.

Returns:

A Java Future containing the result of the ListRuns operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listSamples

default CompletableFuture<ListSamplesResponse> listSamples(ListSamplesRequest listSamplesRequest)

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

Parameters:

listSamplesRequest - Represents a request to the list samples operation.

Returns:

A Java Future containing the result of the ListSamples operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listSuites

default CompletableFuture<ListSuitesResponse> listSuites(ListSuitesRequest listSuitesRequest)

Gets information about suites.

Parameters:

listSuitesRequest - Represents a request to the list suites operation.

Returns:

A Java Future containing the result of the ListSuites operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listTests

default CompletableFuture<ListTestsResponse> listTests(ListTestsRequest listTestsRequest)

Gets information about tests.

Parameters:

listTestsRequest - Represents a request to the list tests operation.

Returns:

A Java Future containing the result of the ListTests operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listUniqueProblems

default CompletableFuture<ListUniqueProblemsResponse> listUniqueProblems(ListUniqueProblemsRequest listUniqueProblemsRequest)

Gets information about unique problems.

Parameters:

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

Returns:

A Java Future containing the result of the ListUniqueProblems operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listUploads

default CompletableFuture<ListUploadsResponse> listUploads(ListUploadsRequest listUploadsRequest)

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

Parameters:

listUploadsRequest - Represents a request to the list uploads operation.

Returns:

A Java Future containing the result of the ListUploads operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

purchaseOffering

default CompletableFuture<PurchaseOfferingResponse> purchaseOffering(PurchaseOfferingRequest 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.

Parameters:

purchaseOfferingRequest - Represents a request for a purchase offering.

Returns:

A Java Future containing the result of the PurchaseOffering operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

renewOffering

default CompletableFuture<RenewOfferingResponse> renewOffering(RenewOfferingRequest 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.

Parameters:

renewOfferingRequest - A request representing an offering renewal.

Returns:

A Java Future containing the result of the RenewOffering operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

scheduleRun

default CompletableFuture<ScheduleRunResponse> scheduleRun(ScheduleRunRequest scheduleRunRequest)

Schedules a run.

Parameters:

scheduleRunRequest - Represents a request to the schedule run operation.

Returns:

A Java Future containing the result of the ScheduleRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

stopRemoteAccessSession

default CompletableFuture<StopRemoteAccessSessionResponse> stopRemoteAccessSession(StopRemoteAccessSessionRequest stopRemoteAccessSessionRequest)

Ends a specified remote access session.

Parameters:

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

Returns:

A Java Future containing the result of the StopRemoteAccessSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

stopRun

default CompletableFuture<StopRunResponse> stopRun(StopRunRequest 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.

Parameters:

stopRunRequest - Represents the request to stop a specific run.

Returns:

A Java Future containing the result of the StopRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

updateDevicePool

default CompletableFuture<UpdateDevicePoolResponse> updateDevicePool(UpdateDevicePoolRequest 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).

Parameters:

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

Returns:

A Java Future containing the result of the UpdateDevicePool operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

updateNetworkProfile

default CompletableFuture<UpdateNetworkProfileResponse> updateNetworkProfile(UpdateNetworkProfileRequest updateNetworkProfileRequest)

Updates the network profile with specific settings.

Parameters:

updateNetworkProfileRequest -

Returns:

A Java Future containing the result of the UpdateNetworkProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

updateProject

default CompletableFuture<UpdateProjectResponse> updateProject(UpdateProjectRequest updateProjectRequest)

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

Parameters:

updateProjectRequest - Represents a request to the update project operation.

Returns:

A Java Future containing the result of the UpdateProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• DeviceFarmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation