public interface AWSDeviceFarm
AWS Device Farm is a service that enables mobile app developers to test Android, iOS, and Fire OS apps on physical phones, tablets, and other devices in the cloud.
Modifier and Type | Method and Description |
---|---|
CreateDevicePoolResult |
createDevicePool(CreateDevicePoolRequest createDevicePoolRequest)
Creates a device pool.
|
CreateProjectResult |
createProject(CreateProjectRequest createProjectRequest)
Creates a new project.
|
CreateUploadResult |
createUpload(CreateUploadRequest createUploadRequest)
Uploads an app or test scripts.
|
DeleteDevicePoolResult |
deleteDevicePool(DeleteDevicePoolRequest deleteDevicePoolRequest)
Deletes a device pool given the pool ARN.
|
DeleteProjectResult |
deleteProject(DeleteProjectRequest deleteProjectRequest)
Deletes an AWS Device Farm project, given the project ARN.
|
DeleteRunResult |
deleteRun(DeleteRunRequest deleteRunRequest)
Deletes the run, given the run ARN.
|
DeleteUploadResult |
deleteUpload(DeleteUploadRequest deleteUploadRequest)
Deletes an upload given the upload ARN.
|
GetAccountSettingsResult |
getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)
Returns the number of unmetered iOS and/or unmetered Android devices that
have been purchased by the account.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request,
typically used for debugging issues where a service isn't acting as
expected.
|
GetDeviceResult |
getDevice(GetDeviceRequest getDeviceRequest)
Gets information about a unique device type.
|
GetDevicePoolResult |
getDevicePool(GetDevicePoolRequest getDevicePoolRequest)
Gets information about a device pool.
|
GetDevicePoolCompatibilityResult |
getDevicePoolCompatibility(GetDevicePoolCompatibilityRequest getDevicePoolCompatibilityRequest)
Gets information about compatibility with a device pool.
|
GetJobResult |
getJob(GetJobRequest getJobRequest)
Gets information about a job.
|
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.
|
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.
|
GetUploadResult |
getUpload(GetUploadRequest getUploadRequest)
Gets information about an upload.
|
ListArtifactsResult |
listArtifacts(ListArtifactsRequest listArtifactsRequest)
Gets information about artifacts.
|
ListDevicePoolsResult |
listDevicePools(ListDevicePoolsRequest listDevicePoolsRequest)
Gets information about device pools.
|
ListDevicesResult |
listDevices(ListDevicesRequest listDevicesRequest)
Gets information about unique device types.
|
ListJobsResult |
listJobs(ListJobsRequest listJobsRequest)
Gets information about jobs.
|
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.
|
ListRunsResult |
listRuns(ListRunsRequest listRunsRequest)
Gets information about runs.
|
ListSamplesResult |
listSamples(ListSamplesRequest listSamplesRequest)
Gets information about samples.
|
ListSuitesResult |
listSuites(ListSuitesRequest listSuitesRequest)
Gets information about suites.
|
ListTestsResult |
listTests(ListTestsRequest listTestsRequest)
Gets information about tests.
|
ListUniqueProblemsResult |
listUniqueProblems(ListUniqueProblemsRequest listUniqueProblemsRequest)
Gets information about unique problems.
|
ListUploadsResult |
listUploads(ListUploadsRequest listUploadsRequest)
Gets information about uploads.
|
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)
Overrides the default endpoint for this client
("https://devicefarm.us-west-2.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
setEndpoint(String) , sets the
regional endpoint for this client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StopRunResult |
stopRun(StopRunRequest stopRunRequest)
Initiates a stop request for the current test run.
|
UpdateDevicePoolResult |
updateDevicePool(UpdateDevicePoolRequest updateDevicePoolRequest)
Modifies the name, description, and rules in a device pool given the
attributes and the pool ARN.
|
UpdateProjectResult |
updateProject(UpdateProjectRequest updateProjectRequest)
Modifies the specified project name, given the project ARN and a new
name.
|
void setEndpoint(String endpoint)
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: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
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.void setRegion(Region region)
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.CreateProjectResult createProject(CreateProjectRequest createProjectRequest)
Creates a new 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.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.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.DeleteProjectResult deleteProject(DeleteProjectRequest deleteProjectRequest)
Deletes an AWS Device Farm project, given the project ARN.
Note 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.DeleteRunResult deleteRun(DeleteRunRequest deleteRunRequest)
Deletes the run, given the run ARN.
Note 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.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.GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)
Returns the number of unmetered iOS and/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.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.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.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.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.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. Please contact aws-devicefarm-support@amazon.com if you believe that you should be
able to invoke this operation.
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.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.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.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.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.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.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.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.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.ListJobsResult listJobs(ListJobsRequest listJobsRequest)
Gets information about jobs.
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.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. Please contact aws-devicefarm-support@amazon.com if you believe that you should be
able to invoke this operation.
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.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. Please contact aws-devicefarm-support@amazon.com if you believe that you should be
able to invoke this operation.
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.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.ListRunsResult listRuns(ListRunsRequest listRunsRequest)
Gets information about runs.
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.ListSamplesResult listSamples(ListSamplesRequest listSamplesRequest)
Gets information about samples.
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.ListSuitesResult listSuites(ListSuitesRequest listSuitesRequest)
Gets information about suites.
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.ListTestsResult listTests(ListTestsRequest listTestsRequest)
Gets information about tests.
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.ListUniqueProblemsResult listUniqueProblems(ListUniqueProblemsRequest listUniqueProblemsRequest)
Gets information about unique problems.
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.ListUploadsResult listUploads(ListUploadsRequest listUploadsRequest)
Gets information about uploads.
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.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. Please contact aws-devicefarm-support@amazon.com if you believe that you should be
able to invoke this operation.
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.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. Please contact aws-devicefarm-support@amazon.com if you believe that you should be
able to invoke this operation.
renewOfferingRequest
- A request representing 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.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.StopRunResult stopRun(StopRunRequest stopRunRequest)
Initiates a stop request for the current test run. AWS Device Farm will immediately stop the run on devices where tests have not started executing, and you will not be billed for these devices. On devices where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on those devices. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.
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.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.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.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.Copyright © 2018. All rights reserved.