public class AWSDeviceFarmClient extends AmazonWebServiceClient implements 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.
LOGGING_AWS_REQUEST_METRIC| Constructor and Description |
|---|
AWSDeviceFarmClient()
Constructs a new client to invoke service methods on AWS Device Farm.
|
AWSDeviceFarmClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on AWS Device Farm
using the specified AWS account credentials.
|
AWSDeviceFarmClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AWS Device Farm
using the specified AWS account credentials and client configuration
options.
|
AWSDeviceFarmClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on AWS Device Farm
using the specified AWS account credentials provider.
|
AWSDeviceFarmClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AWS Device Farm
using the specified AWS account credentials provider and client
configuration options.
|
AWSDeviceFarmClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on AWS Device Farm
using the specified AWS account credentials provider, client
configuration options, and request metric collector.
|
AWSDeviceFarmClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AWS Device Farm.
|
| 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.
|
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.
|
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.
|
ScheduleRunResult |
scheduleRun(ScheduleRunRequest scheduleRunRequest)
Schedules a 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.
|
addRequestHandler, addRequestHandler, configureRegion, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdownpublic AWSDeviceFarmClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChainpublic AWSDeviceFarmClient(ClientConfiguration 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.).DefaultAWSCredentialsProviderChainpublic AWSDeviceFarmClient(AWSCredentials awsCredentials)
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.public AWSDeviceFarmClient(AWSCredentials awsCredentials, ClientConfiguration 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.).public AWSDeviceFarmClient(AWSCredentialsProvider 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.public AWSDeviceFarmClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration 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.).public AWSDeviceFarmClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector 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 CreateDevicePoolResult createDevicePool(CreateDevicePoolRequest createDevicePoolRequest)
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.public CreateProjectResult createProject(CreateProjectRequest createProjectRequest)
Creates a new 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.public CreateUploadResult createUpload(CreateUploadRequest createUploadRequest)
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.public DeleteDevicePoolResult deleteDevicePool(DeleteDevicePoolRequest deleteDevicePoolRequest)
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.public 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.
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.public DeleteRunResult deleteRun(DeleteRunRequest deleteRunRequest)
Deletes the run, given the run ARN.
Note 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.public DeleteUploadResult deleteUpload(DeleteUploadRequest deleteUploadRequest)
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.public GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)
Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account.
getAccountSettings in interface AWSDeviceFarmgetAccountSettingsRequest - 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 GetDeviceResult getDevice(GetDeviceRequest getDeviceRequest)
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.public GetDevicePoolResult getDevicePool(GetDevicePoolRequest getDevicePoolRequest)
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.public GetDevicePoolCompatibilityResult getDevicePoolCompatibility(GetDevicePoolCompatibilityRequest getDevicePoolCompatibilityRequest)
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.public GetJobResult getJob(GetJobRequest getJobRequest)
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.public GetProjectResult getProject(GetProjectRequest getProjectRequest)
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.public GetRunResult getRun(GetRunRequest getRunRequest)
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.public GetSuiteResult getSuite(GetSuiteRequest getSuiteRequest)
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.public GetTestResult getTest(GetTestRequest getTestRequest)
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.public GetUploadResult getUpload(GetUploadRequest getUploadRequest)
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.public ListArtifactsResult listArtifacts(ListArtifactsRequest listArtifactsRequest)
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.public ListDevicePoolsResult listDevicePools(ListDevicePoolsRequest listDevicePoolsRequest)
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.public ListDevicesResult listDevices(ListDevicesRequest listDevicesRequest)
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.public ListJobsResult listJobs(ListJobsRequest listJobsRequest)
Gets information about jobs.
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.public ListProjectsResult listProjects(ListProjectsRequest listProjectsRequest)
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.public ListRunsResult listRuns(ListRunsRequest listRunsRequest)
Gets information about runs.
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.public ListSamplesResult listSamples(ListSamplesRequest listSamplesRequest)
Gets information about samples.
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.public ListSuitesResult listSuites(ListSuitesRequest listSuitesRequest)
Gets information about suites.
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.public ListTestsResult listTests(ListTestsRequest listTestsRequest)
Gets information about tests.
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.public ListUniqueProblemsResult listUniqueProblems(ListUniqueProblemsRequest listUniqueProblemsRequest)
Gets information about unique problems.
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.public ListUploadsResult listUploads(ListUploadsRequest listUploadsRequest)
Gets information about uploads.
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.public ScheduleRunResult scheduleRun(ScheduleRunRequest scheduleRunRequest)
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.public 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).
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.public UpdateProjectResult updateProject(UpdateProjectRequest updateProjectRequest)
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.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 requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.