@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSDeviceFarmClient extends AmazonWebServiceClient implements AWSDeviceFarm
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AWSDeviceFarmClient()
Deprecated.
|
AWSDeviceFarmClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSDeviceFarmClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSDeviceFarmClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSDeviceFarmClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSDeviceFarmClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSDeviceFarmClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSDeviceFarmClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static AWSDeviceFarmClientBuilder |
builder() |
CreateDevicePoolResult |
createDevicePool(CreateDevicePoolRequest request)
Creates a device pool.
|
CreateInstanceProfileResult |
createInstanceProfile(CreateInstanceProfileRequest request)
Creates a profile that can be applied to one or more private fleet device instances.
|
CreateNetworkProfileResult |
createNetworkProfile(CreateNetworkProfileRequest request)
Creates a network profile.
|
CreateProjectResult |
createProject(CreateProjectRequest request)
Creates a project.
|
CreateRemoteAccessSessionResult |
createRemoteAccessSession(CreateRemoteAccessSessionRequest request)
Specifies and starts a remote access session.
|
CreateTestGridProjectResult |
createTestGridProject(CreateTestGridProjectRequest request)
Creates a Selenium testing project.
|
CreateTestGridUrlResult |
createTestGridUrl(CreateTestGridUrlRequest request)
Creates a signed, short-term URL that can be passed to a Selenium
RemoteWebDriver constructor. |
CreateUploadResult |
createUpload(CreateUploadRequest request)
Uploads an app or test scripts.
|
CreateVPCEConfigurationResult |
createVPCEConfiguration(CreateVPCEConfigurationRequest request)
Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.
|
DeleteDevicePoolResult |
deleteDevicePool(DeleteDevicePoolRequest request)
Deletes a device pool given the pool ARN.
|
DeleteInstanceProfileResult |
deleteInstanceProfile(DeleteInstanceProfileRequest request)
Deletes a profile that can be applied to one or more private device instances.
|
DeleteNetworkProfileResult |
deleteNetworkProfile(DeleteNetworkProfileRequest request)
Deletes a network profile.
|
DeleteProjectResult |
deleteProject(DeleteProjectRequest request)
Deletes an AWS Device Farm project, given the project ARN.
|
DeleteRemoteAccessSessionResult |
deleteRemoteAccessSession(DeleteRemoteAccessSessionRequest request)
Deletes a completed remote access session and its results.
|
DeleteRunResult |
deleteRun(DeleteRunRequest request)
Deletes the run, given the run ARN.
|
DeleteTestGridProjectResult |
deleteTestGridProject(DeleteTestGridProjectRequest request)
Deletes a Selenium testing project and all content generated under it.
|
DeleteUploadResult |
deleteUpload(DeleteUploadRequest request)
Deletes an upload given the upload ARN.
|
DeleteVPCEConfigurationResult |
deleteVPCEConfiguration(DeleteVPCEConfigurationRequest request)
Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.
|
GetAccountSettingsResult |
getAccountSettings(GetAccountSettingsRequest request)
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 request)
Gets information about a unique device type.
|
GetDeviceInstanceResult |
getDeviceInstance(GetDeviceInstanceRequest request)
Returns information about a device instance that belongs to a private device fleet.
|
GetDevicePoolResult |
getDevicePool(GetDevicePoolRequest request)
Gets information about a device pool.
|
GetDevicePoolCompatibilityResult |
getDevicePoolCompatibility(GetDevicePoolCompatibilityRequest request)
Gets information about compatibility with a device pool.
|
GetInstanceProfileResult |
getInstanceProfile(GetInstanceProfileRequest request)
Returns information about the specified instance profile.
|
GetJobResult |
getJob(GetJobRequest request)
Gets information about a job.
|
GetNetworkProfileResult |
getNetworkProfile(GetNetworkProfileRequest request)
Returns information about a network profile.
|
GetOfferingStatusResult |
getOfferingStatus(GetOfferingStatusRequest request)
Gets the current status and future status of all offerings purchased by an AWS account.
|
GetProjectResult |
getProject(GetProjectRequest request)
Gets information about a project.
|
GetRemoteAccessSessionResult |
getRemoteAccessSession(GetRemoteAccessSessionRequest request)
Returns a link to a currently running remote access session.
|
GetRunResult |
getRun(GetRunRequest request)
Gets information about a run.
|
GetSuiteResult |
getSuite(GetSuiteRequest request)
Gets information about a suite.
|
GetTestResult |
getTest(GetTestRequest request)
Gets information about a test.
|
GetTestGridProjectResult |
getTestGridProject(GetTestGridProjectRequest request)
Retrieves information about a Selenium testing project.
|
GetTestGridSessionResult |
getTestGridSession(GetTestGridSessionRequest request)
A session is an instance of a browser created through a
RemoteWebDriver with the URL from
CreateTestGridUrlResult$url. |
GetUploadResult |
getUpload(GetUploadRequest request)
Gets information about an upload.
|
GetVPCEConfigurationResult |
getVPCEConfiguration(GetVPCEConfigurationRequest request)
Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.
|
InstallToRemoteAccessSessionResult |
installToRemoteAccessSession(InstallToRemoteAccessSessionRequest request)
Installs an application to the device in a remote access session.
|
ListArtifactsResult |
listArtifacts(ListArtifactsRequest request)
Gets information about artifacts.
|
ListDeviceInstancesResult |
listDeviceInstances(ListDeviceInstancesRequest request)
Returns information about the private device instances associated with one or more AWS accounts.
|
ListDevicePoolsResult |
listDevicePools(ListDevicePoolsRequest request)
Gets information about device pools.
|
ListDevicesResult |
listDevices(ListDevicesRequest request)
Gets information about unique device types.
|
ListInstanceProfilesResult |
listInstanceProfiles(ListInstanceProfilesRequest request)
Returns information about all the instance profiles in an AWS account.
|
ListJobsResult |
listJobs(ListJobsRequest request)
Gets information about jobs for a given test run.
|
ListNetworkProfilesResult |
listNetworkProfiles(ListNetworkProfilesRequest request)
Returns the list of available network profiles.
|
ListOfferingPromotionsResult |
listOfferingPromotions(ListOfferingPromotionsRequest request)
Returns a list of offering promotions.
|
ListOfferingsResult |
listOfferings(ListOfferingsRequest request)
Returns a list of products or offerings that the user can manage through the API.
|
ListOfferingTransactionsResult |
listOfferingTransactions(ListOfferingTransactionsRequest request)
Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account.
|
ListProjectsResult |
listProjects(ListProjectsRequest request)
Gets information about projects.
|
ListRemoteAccessSessionsResult |
listRemoteAccessSessions(ListRemoteAccessSessionsRequest request)
Returns a list of all currently running remote access sessions.
|
ListRunsResult |
listRuns(ListRunsRequest request)
Gets information about runs, given an AWS Device Farm project ARN.
|
ListSamplesResult |
listSamples(ListSamplesRequest request)
Gets information about samples, given an AWS Device Farm job ARN.
|
ListSuitesResult |
listSuites(ListSuitesRequest request)
Gets information about test suites for a given job.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
List the tags for an AWS Device Farm resource.
|
ListTestGridProjectsResult |
listTestGridProjects(ListTestGridProjectsRequest request)
Gets a list of all Selenium testing projects in your account.
|
ListTestGridSessionActionsResult |
listTestGridSessionActions(ListTestGridSessionActionsRequest request)
Returns a list of the actions taken in a TestGridSession.
|
ListTestGridSessionArtifactsResult |
listTestGridSessionArtifacts(ListTestGridSessionArtifactsRequest request)
Retrieves a list of artifacts created during the session.
|
ListTestGridSessionsResult |
listTestGridSessions(ListTestGridSessionsRequest request)
Retrieves a list of sessions for a TestGridProject.
|
ListTestsResult |
listTests(ListTestsRequest request)
Gets information about tests in a given test suite.
|
ListUniqueProblemsResult |
listUniqueProblems(ListUniqueProblemsRequest request)
Gets information about unique problems, such as exceptions or crashes.
|
ListUploadsResult |
listUploads(ListUploadsRequest request)
Gets information about uploads, given an AWS Device Farm project ARN.
|
ListVPCEConfigurationsResult |
listVPCEConfigurations(ListVPCEConfigurationsRequest request)
Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.
|
PurchaseOfferingResult |
purchaseOffering(PurchaseOfferingRequest request)
Immediately purchases offerings for an AWS account.
|
RenewOfferingResult |
renewOffering(RenewOfferingRequest request)
Explicitly sets the quantity of devices to renew for an offering, starting from the
effectiveDate of
the next period. |
ScheduleRunResult |
scheduleRun(ScheduleRunRequest request)
Schedules a run.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StopJobResult |
stopJob(StopJobRequest request)
Initiates a stop request for the current job.
|
StopRemoteAccessSessionResult |
stopRemoteAccessSession(StopRemoteAccessSessionRequest request)
Ends a specified remote access session.
|
StopRunResult |
stopRun(StopRunRequest request)
Initiates a stop request for the current test run.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Associates the specified tags to a resource with the specified
resourceArn. |
UntagResourceResult |
untagResource(UntagResourceRequest request)
Deletes the specified tags from a resource.
|
UpdateDeviceInstanceResult |
updateDeviceInstance(UpdateDeviceInstanceRequest request)
Updates information about a private device instance.
|
UpdateDevicePoolResult |
updateDevicePool(UpdateDevicePoolRequest request)
Modifies the name, description, and rules in a device pool given the attributes and the pool ARN.
|
UpdateInstanceProfileResult |
updateInstanceProfile(UpdateInstanceProfileRequest request)
Updates information about an existing private device instance profile.
|
UpdateNetworkProfileResult |
updateNetworkProfile(UpdateNetworkProfileRequest request)
Updates the network profile.
|
UpdateProjectResult |
updateProject(UpdateProjectRequest request)
Modifies the specified project name, given the project ARN and a new name.
|
UpdateTestGridProjectResult |
updateTestGridProject(UpdateTestGridProjectRequest request)
Change details of a project.
|
UpdateUploadResult |
updateUpload(UpdateUploadRequest request)
Updates an uploaded test spec.
|
UpdateVPCEConfigurationResult |
updateVPCEConfiguration(UpdateVPCEConfigurationRequest request)
Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion@Deprecated public AWSDeviceFarmClient()
AWSDeviceFarmClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AWSDeviceFarmClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to AWS Device Farm (ex: proxy
settings, retry counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AWSDeviceFarmClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSDeviceFarmClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AWSDeviceFarmClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client connects to AWS Device Farm (ex: proxy
settings, retry counts, etc.).@Deprecated public AWSDeviceFarmClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AWSDeviceFarmClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to AWS Device Farm (ex: proxy
settings, retry counts, etc.).@Deprecated public AWSDeviceFarmClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to AWS Device Farm (ex: proxy
settings, retry counts, etc.).requestMetricCollector - optional request metric collectorpublic static AWSDeviceFarmClientBuilder builder()
public CreateDevicePoolResult createDevicePool(CreateDevicePoolRequest request)
Creates a device pool.
createDevicePool in interface AWSDeviceFarmcreateDevicePoolRequest - 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);public CreateInstanceProfileResult createInstanceProfile(CreateInstanceProfileRequest request)
Creates a profile that can be applied to one or more private fleet device instances.
createInstanceProfile in interface AWSDeviceFarmcreateInstanceProfileRequest - 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.public CreateNetworkProfileResult createNetworkProfile(CreateNetworkProfileRequest request)
Creates a network profile.
createNetworkProfile in interface AWSDeviceFarmcreateNetworkProfileRequest - 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.public CreateProjectResult createProject(CreateProjectRequest request)
Creates a project.
createProject in interface AWSDeviceFarmcreateProjectRequest - 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);public CreateRemoteAccessSessionResult createRemoteAccessSession(CreateRemoteAccessSessionRequest request)
Specifies and starts a remote access session.
createRemoteAccessSession in interface AWSDeviceFarmcreateRemoteAccessSessionRequest - 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);public CreateTestGridProjectResult createTestGridProject(CreateTestGridProjectRequest request)
Creates a Selenium testing project. Projects are used to track TestGridSession instances.
createTestGridProject in interface AWSDeviceFarmcreateTestGridProjectRequest - 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.public CreateTestGridUrlResult createTestGridUrl(CreateTestGridUrlRequest request)
Creates a signed, short-term URL that can be passed to a Selenium RemoteWebDriver constructor.
createTestGridUrl in interface AWSDeviceFarmcreateTestGridUrlRequest - 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.public CreateUploadResult createUpload(CreateUploadRequest request)
Uploads an app or test scripts.
createUpload in interface AWSDeviceFarmcreateUploadRequest - 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);public CreateVPCEConfigurationResult createVPCEConfiguration(CreateVPCEConfigurationRequest request)
Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.
createVPCEConfiguration in interface AWSDeviceFarmcreateVPCEConfigurationRequest - ArgumentException - An invalid argument was specified.LimitExceededException - A limit was exceeded.ServiceAccountException - There was a problem with the service account.public DeleteDevicePoolResult deleteDevicePool(DeleteDevicePoolRequest request)
Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.
deleteDevicePool in interface AWSDeviceFarmdeleteDevicePoolRequest - 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);public DeleteInstanceProfileResult deleteInstanceProfile(DeleteInstanceProfileRequest request)
Deletes a profile that can be applied to one or more private device instances.
deleteInstanceProfile in interface AWSDeviceFarmdeleteInstanceProfileRequest - 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.public DeleteNetworkProfileResult deleteNetworkProfile(DeleteNetworkProfileRequest request)
Deletes a network profile.
deleteNetworkProfile in interface AWSDeviceFarmdeleteNetworkProfileRequest - 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.public DeleteProjectResult deleteProject(DeleteProjectRequest request)
Deletes an AWS Device Farm project, given the project ARN.
Deleting this resource does not stop an in-progress run.
deleteProject in interface AWSDeviceFarmdeleteProjectRequest - 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);public DeleteRemoteAccessSessionResult deleteRemoteAccessSession(DeleteRemoteAccessSessionRequest request)
Deletes a completed remote access session and its results.
deleteRemoteAccessSession in interface AWSDeviceFarmdeleteRemoteAccessSessionRequest - 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);public DeleteRunResult deleteRun(DeleteRunRequest request)
Deletes the run, given the run ARN.
Deleting this resource does not stop an in-progress run.
deleteRun in interface AWSDeviceFarmdeleteRunRequest - 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);public DeleteTestGridProjectResult deleteTestGridProject(DeleteTestGridProjectRequest request)
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.
deleteTestGridProject in interface AWSDeviceFarmdeleteTestGridProjectRequest - 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.public DeleteUploadResult deleteUpload(DeleteUploadRequest request)
Deletes an upload given the upload ARN.
deleteUpload in interface AWSDeviceFarmdeleteUploadRequest - 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);public DeleteVPCEConfigurationResult deleteVPCEConfiguration(DeleteVPCEConfigurationRequest request)
Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.
deleteVPCEConfiguration in interface AWSDeviceFarmdeleteVPCEConfigurationRequest - 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.public GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest request)
Returns the number of unmetered iOS or unmetered Android devices that have been purchased by the account.
getAccountSettings in interface AWSDeviceFarmgetAccountSettingsRequest - 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);
public GetDeviceResult getDevice(GetDeviceRequest request)
Gets information about a unique device type.
getDevice in interface AWSDeviceFarmgetDeviceRequest - 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);public GetDeviceInstanceResult getDeviceInstance(GetDeviceInstanceRequest request)
Returns information about a device instance that belongs to a private device fleet.
getDeviceInstance in interface AWSDeviceFarmgetDeviceInstanceRequest - 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.public GetDevicePoolResult getDevicePool(GetDevicePoolRequest request)
Gets information about a device pool.
getDevicePool in interface AWSDeviceFarmgetDevicePoolRequest - 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);public GetDevicePoolCompatibilityResult getDevicePoolCompatibility(GetDevicePoolCompatibilityRequest request)
Gets information about compatibility with a device pool.
getDevicePoolCompatibility in interface AWSDeviceFarmgetDevicePoolCompatibilityRequest - 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);public GetInstanceProfileResult getInstanceProfile(GetInstanceProfileRequest request)
Returns information about the specified instance profile.
getInstanceProfile in interface AWSDeviceFarmgetInstanceProfileRequest - 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.public GetJobResult getJob(GetJobRequest request)
Gets information about a job.
getJob in interface AWSDeviceFarmgetJobRequest - 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);public GetNetworkProfileResult getNetworkProfile(GetNetworkProfileRequest request)
Returns information about a network profile.
getNetworkProfile in interface AWSDeviceFarmgetNetworkProfileRequest - 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.public GetOfferingStatusResult getOfferingStatus(GetOfferingStatusRequest request)
Gets the current status and future status of all offerings purchased by an AWS account. The response indicates
how many offerings are currently available and the offerings that will be available in the next period. The API
returns a NotEligible error if the user is not permitted to invoke the operation. If you must be
able to invoke this operation, contact aws-devicefarm-support@amazon.com.
getOfferingStatus in interface AWSDeviceFarmgetOfferingStatusRequest - 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);public GetProjectResult getProject(GetProjectRequest request)
Gets information about a project.
getProject in interface AWSDeviceFarmgetProjectRequest - 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);public GetRemoteAccessSessionResult getRemoteAccessSession(GetRemoteAccessSessionRequest request)
Returns a link to a currently running remote access session.
getRemoteAccessSession in interface AWSDeviceFarmgetRemoteAccessSessionRequest - 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);public GetRunResult getRun(GetRunRequest request)
Gets information about a run.
getRun in interface AWSDeviceFarmgetRunRequest - 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);public GetSuiteResult getSuite(GetSuiteRequest request)
Gets information about a suite.
getSuite in interface AWSDeviceFarmgetSuiteRequest - 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);public GetTestResult getTest(GetTestRequest request)
Gets information about a test.
getTest in interface AWSDeviceFarmgetTestRequest - 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);public GetTestGridProjectResult getTestGridProject(GetTestGridProjectRequest request)
Retrieves information about a Selenium testing project.
getTestGridProject in interface AWSDeviceFarmgetTestGridProjectRequest - 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.public GetTestGridSessionResult getTestGridSession(GetTestGridSessionRequest request)
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).
getTestGridSession in interface AWSDeviceFarmgetTestGridSessionRequest - 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.public GetUploadResult getUpload(GetUploadRequest request)
Gets information about an upload.
getUpload in interface AWSDeviceFarmgetUploadRequest - 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);public GetVPCEConfigurationResult getVPCEConfiguration(GetVPCEConfigurationRequest request)
Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.
getVPCEConfiguration in interface AWSDeviceFarmgetVPCEConfigurationRequest - ArgumentException - An invalid argument was specified.NotFoundException - The specified entity was not found.ServiceAccountException - There was a problem with the service account.public InstallToRemoteAccessSessionResult installToRemoteAccessSession(InstallToRemoteAccessSessionRequest request)
Installs an application to the device in a remote access session. For Android applications, the file must be in .apk format. For iOS applications, the file must be in .ipa format.
installToRemoteAccessSession in interface AWSDeviceFarminstallToRemoteAccessSessionRequest - 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);public ListArtifactsResult listArtifacts(ListArtifactsRequest request)
Gets information about artifacts.
listArtifacts in interface AWSDeviceFarmlistArtifactsRequest - 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);public ListDeviceInstancesResult listDeviceInstances(ListDeviceInstancesRequest request)
Returns information about the private device instances associated with one or more AWS accounts.
listDeviceInstances in interface AWSDeviceFarmlistDeviceInstancesRequest - 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.public ListDevicePoolsResult listDevicePools(ListDevicePoolsRequest request)
Gets information about device pools.
listDevicePools in interface AWSDeviceFarmlistDevicePoolsRequest - 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);public ListDevicesResult listDevices(ListDevicesRequest request)
Gets information about unique device types.
listDevices in interface AWSDeviceFarmlistDevicesRequest - 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);public ListInstanceProfilesResult listInstanceProfiles(ListInstanceProfilesRequest request)
Returns information about all the instance profiles in an AWS account.
listInstanceProfiles in interface AWSDeviceFarmlistInstanceProfilesRequest - 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.public ListJobsResult listJobs(ListJobsRequest request)
Gets information about jobs for a given test run.
listJobs in interface AWSDeviceFarmlistJobsRequest - 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);public ListNetworkProfilesResult listNetworkProfiles(ListNetworkProfilesRequest request)
Returns the list of available network profiles.
listNetworkProfiles in interface AWSDeviceFarmlistNetworkProfilesRequest - 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.public ListOfferingPromotionsResult listOfferingPromotions(ListOfferingPromotionsRequest request)
Returns a list of offering promotions. Each offering promotion record contains the ID and description of the
promotion. The API returns a NotEligible error if the caller is not permitted to invoke the
operation. Contact aws-devicefarm-support@amazon.com if
you must be able to invoke this operation.
listOfferingPromotions in interface AWSDeviceFarmlistOfferingPromotionsRequest - 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.public ListOfferingTransactionsResult listOfferingTransactions(ListOfferingTransactionsRequest request)
Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account. The
list is paginated and ordered by a descending timestamp (most recent transactions are first). The API returns a
NotEligible error if the user is not permitted to invoke the operation. If you must be able to
invoke this operation, contact aws-devicefarm-support@amazon.com.
listOfferingTransactions in interface AWSDeviceFarmlistOfferingTransactionsRequest - 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);public ListOfferingsResult listOfferings(ListOfferingsRequest request)
Returns a list of products or offerings that the user can manage through the API. Each offering record indicates
the recurring price per unit and the frequency for that offering. The API returns a NotEligible
error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact
aws-devicefarm-support@amazon.com.
listOfferings in interface AWSDeviceFarmlistOfferingsRequest - 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);public ListProjectsResult listProjects(ListProjectsRequest request)
Gets information about projects.
listProjects in interface AWSDeviceFarmlistProjectsRequest - 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);public ListRemoteAccessSessionsResult listRemoteAccessSessions(ListRemoteAccessSessionsRequest request)
Returns a list of all currently running remote access sessions.
listRemoteAccessSessions in interface AWSDeviceFarmlistRemoteAccessSessionsRequest - 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);public ListRunsResult listRuns(ListRunsRequest request)
Gets information about runs, given an AWS Device Farm project ARN.
listRuns in interface AWSDeviceFarmlistRunsRequest - 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);public ListSamplesResult listSamples(ListSamplesRequest request)
Gets information about samples, given an AWS Device Farm job ARN.
listSamples in interface AWSDeviceFarmlistSamplesRequest - 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);public ListSuitesResult listSuites(ListSuitesRequest request)
Gets information about test suites for a given job.
listSuites in interface AWSDeviceFarmlistSuitesRequest - 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);public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
List the tags for an AWS Device Farm resource.
listTagsForResource in interface AWSDeviceFarmlistTagsForResourceRequest - ArgumentException - An invalid argument was specified.NotFoundException - The specified entity was not found.TagOperationException - The operation was not successful. Try again.public ListTestGridProjectsResult listTestGridProjects(ListTestGridProjectsRequest request)
Gets a list of all Selenium testing projects in your account.
listTestGridProjects in interface AWSDeviceFarmlistTestGridProjectsRequest - 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.public ListTestGridSessionActionsResult listTestGridSessionActions(ListTestGridSessionActionsRequest request)
Returns a list of the actions taken in a TestGridSession.
listTestGridSessionActions in interface AWSDeviceFarmlistTestGridSessionActionsRequest - 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.public ListTestGridSessionArtifactsResult listTestGridSessionArtifacts(ListTestGridSessionArtifactsRequest request)
Retrieves a list of artifacts created during the session.
listTestGridSessionArtifacts in interface AWSDeviceFarmlistTestGridSessionArtifactsRequest - 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.public ListTestGridSessionsResult listTestGridSessions(ListTestGridSessionsRequest request)
Retrieves a list of sessions for a TestGridProject.
listTestGridSessions in interface AWSDeviceFarmlistTestGridSessionsRequest - 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.public ListTestsResult listTests(ListTestsRequest request)
Gets information about tests in a given test suite.
listTests in interface AWSDeviceFarmlistTestsRequest - 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);public ListUniqueProblemsResult listUniqueProblems(ListUniqueProblemsRequest request)
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.
listUniqueProblems in interface AWSDeviceFarmlistUniqueProblemsRequest - 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);public ListUploadsResult listUploads(ListUploadsRequest request)
Gets information about uploads, given an AWS Device Farm project ARN.
listUploads in interface AWSDeviceFarmlistUploadsRequest - 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);public ListVPCEConfigurationsResult listVPCEConfigurations(ListVPCEConfigurationsRequest request)
Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.
listVPCEConfigurations in interface AWSDeviceFarmlistVPCEConfigurationsRequest - ArgumentException - An invalid argument was specified.ServiceAccountException - There was a problem with the service account.public PurchaseOfferingResult purchaseOffering(PurchaseOfferingRequest request)
Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for
an offering, unless the renewal was overridden. The API returns a NotEligible error if the user is
not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.
purchaseOffering in interface AWSDeviceFarmpurchaseOfferingRequest - 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);public RenewOfferingResult renewOffering(RenewOfferingRequest request)
Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of
the next period. The API returns a NotEligible error if the user is not permitted to invoke the
operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.
renewOffering in interface AWSDeviceFarmrenewOfferingRequest - 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);public ScheduleRunResult scheduleRun(ScheduleRunRequest request)
Schedules a run.
scheduleRun in interface AWSDeviceFarmscheduleRunRequest - 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);public StopJobResult stopJob(StopJobRequest request)
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.
stopJob in interface AWSDeviceFarmstopJobRequest - 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.public StopRemoteAccessSessionResult stopRemoteAccessSession(StopRemoteAccessSessionRequest request)
Ends a specified remote access session.
stopRemoteAccessSession in interface AWSDeviceFarmstopRemoteAccessSessionRequest - 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.public StopRunResult stopRun(StopRunRequest request)
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.
stopRun in interface AWSDeviceFarmstopRunRequest - 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);public TagResourceResult tagResource(TagResourceRequest request)
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.
tagResource in interface AWSDeviceFarmtagResourceRequest - 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.public UntagResourceResult untagResource(UntagResourceRequest request)
Deletes the specified tags from a resource.
untagResource in interface AWSDeviceFarmuntagResourceRequest - ArgumentException - An invalid argument was specified.NotFoundException - The specified entity was not found.TagOperationException - The operation was not successful. Try again.public UpdateDeviceInstanceResult updateDeviceInstance(UpdateDeviceInstanceRequest request)
Updates information about a private device instance.
updateDeviceInstance in interface AWSDeviceFarmupdateDeviceInstanceRequest - 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.public UpdateDevicePoolResult updateDevicePool(UpdateDevicePoolRequest request)
Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all).
updateDevicePool in interface AWSDeviceFarmupdateDevicePoolRequest - 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);public UpdateInstanceProfileResult updateInstanceProfile(UpdateInstanceProfileRequest request)
Updates information about an existing private device instance profile.
updateInstanceProfile in interface AWSDeviceFarmupdateInstanceProfileRequest - 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.public UpdateNetworkProfileResult updateNetworkProfile(UpdateNetworkProfileRequest request)
Updates the network profile.
updateNetworkProfile in interface AWSDeviceFarmupdateNetworkProfileRequest - 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.public UpdateProjectResult updateProject(UpdateProjectRequest request)
Modifies the specified project name, given the project ARN and a new name.
updateProject in interface AWSDeviceFarmupdateProjectRequest - 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);public UpdateTestGridProjectResult updateTestGridProject(UpdateTestGridProjectRequest request)
Change details of a project.
updateTestGridProject in interface AWSDeviceFarmupdateTestGridProjectRequest - 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.public UpdateUploadResult updateUpload(UpdateUploadRequest request)
Updates an uploaded test spec.
updateUpload in interface AWSDeviceFarmupdateUploadRequest - 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.public UpdateVPCEConfigurationResult updateVPCEConfiguration(UpdateVPCEConfigurationRequest request)
Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.
updateVPCEConfiguration in interface AWSDeviceFarmupdateVPCEConfigurationRequest - 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.public 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 the request.
getCachedResponseMetadata in interface AWSDeviceFarmrequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AWSDeviceFarmshutdown in class AmazonWebServiceClient