@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSDeviceFarm
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSDeviceFarm instead.
Welcome to the AWS Device Farm API documentation, which contains APIs for:
Testing on desktop browsers
Device Farm makes it possible for you to test your web applications on desktop browsers using Selenium. The APIs for
desktop browser testing contain TestGrid in their names. For more information, see Testing Web Applications on Selenium with Device
Farm.
Testing on real mobile devices
Device Farm makes it possible for you to test apps on physical phones, tablets, and other devices in the cloud. For more information, see the Device Farm Developer Guide.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
CreateDevicePoolResult |
createDevicePool(CreateDevicePoolRequest createDevicePoolRequest)
Creates a device pool.
|
CreateInstanceProfileResult |
createInstanceProfile(CreateInstanceProfileRequest createInstanceProfileRequest)
Creates a profile that can be applied to one or more private fleet device instances.
|
CreateNetworkProfileResult |
createNetworkProfile(CreateNetworkProfileRequest createNetworkProfileRequest)
Creates a network profile.
|
CreateProjectResult |
createProject(CreateProjectRequest createProjectRequest)
Creates a project.
|
CreateRemoteAccessSessionResult |
createRemoteAccessSession(CreateRemoteAccessSessionRequest createRemoteAccessSessionRequest)
Specifies and starts a remote access session.
|
CreateTestGridProjectResult |
createTestGridProject(CreateTestGridProjectRequest createTestGridProjectRequest)
Creates a Selenium testing project.
|
CreateTestGridUrlResult |
createTestGridUrl(CreateTestGridUrlRequest createTestGridUrlRequest)
Creates a signed, short-term URL that can be passed to a Selenium
RemoteWebDriver constructor. |
CreateUploadResult |
createUpload(CreateUploadRequest createUploadRequest)
Uploads an app or test scripts.
|
CreateVPCEConfigurationResult |
createVPCEConfiguration(CreateVPCEConfigurationRequest createVPCEConfigurationRequest)
Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.
|
DeleteDevicePoolResult |
deleteDevicePool(DeleteDevicePoolRequest deleteDevicePoolRequest)
Deletes a device pool given the pool ARN.
|
DeleteInstanceProfileResult |
deleteInstanceProfile(DeleteInstanceProfileRequest deleteInstanceProfileRequest)
Deletes a profile that can be applied to one or more private device instances.
|
DeleteNetworkProfileResult |
deleteNetworkProfile(DeleteNetworkProfileRequest deleteNetworkProfileRequest)
Deletes a network profile.
|
DeleteProjectResult |
deleteProject(DeleteProjectRequest deleteProjectRequest)
Deletes an AWS Device Farm project, given the project ARN.
|
DeleteRemoteAccessSessionResult |
deleteRemoteAccessSession(DeleteRemoteAccessSessionRequest deleteRemoteAccessSessionRequest)
Deletes a completed remote access session and its results.
|
DeleteRunResult |
deleteRun(DeleteRunRequest deleteRunRequest)
Deletes the run, given the run ARN.
|
DeleteTestGridProjectResult |
deleteTestGridProject(DeleteTestGridProjectRequest deleteTestGridProjectRequest)
Deletes a Selenium testing project and all content generated under it.
|
DeleteUploadResult |
deleteUpload(DeleteUploadRequest deleteUploadRequest)
Deletes an upload given the upload ARN.
|
DeleteVPCEConfigurationResult |
deleteVPCEConfiguration(DeleteVPCEConfigurationRequest deleteVPCEConfigurationRequest)
Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.
|
GetAccountSettingsResult |
getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)
Returns the number of unmetered iOS 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 getDeviceRequest)
Gets information about a unique device type.
|
GetDeviceInstanceResult |
getDeviceInstance(GetDeviceInstanceRequest getDeviceInstanceRequest)
Returns information about a device instance that belongs to a private device fleet.
|
GetDevicePoolResult |
getDevicePool(GetDevicePoolRequest getDevicePoolRequest)
Gets information about a device pool.
|
GetDevicePoolCompatibilityResult |
getDevicePoolCompatibility(GetDevicePoolCompatibilityRequest getDevicePoolCompatibilityRequest)
Gets information about compatibility with a device pool.
|
GetInstanceProfileResult |
getInstanceProfile(GetInstanceProfileRequest getInstanceProfileRequest)
Returns information about the specified instance profile.
|
GetJobResult |
getJob(GetJobRequest getJobRequest)
Gets information about a job.
|
GetNetworkProfileResult |
getNetworkProfile(GetNetworkProfileRequest getNetworkProfileRequest)
Returns information about a network profile.
|
GetOfferingStatusResult |
getOfferingStatus(GetOfferingStatusRequest getOfferingStatusRequest)
Gets the current status and future status of all offerings purchased by an AWS account.
|
GetProjectResult |
getProject(GetProjectRequest getProjectRequest)
Gets information about a project.
|
GetRemoteAccessSessionResult |
getRemoteAccessSession(GetRemoteAccessSessionRequest getRemoteAccessSessionRequest)
Returns a link to a currently running remote access session.
|
GetRunResult |
getRun(GetRunRequest getRunRequest)
Gets information about a run.
|
GetSuiteResult |
getSuite(GetSuiteRequest getSuiteRequest)
Gets information about a suite.
|
GetTestResult |
getTest(GetTestRequest getTestRequest)
Gets information about a test.
|
GetTestGridProjectResult |
getTestGridProject(GetTestGridProjectRequest getTestGridProjectRequest)
Retrieves information about a Selenium testing project.
|
GetTestGridSessionResult |
getTestGridSession(GetTestGridSessionRequest getTestGridSessionRequest)
A session is an instance of a browser created through a
RemoteWebDriver with the URL from
CreateTestGridUrlResult$url. |
GetUploadResult |
getUpload(GetUploadRequest getUploadRequest)
Gets information about an upload.
|
GetVPCEConfigurationResult |
getVPCEConfiguration(GetVPCEConfigurationRequest getVPCEConfigurationRequest)
Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.
|
InstallToRemoteAccessSessionResult |
installToRemoteAccessSession(InstallToRemoteAccessSessionRequest installToRemoteAccessSessionRequest)
Installs an application to the device in a remote access session.
|
ListArtifactsResult |
listArtifacts(ListArtifactsRequest listArtifactsRequest)
Gets information about artifacts.
|
ListDeviceInstancesResult |
listDeviceInstances(ListDeviceInstancesRequest listDeviceInstancesRequest)
Returns information about the private device instances associated with one or more AWS accounts.
|
ListDevicePoolsResult |
listDevicePools(ListDevicePoolsRequest listDevicePoolsRequest)
Gets information about device pools.
|
ListDevicesResult |
listDevices(ListDevicesRequest listDevicesRequest)
Gets information about unique device types.
|
ListInstanceProfilesResult |
listInstanceProfiles(ListInstanceProfilesRequest listInstanceProfilesRequest)
Returns information about all the instance profiles in an AWS account.
|
ListJobsResult |
listJobs(ListJobsRequest listJobsRequest)
Gets information about jobs for a given test run.
|
ListNetworkProfilesResult |
listNetworkProfiles(ListNetworkProfilesRequest listNetworkProfilesRequest)
Returns the list of available network profiles.
|
ListOfferingPromotionsResult |
listOfferingPromotions(ListOfferingPromotionsRequest listOfferingPromotionsRequest)
Returns a list of offering promotions.
|
ListOfferingsResult |
listOfferings(ListOfferingsRequest listOfferingsRequest)
Returns a list of products or offerings that the user can manage through the API.
|
ListOfferingTransactionsResult |
listOfferingTransactions(ListOfferingTransactionsRequest listOfferingTransactionsRequest)
Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account.
|
ListProjectsResult |
listProjects(ListProjectsRequest listProjectsRequest)
Gets information about projects.
|
ListRemoteAccessSessionsResult |
listRemoteAccessSessions(ListRemoteAccessSessionsRequest listRemoteAccessSessionsRequest)
Returns a list of all currently running remote access sessions.
|
ListRunsResult |
listRuns(ListRunsRequest listRunsRequest)
Gets information about runs, given an AWS Device Farm project ARN.
|
ListSamplesResult |
listSamples(ListSamplesRequest listSamplesRequest)
Gets information about samples, given an AWS Device Farm job ARN.
|
ListSuitesResult |
listSuites(ListSuitesRequest listSuitesRequest)
Gets information about test suites for a given job.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List the tags for an AWS Device Farm resource.
|
ListTestGridProjectsResult |
listTestGridProjects(ListTestGridProjectsRequest listTestGridProjectsRequest)
Gets a list of all Selenium testing projects in your account.
|
ListTestGridSessionActionsResult |
listTestGridSessionActions(ListTestGridSessionActionsRequest listTestGridSessionActionsRequest)
Returns a list of the actions taken in a TestGridSession.
|
ListTestGridSessionArtifactsResult |
listTestGridSessionArtifacts(ListTestGridSessionArtifactsRequest listTestGridSessionArtifactsRequest)
Retrieves a list of artifacts created during the session.
|
ListTestGridSessionsResult |
listTestGridSessions(ListTestGridSessionsRequest listTestGridSessionsRequest)
Retrieves a list of sessions for a TestGridProject.
|
ListTestsResult |
listTests(ListTestsRequest listTestsRequest)
Gets information about tests in a given test suite.
|
ListUniqueProblemsResult |
listUniqueProblems(ListUniqueProblemsRequest listUniqueProblemsRequest)
Gets information about unique problems, such as exceptions or crashes.
|
ListUploadsResult |
listUploads(ListUploadsRequest listUploadsRequest)
Gets information about uploads, given an AWS Device Farm project ARN.
|
ListVPCEConfigurationsResult |
listVPCEConfigurations(ListVPCEConfigurationsRequest listVPCEConfigurationsRequest)
Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.
|
PurchaseOfferingResult |
purchaseOffering(PurchaseOfferingRequest purchaseOfferingRequest)
Immediately purchases offerings for an AWS account.
|
RenewOfferingResult |
renewOffering(RenewOfferingRequest renewOfferingRequest)
Explicitly sets the quantity of devices to renew for an offering, starting from the
effectiveDate of
the next period. |
ScheduleRunResult |
scheduleRun(ScheduleRunRequest scheduleRunRequest)
Schedules a run.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StopJobResult |
stopJob(StopJobRequest stopJobRequest)
Initiates a stop request for the current job.
|
StopRemoteAccessSessionResult |
stopRemoteAccessSession(StopRemoteAccessSessionRequest stopRemoteAccessSessionRequest)
Ends a specified remote access session.
|
StopRunResult |
stopRun(StopRunRequest stopRunRequest)
Initiates a stop request for the current test run.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Associates the specified tags to a resource with the specified
resourceArn. |
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Deletes the specified tags from a resource.
|
UpdateDeviceInstanceResult |
updateDeviceInstance(UpdateDeviceInstanceRequest updateDeviceInstanceRequest)
Updates information about a private device instance.
|
UpdateDevicePoolResult |
updateDevicePool(UpdateDevicePoolRequest updateDevicePoolRequest)
Modifies the name, description, and rules in a device pool given the attributes and the pool ARN.
|
UpdateInstanceProfileResult |
updateInstanceProfile(UpdateInstanceProfileRequest updateInstanceProfileRequest)
Updates information about an existing private device instance profile.
|
UpdateNetworkProfileResult |
updateNetworkProfile(UpdateNetworkProfileRequest updateNetworkProfileRequest)
Updates the network profile.
|
UpdateProjectResult |
updateProject(UpdateProjectRequest updateProjectRequest)
Modifies the specified project name, given the project ARN and a new name.
|
UpdateTestGridProjectResult |
updateTestGridProject(UpdateTestGridProjectRequest updateTestGridProjectRequest)
Change details of a project.
|
UpdateUploadResult |
updateUpload(UpdateUploadRequest updateUploadRequest)
Updates an uploaded test spec.
|
UpdateVPCEConfigurationResult |
updateVPCEConfiguration(UpdateVPCEConfigurationRequest updateVPCEConfigurationRequest)
Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
Callers can pass in just the endpoint (ex: "devicefarm.us-west-2.amazonaws.com") or a full URL, including the
protocol (ex: "https://devicefarm.us-west-2.amazonaws.com"). If the protocol is not specified here, the default
protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint - The endpoint (ex: "devicefarm.us-west-2.amazonaws.com") or a full URL, including the protocol (ex:
"https://devicefarm.us-west-2.amazonaws.com") of the region specific AWS endpoint this client will
communicate with.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)setEndpoint(String), sets the regional endpoint for this client's service
calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)CreateDevicePoolResult createDevicePool(CreateDevicePoolRequest createDevicePoolRequest)
Creates a device pool.
createDevicePoolRequest - Represents a request to the create device pool operation.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
CreateDevicePoolRequest request = new CreateDevicePoolRequest()
//You can get the project ARN by using the list-projects CLI command.
.withProjectArn("arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456")//A device pool contains related devices, such as devices that run only on Android or that run only on iOS.
.withName("MyDevicePool").withDescription("My Android devices").withRules(new ArrayList());
CreateDevicePoolResult response = client.createDevicePool(request);CreateInstanceProfileResult createInstanceProfile(CreateInstanceProfileRequest createInstanceProfileRequest)
Creates a profile that can be applied to one or more private fleet device instances.
createInstanceProfileRequest - 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.CreateNetworkProfileResult createNetworkProfile(CreateNetworkProfileRequest createNetworkProfileRequest)
Creates a network profile.
createNetworkProfileRequest - 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.CreateProjectResult createProject(CreateProjectRequest createProjectRequest)
Creates a project.
createProjectRequest - Represents a request to the create project operation.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.TagOperationException - The operation was not successful. Try again.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
CreateProjectRequest request = new CreateProjectRequest()
//A project in Device Farm is a workspace that contains test runs. A run is a test of a single app against one or more devices.
.withName("MyProject");
CreateProjectResult response = client.createProject(request);CreateRemoteAccessSessionResult createRemoteAccessSession(CreateRemoteAccessSessionRequest createRemoteAccessSessionRequest)
Specifies and starts a remote access session.
createRemoteAccessSessionRequest - Creates and submits a request to start a remote access session.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
CreateRemoteAccessSessionRequest request = new CreateRemoteAccessSessionRequest()
//You can get the project ARN by using the list-projects CLI command.
.withProjectArn("arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456")
//You can get the device ARN by using the list-devices CLI command.
.withDeviceArn("arn:aws:devicefarm:us-west-2::device:123EXAMPLE").withName("MySession")
.withConfiguration(new CreateRemoteAccessSessionConfiguration().withBillingMethod("METERED"));
CreateRemoteAccessSessionResult response = client.createRemoteAccessSession(request);CreateTestGridProjectResult createTestGridProject(CreateTestGridProjectRequest createTestGridProjectRequest)
Creates a Selenium testing project. Projects are used to track TestGridSession instances.
createTestGridProjectRequest - ArgumentException - An invalid argument was specified.LimitExceededException - A limit was exceeded.InternalServiceException - An internal exception was raised in the service. Contact aws-devicefarm-support@amazon.com if you see this
error.CreateTestGridUrlResult createTestGridUrl(CreateTestGridUrlRequest createTestGridUrlRequest)
Creates a signed, short-term URL that can be passed to a Selenium RemoteWebDriver constructor.
createTestGridUrlRequest - NotFoundException - The specified entity was not found.ArgumentException - An invalid argument was specified.InternalServiceException - An internal exception was raised in the service. Contact aws-devicefarm-support@amazon.com if you see this
error.CreateUploadResult createUpload(CreateUploadRequest createUploadRequest)
Uploads an app or test scripts.
createUploadRequest - Represents a request to the create upload operation.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
CreateUploadRequest request = new CreateUploadRequest()
//You can get the project ARN by using the list-projects CLI command.
.withProjectArn("arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456").withName("MyAppiumPythonUpload")
.withType("APPIUM_PYTHON_TEST_PACKAGE");
CreateUploadResult response = client.createUpload(request);CreateVPCEConfigurationResult createVPCEConfiguration(CreateVPCEConfigurationRequest createVPCEConfigurationRequest)
Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.
createVPCEConfigurationRequest - ArgumentException - An invalid argument was specified.LimitExceededException - A limit was exceeded.ServiceAccountException - There was a problem with the service account.DeleteDevicePoolResult deleteDevicePool(DeleteDevicePoolRequest deleteDevicePoolRequest)
Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.
deleteDevicePoolRequest - Represents a request to the delete device pool operation.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
DeleteDevicePoolRequest request = new DeleteDevicePoolRequest()
//You can get the device pool ARN by using the list-device-pools CLI command.
.withArn("arn:aws:devicefarm:us-west-2::devicepool:123-456-EXAMPLE-GUID");
DeleteDevicePoolResult response = client.deleteDevicePool(request);DeleteInstanceProfileResult deleteInstanceProfile(DeleteInstanceProfileRequest deleteInstanceProfileRequest)
Deletes a profile that can be applied to one or more private device instances.
deleteInstanceProfileRequest - 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.DeleteNetworkProfileResult deleteNetworkProfile(DeleteNetworkProfileRequest deleteNetworkProfileRequest)
Deletes a network profile.
deleteNetworkProfileRequest - 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.DeleteProjectResult deleteProject(DeleteProjectRequest deleteProjectRequest)
Deletes an AWS Device Farm project, given the project ARN.
Deleting this resource does not stop an in-progress run.
deleteProjectRequest - Represents a request to the delete project operation.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
DeleteProjectRequest request = new DeleteProjectRequest()
//You can get the project ARN by using the list-projects CLI command.
.withArn("arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456");
DeleteProjectResult response = client.deleteProject(request);DeleteRemoteAccessSessionResult deleteRemoteAccessSession(DeleteRemoteAccessSessionRequest deleteRemoteAccessSessionRequest)
Deletes a completed remote access session and its results.
deleteRemoteAccessSessionRequest - Represents the request to delete the specified remote access session.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
DeleteRemoteAccessSessionRequest request = new DeleteRemoteAccessSessionRequest()
//You can get the remote access session ARN by using the list-remote-access-sessions CLI command.
.withArn("arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456");
DeleteRemoteAccessSessionResult response = client.deleteRemoteAccessSession(request);DeleteRunResult deleteRun(DeleteRunRequest deleteRunRequest)
Deletes the run, given the run ARN.
Deleting this resource does not stop an in-progress run.
deleteRunRequest - Represents a request to the delete run operation.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
DeleteRunRequest request = new DeleteRunRequest()
//You can get the run ARN by using the list-runs CLI command.
.withArn("arn:aws:devicefarm:us-west-2:123456789101:run:EXAMPLE-GUID-123-456");
DeleteRunResult response = client.deleteRun(request);DeleteTestGridProjectResult deleteTestGridProject(DeleteTestGridProjectRequest deleteTestGridProjectRequest)
Deletes a Selenium testing project and all content generated under it.
You cannot undo this operation.
You cannot delete a project if it has active sessions.
deleteTestGridProjectRequest - NotFoundException - The specified entity was not found.ArgumentException - An invalid argument was specified.CannotDeleteException - The requested object could not be deleted.InternalServiceException - An internal exception was raised in the service. Contact aws-devicefarm-support@amazon.com if you see this
error.DeleteUploadResult deleteUpload(DeleteUploadRequest deleteUploadRequest)
Deletes an upload given the upload ARN.
deleteUploadRequest - Represents a request to the delete upload operation.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
DeleteUploadRequest request = new DeleteUploadRequest()
//You can get the upload ARN by using the list-uploads CLI command.
.withArn("arn:aws:devicefarm:us-west-2:123456789101:upload:EXAMPLE-GUID-123-456");
DeleteUploadResult response = client.deleteUpload(request);DeleteVPCEConfigurationResult deleteVPCEConfiguration(DeleteVPCEConfigurationRequest deleteVPCEConfigurationRequest)
Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.
deleteVPCEConfigurationRequest - ArgumentException - An invalid argument was specified.NotFoundException - The specified entity was not found.ServiceAccountException - There was a problem with the service account.InvalidOperationException - There was an error with the update request, or you do not have sufficient permissions to update this VPC
endpoint configuration.GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)
Returns the number of unmetered iOS or unmetered Android devices that have been purchased by the account.
getAccountSettingsRequest - Represents the request sent to retrieve the account settings.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build(); GetAccountSettingsRequest request = new GetAccountSettingsRequest(); GetAccountSettingsResult response = client.getAccountSettings(request);
GetDeviceResult getDevice(GetDeviceRequest getDeviceRequest)
Gets information about a unique device type.
getDeviceRequest - Represents a request to the get device request.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
GetDeviceRequest request = new GetDeviceRequest().withArn("arn:aws:devicefarm:us-west-2::device:123EXAMPLE");
GetDeviceResult response = client.getDevice(request);GetDeviceInstanceResult getDeviceInstance(GetDeviceInstanceRequest getDeviceInstanceRequest)
Returns information about a device instance that belongs to a private device fleet.
getDeviceInstanceRequest - 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.GetDevicePoolResult getDevicePool(GetDevicePoolRequest getDevicePoolRequest)
Gets information about a device pool.
getDevicePoolRequest - Represents a request to the get device pool operation.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
GetDevicePoolRequest request = new GetDevicePoolRequest()
//You can obtain the project ARN by using the list-projects CLI command.
.withArn("arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456");
GetDevicePoolResult response = client.getDevicePool(request);GetDevicePoolCompatibilityResult getDevicePoolCompatibility(GetDevicePoolCompatibilityRequest getDevicePoolCompatibilityRequest)
Gets information about compatibility with a device pool.
getDevicePoolCompatibilityRequest - Represents a request to the get device pool compatibility operation.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
GetDevicePoolCompatibilityRequest request = new GetDevicePoolCompatibilityRequest()
//You can get the device pool ARN by using the list-device-pools CLI command.
.withDevicePoolArn("arn:aws:devicefarm:us-west-2::devicepool:123-456-EXAMPLE-GUID")
.withAppArn("arn:aws:devicefarm:us-west-2::app:123-456-EXAMPLE-GUID").withTestType("APPIUM_PYTHON");
GetDevicePoolCompatibilityResult response = client.getDevicePoolCompatibility(request);GetInstanceProfileResult getInstanceProfile(GetInstanceProfileRequest getInstanceProfileRequest)
Returns information about the specified instance profile.
getInstanceProfileRequest - 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.GetJobResult getJob(GetJobRequest getJobRequest)
Gets information about a job.
getJobRequest - Represents a request to the get job operation.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
GetJobRequest request = new GetJobRequest()
//You can get the job ARN by using the list-jobs CLI command.
.withArn("arn:aws:devicefarm:us-west-2::job:123-456-EXAMPLE-GUID");
GetJobResult response = client.getJob(request);GetNetworkProfileResult getNetworkProfile(GetNetworkProfileRequest getNetworkProfileRequest)
Returns information about a network profile.
getNetworkProfileRequest - 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.GetOfferingStatusResult 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. If you must be
able to invoke this operation, contact aws-devicefarm-support@amazon.com.
getOfferingStatusRequest - Represents the request to retrieve the offering status for the specified customer or account.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
GetOfferingStatusRequest request = new GetOfferingStatusRequest()
//A dynamically generated value, used for paginating results.
.withNextToken("RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE=");
GetOfferingStatusResult response = client.getOfferingStatus(request);GetProjectResult getProject(GetProjectRequest getProjectRequest)
Gets information about a project.
getProjectRequest - Represents a request to the get project operation.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
GetProjectRequest request = new GetProjectRequest()
//You can get the project ARN by using the list-projects CLI command.
.withArn("arn:aws:devicefarm:us-west-2:123456789101:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE");
GetProjectResult response = client.getProject(request);GetRemoteAccessSessionResult getRemoteAccessSession(GetRemoteAccessSessionRequest getRemoteAccessSessionRequest)
Returns a link to a currently running remote access session.
getRemoteAccessSessionRequest - Represents the request to get information about the specified remote access session.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
GetRemoteAccessSessionRequest request = new GetRemoteAccessSessionRequest()
//You can get the remote access session ARN by using the list-remote-access-sessions CLI command.
.withArn("arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456");
GetRemoteAccessSessionResult response = client.getRemoteAccessSession(request);GetRunResult getRun(GetRunRequest getRunRequest)
Gets information about a run.
getRunRequest - Represents a request to the get run operation.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
GetRunRequest request = new GetRunRequest()
//You can get the run ARN by using the list-runs CLI command.
.withArn("arn:aws:devicefarm:us-west-2:123456789101:run:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/0fcac17b-6122-44d7-ae5a-12345EXAMPLE");
GetRunResult response = client.getRun(request);GetSuiteResult getSuite(GetSuiteRequest getSuiteRequest)
Gets information about a suite.
getSuiteRequest - Represents a request to the get suite operation.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
GetSuiteRequest request = new GetSuiteRequest()
//You can get the suite ARN by using the list-suites CLI command.
.withArn("arn:aws:devicefarm:us-west-2:123456789101:suite:EXAMPLE-GUID-123-456");
GetSuiteResult response = client.getSuite(request);GetTestResult getTest(GetTestRequest getTestRequest)
Gets information about a test.
getTestRequest - Represents a request to the get test operation.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
GetTestRequest request = new GetTestRequest()
//You can get the test ARN by using the list-tests CLI command.
.withArn("arn:aws:devicefarm:us-west-2:123456789101:test:EXAMPLE-GUID-123-456");
GetTestResult response = client.getTest(request);GetTestGridProjectResult getTestGridProject(GetTestGridProjectRequest getTestGridProjectRequest)
Retrieves information about a Selenium testing project.
getTestGridProjectRequest - NotFoundException - The specified entity was not found.ArgumentException - An invalid argument was specified.InternalServiceException - An internal exception was raised in the service. Contact aws-devicefarm-support@amazon.com if you see this
error.GetTestGridSessionResult getTestGridSession(GetTestGridSessionRequest getTestGridSessionRequest)
A session is an instance of a browser created through a RemoteWebDriver with the URL from
CreateTestGridUrlResult$url. You can use the following to look up sessions:
The session ARN (GetTestGridSessionRequest$sessionArn).
The project ARN and a session ID (GetTestGridSessionRequest$projectArn and GetTestGridSessionRequest$sessionId).
getTestGridSessionRequest - NotFoundException - The specified entity was not found.ArgumentException - An invalid argument was specified.InternalServiceException - An internal exception was raised in the service. Contact aws-devicefarm-support@amazon.com if you see this
error.GetUploadResult getUpload(GetUploadRequest getUploadRequest)
Gets information about an upload.
getUploadRequest - Represents a request to the get upload operation.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
GetUploadRequest request = new GetUploadRequest()
//You can get the test ARN by using the list-uploads CLI command.
.withArn("arn:aws:devicefarm:us-west-2:123456789101:upload:EXAMPLE-GUID-123-456");
GetUploadResult response = client.getUpload(request);GetVPCEConfigurationResult getVPCEConfiguration(GetVPCEConfigurationRequest getVPCEConfigurationRequest)
Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.
getVPCEConfigurationRequest - ArgumentException - An invalid argument was specified.NotFoundException - The specified entity was not found.ServiceAccountException - There was a problem with the service account.InstallToRemoteAccessSessionResult 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.
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.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
InstallToRemoteAccessSessionRequest request = new InstallToRemoteAccessSessionRequest()
//You can get the remote access session ARN by using the list-remote-access-sessions CLI command.
.withRemoteAccessSessionArn("arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456").withAppArn(
"arn:aws:devicefarm:us-west-2:123456789101:app:EXAMPLE-GUID-123-456");
InstallToRemoteAccessSessionResult response = client.installToRemoteAccessSession(request);ListArtifactsResult listArtifacts(ListArtifactsRequest listArtifactsRequest)
Gets information about artifacts.
listArtifactsRequest - Represents a request to the list artifacts operation.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
ListArtifactsRequest request = new ListArtifactsRequest()
//Can also be used to list artifacts for a Job, Suite, or Test ARN.
.withArn("arn:aws:devicefarm:us-west-2:123456789101:run:EXAMPLE-GUID-123-456").withType("SCREENSHOT");
ListArtifactsResult response = client.listArtifacts(request);ListDeviceInstancesResult listDeviceInstances(ListDeviceInstancesRequest listDeviceInstancesRequest)
Returns information about the private device instances associated with one or more AWS accounts.
listDeviceInstancesRequest - 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.ListDevicePoolsResult listDevicePools(ListDevicePoolsRequest listDevicePoolsRequest)
Gets information about device pools.
listDevicePoolsRequest - Represents the result of a list device pools request.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
ListDevicePoolsRequest request = new ListDevicePoolsRequest()
//You can get the project ARN by using the list-projects CLI command.
.withArn("arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456").withType("PRIVATE");
ListDevicePoolsResult response = client.listDevicePools(request);ListDevicesResult listDevices(ListDevicesRequest listDevicesRequest)
Gets information about unique device types.
listDevicesRequest - Represents the result of a list devices request.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
ListDevicesRequest request = new ListDevicesRequest()
//You can get the project ARN by using the list-projects CLI command.
.withArn("arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456");
ListDevicesResult response = client.listDevices(request);ListInstanceProfilesResult listInstanceProfiles(ListInstanceProfilesRequest listInstanceProfilesRequest)
Returns information about all the instance profiles in an AWS account.
listInstanceProfilesRequest - 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.ListJobsResult listJobs(ListJobsRequest listJobsRequest)
Gets information about jobs for a given test run.
listJobsRequest - Represents a request to the list jobs operation.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
ListJobsRequest request = new ListJobsRequest()
//You can get the project ARN by using the list-jobs CLI command.
.withArn("arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456");
ListJobsResult response = client.listJobs(request);ListNetworkProfilesResult listNetworkProfiles(ListNetworkProfilesRequest listNetworkProfilesRequest)
Returns the list of available network profiles.
listNetworkProfilesRequest - 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.ListOfferingPromotionsResult 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 must be able to invoke this operation.
listOfferingPromotionsRequest - 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.ListOfferingTransactionsResult 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. If you must be able to
invoke this operation, contact aws-devicefarm-support@amazon.com.
listOfferingTransactionsRequest - Represents the request to list the offering transaction history.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
ListOfferingTransactionsRequest request = new ListOfferingTransactionsRequest()
//A dynamically generated value, used for paginating results.
.withNextToken("RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE=");
ListOfferingTransactionsResult response = client.listOfferingTransactions(request);ListOfferingsResult 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. If you must be able to invoke this operation, contact
aws-devicefarm-support@amazon.com.
listOfferingsRequest - Represents the request to list all offerings.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
ListOfferingsRequest request = new ListOfferingsRequest()
//A dynamically generated value, used for paginating results.
.withNextToken("RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE=");
ListOfferingsResult response = client.listOfferings(request);ListProjectsResult listProjects(ListProjectsRequest listProjectsRequest)
Gets information about projects.
listProjectsRequest - Represents a request to the list projects operation.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
ListProjectsRequest request = new ListProjectsRequest().withArn(
"arn:aws:devicefarm:us-west-2:123456789101:project:7ad300ed-8183-41a7-bf94-12345EXAMPLE")//A dynamically generated value, used for paginating results.
.withNextToken("RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE");
ListProjectsResult response = client.listProjects(request);ListRemoteAccessSessionsResult listRemoteAccessSessions(ListRemoteAccessSessionsRequest listRemoteAccessSessionsRequest)
Returns a list of all currently running remote access sessions.
listRemoteAccessSessionsRequest - Represents the request to return information about the remote access session.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
ListRemoteAccessSessionsRequest request = new ListRemoteAccessSessionsRequest()
//You can get the Amazon Resource Name (ARN) of the session by using the list-sessions CLI command.
.withArn("arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456")//A dynamically generated value, used for paginating results.
.withNextToken("RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE=");
ListRemoteAccessSessionsResult response = client.listRemoteAccessSessions(request);ListRunsResult listRuns(ListRunsRequest listRunsRequest)
Gets information about runs, given an AWS Device Farm project ARN.
listRunsRequest - Represents a request to the list runs operation.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
ListRunsRequest request = new ListRunsRequest()
//You can get the Amazon Resource Name (ARN) of the run by using the list-runs CLI command.
.withArn("arn:aws:devicefarm:us-west-2:123456789101:run:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/0fcac17b-6122-44d7-ae5a-12345EXAMPLE")//A dynamically generated value, used for paginating results.
.withNextToken("RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE");
ListRunsResult response = client.listRuns(request);ListSamplesResult listSamples(ListSamplesRequest listSamplesRequest)
Gets information about samples, given an AWS Device Farm job ARN.
listSamplesRequest - Represents a request to the list samples operation.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
ListSamplesRequest request = new ListSamplesRequest()
//You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.
.withArn("arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456")//A dynamically generated value, used for paginating results.
.withNextToken("RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE");
ListSamplesResult response = client.listSamples(request);ListSuitesResult listSuites(ListSuitesRequest listSuitesRequest)
Gets information about test suites for a given job.
listSuitesRequest - Represents a request to the list suites operation.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
ListSuitesRequest request = new ListSuitesRequest()
//You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.
.withArn("arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456")//A dynamically generated value, used for paginating results.
.withNextToken("RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE");
ListSuitesResult response = client.listSuites(request);ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List the tags for an AWS Device Farm resource.
listTagsForResourceRequest - ArgumentException - An invalid argument was specified.NotFoundException - The specified entity was not found.TagOperationException - The operation was not successful. Try again.ListTestGridProjectsResult listTestGridProjects(ListTestGridProjectsRequest listTestGridProjectsRequest)
Gets a list of all Selenium testing projects in your account.
listTestGridProjectsRequest - ArgumentException - An invalid argument was specified.InternalServiceException - An internal exception was raised in the service. Contact aws-devicefarm-support@amazon.com if you see this
error.ListTestGridSessionActionsResult listTestGridSessionActions(ListTestGridSessionActionsRequest listTestGridSessionActionsRequest)
Returns a list of the actions taken in a TestGridSession.
listTestGridSessionActionsRequest - NotFoundException - The specified entity was not found.ArgumentException - An invalid argument was specified.InternalServiceException - An internal exception was raised in the service. Contact aws-devicefarm-support@amazon.com if you see this
error.ListTestGridSessionArtifactsResult listTestGridSessionArtifacts(ListTestGridSessionArtifactsRequest listTestGridSessionArtifactsRequest)
Retrieves a list of artifacts created during the session.
listTestGridSessionArtifactsRequest - NotFoundException - The specified entity was not found.ArgumentException - An invalid argument was specified.InternalServiceException - An internal exception was raised in the service. Contact aws-devicefarm-support@amazon.com if you see this
error.ListTestGridSessionsResult listTestGridSessions(ListTestGridSessionsRequest listTestGridSessionsRequest)
Retrieves a list of sessions for a TestGridProject.
listTestGridSessionsRequest - NotFoundException - The specified entity was not found.ArgumentException - An invalid argument was specified.InternalServiceException - An internal exception was raised in the service. Contact aws-devicefarm-support@amazon.com if you see this
error.ListTestsResult listTests(ListTestsRequest listTestsRequest)
Gets information about tests in a given test suite.
listTestsRequest - Represents a request to the list tests operation.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
ListTestsRequest request = new ListTestsRequest()
//You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.
.withArn("arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456")//A dynamically generated value, used for paginating results.
.withNextToken("RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE");
ListTestsResult response = client.listTests(request);ListUniqueProblemsResult listUniqueProblems(ListUniqueProblemsRequest listUniqueProblemsRequest)
Gets information about unique problems, such as exceptions or crashes.
Unique problems are defined as a single instance of an error across a run, job, or suite. For example, if a call
in your application consistently raises an exception (OutOfBoundsException in MyActivity.java:386),
ListUniqueProblems returns a single entry instead of many individual entries for that exception.
listUniqueProblemsRequest - Represents a request to the list unique problems operation.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
ListUniqueProblemsRequest request = new ListUniqueProblemsRequest()
//You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.
.withArn("arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456")//A dynamically generated value, used for paginating results.
.withNextToken("RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE");
ListUniqueProblemsResult response = client.listUniqueProblems(request);ListUploadsResult listUploads(ListUploadsRequest listUploadsRequest)
Gets information about uploads, given an AWS Device Farm project ARN.
listUploadsRequest - Represents a request to the list uploads operation.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
ListUploadsRequest request = new ListUploadsRequest()
//You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.
.withArn("arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456")//A dynamically generated value, used for paginating results.
.withNextToken("RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE");
ListUploadsResult response = client.listUploads(request);ListVPCEConfigurationsResult listVPCEConfigurations(ListVPCEConfigurationsRequest listVPCEConfigurationsRequest)
Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.
listVPCEConfigurationsRequest - ArgumentException - An invalid argument was specified.ServiceAccountException - There was a problem with the service account.PurchaseOfferingResult 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. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.
purchaseOfferingRequest - Represents a request for a purchase offering.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
PurchaseOfferingRequest request = new PurchaseOfferingRequest()
//You can get the offering ID by using the list-offerings CLI command.
.withOfferingId("D68B3C05-1BA6-4360-BC69-12345EXAMPLE").withQuantity(1);
PurchaseOfferingResult response = client.purchaseOffering(request);RenewOfferingResult 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. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.
renewOfferingRequest - A request that represents an offering renewal.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
RenewOfferingRequest request = new RenewOfferingRequest()
//You can get the offering ID by using the list-offerings CLI command.
.withOfferingId("D68B3C05-1BA6-4360-BC69-12345EXAMPLE").withQuantity(1);
RenewOfferingResult response = client.renewOffering(request);ScheduleRunResult scheduleRun(ScheduleRunRequest scheduleRunRequest)
Schedules a run.
scheduleRunRequest - Represents a request to the schedule run operation.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
ScheduleRunRequest request = new ScheduleRunRequest()
//You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.
.withProjectArn("arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456")
//You can get the Amazon Resource Name (ARN) of the device pool by using the list-pools CLI command.
.withDevicePoolArn("arn:aws:devicefarm:us-west-2:123456789101:pool:EXAMPLE-GUID-123-456")
.withName("MyRun")
.withTest(
new ScheduleRunTest().withType("APPIUM_JAVA_JUNIT").withTestPackageArn(
"arn:aws:devicefarm:us-west-2:123456789101:test:EXAMPLE-GUID-123-456"));
ScheduleRunResult response = client.scheduleRun(request);StopJobResult stopJob(StopJobRequest stopJobRequest)
Initiates a stop request for the current job. AWS Device Farm immediately stops the job on the device where tests have not started. You are not billed for this device. On the device where tests have started, setup suite and teardown suite tests run to completion on the device. You are billed for setup, teardown, and any tests that were in progress or already completed.
stopJobRequest - 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.StopRemoteAccessSessionResult stopRemoteAccessSession(StopRemoteAccessSessionRequest stopRemoteAccessSessionRequest)
Ends a specified remote access session.
stopRemoteAccessSessionRequest - Represents the request to stop the remote access session.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.StopRunResult stopRun(StopRunRequest stopRunRequest)
Initiates a stop request for the current test run. AWS Device Farm immediately stops the run on devices where tests have not started. You are not billed for these devices. On devices where tests have started executing, setup suite and teardown suite tests run to completion on those devices. You are billed for setup, teardown, and any tests that were in progress or already completed.
stopRunRequest - Represents the request to stop a specific run.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
StopRunRequest request = new StopRunRequest()
//You can get the Amazon Resource Name (ARN) of the test run by using the list-runs CLI command.
.withArn("arn:aws:devicefarm:us-west-2:123456789101:run:EXAMPLE-GUID-123-456");
StopRunResult response = client.stopRun(request);TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Associates the specified tags to a resource with the specified resourceArn. If existing tags on a
resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags
associated with that resource are also deleted.
tagResourceRequest - ArgumentException - An invalid argument was specified.NotFoundException - The specified entity was not found.TagOperationException - The operation was not successful. Try again.TooManyTagsException - The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a
repository is 50.TagPolicyException - The request doesn't comply with the AWS Identity and Access Management (IAM) tag policy. Correct your
request and then retry it.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Deletes the specified tags from a resource.
untagResourceRequest - ArgumentException - An invalid argument was specified.NotFoundException - The specified entity was not found.TagOperationException - The operation was not successful. Try again.UpdateDeviceInstanceResult updateDeviceInstance(UpdateDeviceInstanceRequest updateDeviceInstanceRequest)
Updates information about a private device instance.
updateDeviceInstanceRequest - 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.UpdateDevicePoolResult 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).
updateDevicePoolRequest - Represents a request to the update device pool operation.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
UpdateDevicePoolRequest request = new UpdateDevicePoolRequest()
//You can get the Amazon Resource Name (ARN) of the device pool by using the list-pools CLI command.
.withArn("arn:aws:devicefarm:us-west-2::devicepool:082d10e5-d7d7-48a5-ba5c-12345EXAMPLE").withName("NewName").withDescription("NewDescription")
.withRules(new Rule().withAttribute("REMOTE_ACCESS_ENABLED").withOperator("EQUALS").withValue("True"));
UpdateDevicePoolResult response = client.updateDevicePool(request);UpdateInstanceProfileResult updateInstanceProfile(UpdateInstanceProfileRequest updateInstanceProfileRequest)
Updates information about an existing private device instance profile.
updateInstanceProfileRequest - 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.UpdateNetworkProfileResult updateNetworkProfile(UpdateNetworkProfileRequest updateNetworkProfileRequest)
Updates the network profile.
updateNetworkProfileRequest - 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.UpdateProjectResult updateProject(UpdateProjectRequest updateProjectRequest)
Modifies the specified project name, given the project ARN and a new name.
updateProjectRequest - Represents a request to the update project operation.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.AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build();
UpdateProjectRequest request = new UpdateProjectRequest()
//You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.
.withArn("arn:aws:devicefarm:us-west-2:123456789101:project:8f75187d-101e-4625-accc-12345EXAMPLE").withName("NewName");
UpdateProjectResult response = client.updateProject(request);UpdateTestGridProjectResult updateTestGridProject(UpdateTestGridProjectRequest updateTestGridProjectRequest)
Change details of a project.
updateTestGridProjectRequest - NotFoundException - The specified entity was not found.ArgumentException - An invalid argument was specified.LimitExceededException - A limit was exceeded.InternalServiceException - An internal exception was raised in the service. Contact aws-devicefarm-support@amazon.com if you see this
error.UpdateUploadResult updateUpload(UpdateUploadRequest updateUploadRequest)
Updates an uploaded test spec.
updateUploadRequest - 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.UpdateVPCEConfigurationResult updateVPCEConfiguration(UpdateVPCEConfigurationRequest updateVPCEConfigurationRequest)
Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.
updateVPCEConfigurationRequest - ArgumentException - An invalid argument was specified.NotFoundException - The specified entity was not found.ServiceAccountException - There was a problem with the service account.InvalidOperationException - There was an error with the update request, or you do not have sufficient permissions to update this VPC
endpoint configuration.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 a request.
request - The originally executed request.