AWSDeviceFarm (AWS SDK for Java

All Known Subinterfaces:

AWSDeviceFarmAsync

All Known Implementing Classes:

AbstractAWSDeviceFarm, AbstractAWSDeviceFarmAsync, AWSDeviceFarmAsyncClient, AWSDeviceFarmClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSDeviceFarm
```
Interface for accessing AWS Device Farm.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSDeviceFarm instead.

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.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`CreateDevicePoolResult`	`createDevicePool(CreateDevicePoolRequest createDevicePoolRequest)` Creates a device pool.
`CreateNetworkProfileResult`	`createNetworkProfile(CreateNetworkProfileRequest createNetworkProfileRequest)` Creates a network profile.
`CreateProjectResult`	`createProject(CreateProjectRequest createProjectRequest)` Creates a new project.
`CreateRemoteAccessSessionResult`	`createRemoteAccessSession(CreateRemoteAccessSessionRequest createRemoteAccessSessionRequest)` Specifies and starts a remote access session.
`CreateUploadResult`	`createUpload(CreateUploadRequest createUploadRequest)` Uploads an app or test scripts.
`DeleteDevicePoolResult`	`deleteDevicePool(DeleteDevicePoolRequest deleteDevicePoolRequest)` Deletes a device pool given the pool ARN.
`DeleteNetworkProfileResult`	`deleteNetworkProfile(DeleteNetworkProfileRequest deleteNetworkProfileRequest)` Deletes a network profile.
`DeleteProjectResult`	`deleteProject(DeleteProjectRequest deleteProjectRequest)` Deletes an AWS Device Farm project, given the project ARN.
`DeleteRemoteAccessSessionResult`	`deleteRemoteAccessSession(DeleteRemoteAccessSessionRequest deleteRemoteAccessSessionRequest)` Deletes a completed remote access session and its results.
`DeleteRunResult`	`deleteRun(DeleteRunRequest deleteRunRequest)` Deletes the run, given the run ARN.
`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.
`GetNetworkProfileResult`	`getNetworkProfile(GetNetworkProfileRequest getNetworkProfileRequest)` Returns information about a network profile.
`GetOfferingStatusResult`	`getOfferingStatus(GetOfferingStatusRequest getOfferingStatusRequest)` Gets the current status and future status of all offerings purchased by an AWS account.
`GetProjectResult`	`getProject(GetProjectRequest getProjectRequest)` Gets information about a project.
`GetRemoteAccessSessionResult`	`getRemoteAccessSession(GetRemoteAccessSessionRequest getRemoteAccessSessionRequest)` Returns a link to a currently running remote access session.
`GetRunResult`	`getRun(GetRunRequest getRunRequest)` Gets information about a run.
`GetSuiteResult`	`getSuite(GetSuiteRequest getSuiteRequest)` Gets information about a suite.
`GetTestResult`	`getTest(GetTestRequest getTestRequest)` Gets information about a test.
`GetUploadResult`	`getUpload(GetUploadRequest getUploadRequest)` Gets information about an upload.
`InstallToRemoteAccessSessionResult`	`installToRemoteAccessSession(InstallToRemoteAccessSessionRequest installToRemoteAccessSessionRequest)` Installs an application to the device in a remote access session.
`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 for a given test run.
`ListNetworkProfilesResult`	`listNetworkProfiles(ListNetworkProfilesRequest listNetworkProfilesRequest)` Returns the list of available network profiles.
`ListOfferingPromotionsResult`	`listOfferingPromotions(ListOfferingPromotionsRequest listOfferingPromotionsRequest)` Returns a list of offering promotions.
`ListOfferingsResult`	`listOfferings(ListOfferingsRequest listOfferingsRequest)` Returns a list of products or offerings that the user can manage through the API.
`ListOfferingTransactionsResult`	`listOfferingTransactions(ListOfferingTransactionsRequest listOfferingTransactionsRequest)` Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account.
`ListProjectsResult`	`listProjects(ListProjectsRequest listProjectsRequest)` Gets information about projects.
`ListRemoteAccessSessionsResult`	`listRemoteAccessSessions(ListRemoteAccessSessionsRequest listRemoteAccessSessionsRequest)` Returns a list of all currently running remote access sessions.
`ListRunsResult`	`listRuns(ListRunsRequest listRunsRequest)` Gets information about runs, given an AWS Device Farm project ARN.
`ListSamplesResult`	`listSamples(ListSamplesRequest listSamplesRequest)` Gets information about samples, given an AWS Device Farm project ARN
`ListSuitesResult`	`listSuites(ListSuitesRequest listSuitesRequest)` Gets information about test suites for a given job.
`ListTestsResult`	`listTests(ListTestsRequest listTestsRequest)` Gets information about tests in a given test suite.
`ListUniqueProblemsResult`	`listUniqueProblems(ListUniqueProblemsRequest listUniqueProblemsRequest)` Gets information about unique problems.
`ListUploadsResult`	`listUploads(ListUploadsRequest listUploadsRequest)` Gets information about uploads, given an AWS Device Farm project ARN.
`PurchaseOfferingResult`	`purchaseOffering(PurchaseOfferingRequest purchaseOfferingRequest)` Immediately purchases offerings for an AWS account.
`RenewOfferingResult`	`renewOffering(RenewOfferingRequest renewOfferingRequest)` Explicitly sets the quantity of devices to renew for an offering, starting from the `effectiveDate` of the next period.
`ScheduleRunResult`	`scheduleRun(ScheduleRunRequest scheduleRunRequest)` Schedules a run.
`void`	`setEndpoint(String endpoint)` Deprecated. use `AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)` for example: `builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));`
`void`	`setRegion(Region region)` Deprecated. use `AwsClientBuilder#setRegion(String)`
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StopRemoteAccessSessionResult`	`stopRemoteAccessSession(StopRemoteAccessSessionRequest stopRemoteAccessSessionRequest)` Ends a specified remote access session.
`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.
`UpdateNetworkProfileResult`	`updateNetworkProfile(UpdateNetworkProfileRequest updateNetworkProfileRequest)` Updates the network profile with specific settings.
`UpdateProjectResult`	`updateProject(UpdateProjectRequest updateProjectRequest)` Modifies the specified project name, given the project ARN and a new name.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - setEndpoint
```
@Deprecated
void setEndpoint(String endpoint)
```
    Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
    
    Overrides the default endpoint for this client ("https://devicefarm.us-west-2.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    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.
    
    Parameters:
    
    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.
  - setRegion
```
@Deprecated
void setRegion(Region region)
```
    Deprecated. use AwsClientBuilder#setRegion(String)
    
    An alternative to 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - createDevicePool
```
CreateDevicePoolResult createDevicePool(CreateDevicePoolRequest createDevicePoolRequest)
```
    Creates a device pool.
    Parameters:
    
    createDevicePoolRequest - Represents a request to the create device pool operation.
    
    Returns:
    
    Result of the CreateDevicePool operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To create a new device pool
      The following example creates a new device pool named MyDevicePool inside an existing project.
      
      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);
  - createNetworkProfile
```
CreateNetworkProfileResult createNetworkProfile(CreateNetworkProfileRequest createNetworkProfileRequest)
```
    Creates a network profile.
    
    Parameters:
    
    createNetworkProfileRequest -
    
    Returns:
    
    Result of the CreateNetworkProfile operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createProject
```
CreateProjectResult createProject(CreateProjectRequest createProjectRequest)
```
    Creates a new project.
    Parameters:
    
    createProjectRequest - Represents a request to the create project operation.
    
    Returns:
    
    Result of the CreateProject operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To create a new project
      The following example creates a new project named MyProject.
      
      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);
  - createRemoteAccessSession
```
CreateRemoteAccessSessionResult createRemoteAccessSession(CreateRemoteAccessSessionRequest createRemoteAccessSessionRequest)
```
    Specifies and starts a remote access session.
    Parameters:
    
    createRemoteAccessSessionRequest - Creates and submits a request to start a remote access session.
    
    Returns:
    
    Result of the CreateRemoteAccessSession operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To create a remote access session
      The following example creates a remote access session named MySession.
      
      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);
  - createUpload
```
CreateUploadResult createUpload(CreateUploadRequest createUploadRequest)
```
    Uploads an app or test scripts.
    Parameters:
    
    createUploadRequest - Represents a request to the create upload operation.
    
    Returns:
    
    Result of the CreateUpload operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To create a new test package upload
      The following example creates a new Appium Python test package upload inside an existing project.
      
      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);
  - deleteDevicePool
```
DeleteDevicePoolResult deleteDevicePool(DeleteDevicePoolRequest deleteDevicePoolRequest)
```
    Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.
    Parameters:
    
    deleteDevicePoolRequest - Represents a request to the delete device pool operation.
    
    Returns:
    
    Result of the DeleteDevicePool operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To delete a device pool
      The following example deletes a specific device pool.
      
      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);
  - deleteNetworkProfile
```
DeleteNetworkProfileResult deleteNetworkProfile(DeleteNetworkProfileRequest deleteNetworkProfileRequest)
```
    Deletes a network profile.
    
    Parameters:
    
    deleteNetworkProfileRequest -
    
    Returns:
    
    Result of the DeleteNetworkProfile operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteProject
```
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.
    Parameters:
    
    deleteProjectRequest - Represents a request to the delete project operation.
    
    Returns:
    
    Result of the DeleteProject operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To delete a project
      The following example deletes a specific project.
      
      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);
  - deleteRemoteAccessSession
```
DeleteRemoteAccessSessionResult deleteRemoteAccessSession(DeleteRemoteAccessSessionRequest deleteRemoteAccessSessionRequest)
```
    Deletes a completed remote access session and its results.
    Parameters:
    
    deleteRemoteAccessSessionRequest - Represents the request to delete the specified remote access session.
    
    Returns:
    
    Result of the DeleteRemoteAccessSession operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To delete a specific remote access session
      The following example deletes a specific remote access session.
      
      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);
  - deleteRun
```
DeleteRunResult deleteRun(DeleteRunRequest deleteRunRequest)
```
    Deletes the run, given the run ARN.
    
    Note Deleting this resource does not stop an in-progress run.
    Parameters:
    
    deleteRunRequest - Represents a request to the delete run operation.
    
    Returns:
    
    Result of the DeleteRun operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To delete a run
      The following example deletes a specific test run.
      
      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);
  - deleteUpload
```
DeleteUploadResult deleteUpload(DeleteUploadRequest deleteUploadRequest)
```
    Deletes an upload given the upload ARN.
    Parameters:
    
    deleteUploadRequest - Represents a request to the delete upload operation.
    
    Returns:
    
    Result of the DeleteUpload operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To delete a specific upload
      The following example deletes a specific upload.
      
      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);
  - getAccountSettings
```
GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)
```
    Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account.
    Parameters:
    
    getAccountSettingsRequest - Represents the request sent to retrieve the account settings.
    
    Returns:
    
    Result of the GetAccountSettings operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To get information about account settings
      The following example returns information about your Device Farm account settings.
      
      AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build(); GetAccountSettingsRequest request = new GetAccountSettingsRequest(); GetAccountSettingsResult response = client.getAccountSettings(request);
  - getDevice
```
GetDeviceResult getDevice(GetDeviceRequest getDeviceRequest)
```
    Gets information about a unique device type.
    Parameters:
    
    getDeviceRequest - Represents a request to the get device request.
    
    Returns:
    
    Result of the GetDevice operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To get information about a device
      The following example returns information about a specific device.
      
      AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build(); GetDeviceRequest request = new GetDeviceRequest().withArn("arn:aws:devicefarm:us-west-2::device:123EXAMPLE"); GetDeviceResult response = client.getDevice(request);
  - getDevicePool
```
GetDevicePoolResult getDevicePool(GetDevicePoolRequest getDevicePoolRequest)
```
    Gets information about a device pool.
    Parameters:
    
    getDevicePoolRequest - Represents a request to the get device pool operation.
    
    Returns:
    
    Result of the GetDevicePool operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To get information about a device pool
      The following example returns information about a specific device pool, given a project ARN.
      
      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);
  - getDevicePoolCompatibility
```
GetDevicePoolCompatibilityResult getDevicePoolCompatibility(GetDevicePoolCompatibilityRequest getDevicePoolCompatibilityRequest)
```
    Gets information about compatibility with a device pool.
    Parameters:
    
    getDevicePoolCompatibilityRequest - Represents a request to the get device pool compatibility operation.
    
    Returns:
    
    Result of the GetDevicePoolCompatibility operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To get information about the compatibility of a device pool
      The following example returns information about the compatibility of a specific device pool, given its ARN.
      
      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);
  - getJob
```
GetJobResult getJob(GetJobRequest getJobRequest)
```
    Gets information about a job.
    Parameters:
    
    getJobRequest - Represents a request to the get job operation.
    
    Returns:
    
    Result of the GetJob operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To get information about a job
      The following example returns information about a specific job.
      
      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);
  - getNetworkProfile
```
GetNetworkProfileResult getNetworkProfile(GetNetworkProfileRequest getNetworkProfileRequest)
```
    Returns information about a network profile.
    
    Parameters:
    
    getNetworkProfileRequest -
    
    Returns:
    
    Result of the GetNetworkProfile operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getOfferingStatus
```
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 [email protected] if you believe that you should be able to invoke this operation.
    Parameters:
    
    getOfferingStatusRequest - Represents the request to retrieve the offering status for the specified customer or account.
    
    Returns:
    
    Result of the GetOfferingStatus operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To get status information about device offerings
      The following example returns information about Device Farm offerings available to your 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);
  - getProject
```
GetProjectResult getProject(GetProjectRequest getProjectRequest)
```
    Gets information about a project.
    Parameters:
    
    getProjectRequest - Represents a request to the get project operation.
    
    Returns:
    
    Result of the GetProject operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To get information about a project
      The following example gets information about a specific project.
      
      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);
  - getRemoteAccessSession
```
GetRemoteAccessSessionResult getRemoteAccessSession(GetRemoteAccessSessionRequest getRemoteAccessSessionRequest)
```
    Returns a link to a currently running remote access session.
    Parameters:
    
    getRemoteAccessSessionRequest - Represents the request to get information about the specified remote access session.
    
    Returns:
    
    Result of the GetRemoteAccessSession operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To get a remote access session
      The following example gets a specific remote access session.
      
      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);
  - getRun
```
GetRunResult getRun(GetRunRequest getRunRequest)
```
    Gets information about a run.
    Parameters:
    
    getRunRequest - Represents a request to the get run operation.
    
    Returns:
    
    Result of the GetRun operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To get information about a test run
      The following example gets information about a specific test run.
      
      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);
  - getSuite
```
GetSuiteResult getSuite(GetSuiteRequest getSuiteRequest)
```
    Gets information about a suite.
    Parameters:
    
    getSuiteRequest - Represents a request to the get suite operation.
    
    Returns:
    
    Result of the GetSuite operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To get information about a test suite
      The following example gets information about a specific test suite.
      
      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);
  - getTest
```
GetTestResult getTest(GetTestRequest getTestRequest)
```
    Gets information about a test.
    Parameters:
    
    getTestRequest - Represents a request to the get test operation.
    
    Returns:
    
    Result of the GetTest operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To get information about a specific test
      The following example gets information about a specific test.
      
      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);
  - getUpload
```
GetUploadResult getUpload(GetUploadRequest getUploadRequest)
```
    Gets information about an upload.
    Parameters:
    
    getUploadRequest - Represents a request to the get upload operation.
    
    Returns:
    
    Result of the GetUpload operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To get information about a specific upload
      The following example gets information about a specific upload.
      
      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);
  - installToRemoteAccessSession
```
InstallToRemoteAccessSessionResult installToRemoteAccessSession(InstallToRemoteAccessSessionRequest installToRemoteAccessSessionRequest)
```
    Installs an application to the device in a remote access session. For Android applications, the file must be in .apk format. For iOS applications, the file must be in .ipa format.
    Parameters:
    
    installToRemoteAccessSessionRequest - Represents the request to install an Android application (in .apk format) or an iOS application (in .ipa format) as part of a remote access session.
    
    Returns:
    
    Result of the InstallToRemoteAccessSession operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To install to a remote access session
      The following example installs a specific app to a device in a specific remote access session.
      
      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);
  - listArtifacts
```
ListArtifactsResult listArtifacts(ListArtifactsRequest listArtifactsRequest)
```
    Gets information about artifacts.
    Parameters:
    
    listArtifactsRequest - Represents a request to the list artifacts operation.
    
    Returns:
    
    Result of the ListArtifacts operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To list artifacts for a resource
      The following example lists screenshot artifacts for a specific run.
      
      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);
  - listDevicePools
```
ListDevicePoolsResult listDevicePools(ListDevicePoolsRequest listDevicePoolsRequest)
```
    Gets information about device pools.
    Parameters:
    
    listDevicePoolsRequest - Represents the result of a list device pools request.
    
    Returns:
    
    Result of the ListDevicePools operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To get information about device pools
      The following example returns information about the private device pools in a specific project.
      
      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);
  - listDevices
```
ListDevicesResult listDevices(ListDevicesRequest listDevicesRequest)
```
    Gets information about unique device types.
    Parameters:
    
    listDevicesRequest - Represents the result of a list devices request.
    
    Returns:
    
    Result of the ListDevices operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To get information about devices
      The following example returns information about the available devices in a specific project.
      
      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);
  - listJobs
```
ListJobsResult listJobs(ListJobsRequest listJobsRequest)
```
    Gets information about jobs for a given test run.
    Parameters:
    
    listJobsRequest - Represents a request to the list jobs operation.
    
    Returns:
    
    Result of the ListJobs operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To get information about jobs
      The following example returns information about jobs in a specific project.
      
      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);
  - listNetworkProfiles
```
ListNetworkProfilesResult listNetworkProfiles(ListNetworkProfilesRequest listNetworkProfilesRequest)
```
    Returns the list of available network profiles.
    
    Parameters:
    
    listNetworkProfilesRequest -
    
    Returns:
    
    Result of the ListNetworkProfiles operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listOfferingPromotions
```
ListOfferingPromotionsResult listOfferingPromotions(ListOfferingPromotionsRequest listOfferingPromotionsRequest)
```
    Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a NotEligible error if the caller is not permitted to invoke the operation. Contact [email protected] if you believe that you should be able to invoke this operation.
    
    Parameters:
    
    listOfferingPromotionsRequest -
    
    Returns:
    
    Result of the ListOfferingPromotions operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listOfferingTransactions
```
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 [email protected] if you believe that you should be able to invoke this operation.
    Parameters:
    
    listOfferingTransactionsRequest - Represents the request to list the offering transaction history.
    
    Returns:
    
    Result of the ListOfferingTransactions operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To get information about device offering transactions
      The following example returns information about Device Farm offering transactions.
      
      AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build(); ListOfferingTransactionsRequest request = new ListOfferingTransactionsRequest() //A dynamically generated value, used for paginating results. .withNextToken("RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE="); ListOfferingTransactionsResult response = client.listOfferingTransactions(request);
  - listOfferings
```
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 [email protected] if you believe that you should be able to invoke this operation.
    Parameters:
    
    listOfferingsRequest - Represents the request to list all offerings.
    
    Returns:
    
    Result of the ListOfferings operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To get information about device offerings
      The following example returns information about available device offerings.
      
      AWSDeviceFarm client = AWSDeviceFarmClientBuilder.standard().build(); ListOfferingsRequest request = new ListOfferingsRequest() //A dynamically generated value, used for paginating results. .withNextToken("RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE="); ListOfferingsResult response = client.listOfferings(request);
  - listProjects
```
ListProjectsResult listProjects(ListProjectsRequest listProjectsRequest)
```
    Gets information about projects.
    Parameters:
    
    listProjectsRequest - Represents a request to the list projects operation.
    
    Returns:
    
    Result of the ListProjects operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To get information about a Device Farm project
      The following example returns information about the specified project in Device Farm.
      
      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);
  - listRemoteAccessSessions
```
ListRemoteAccessSessionsResult listRemoteAccessSessions(ListRemoteAccessSessionsRequest listRemoteAccessSessionsRequest)
```
    Returns a list of all currently running remote access sessions.
    Parameters:
    
    listRemoteAccessSessionsRequest - Represents the request to return information about the remote access session.
    
    Returns:
    
    Result of the ListRemoteAccessSessions operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To get information about a remote access session
      The following example returns information about a specific Device Farm remote access session.
      
      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);
  - listRuns
```
ListRunsResult listRuns(ListRunsRequest listRunsRequest)
```
    Gets information about runs, given an AWS Device Farm project ARN.
    Parameters:
    
    listRunsRequest - Represents a request to the list runs operation.
    
    Returns:
    
    Result of the ListRuns operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To get information about a test run
      The following example returns information about a specific test run.
      
      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);
  - listSamples
```
ListSamplesResult listSamples(ListSamplesRequest listSamplesRequest)
```
    Gets information about samples, given an AWS Device Farm project ARN
    Parameters:
    
    listSamplesRequest - Represents a request to the list samples operation.
    
    Returns:
    
    Result of the ListSamples operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To get information about samples
      The following example returns information about samples, given a specific Device Farm project.
      
      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);
  - listSuites
```
ListSuitesResult listSuites(ListSuitesRequest listSuitesRequest)
```
    Gets information about test suites for a given job.
    Parameters:
    
    listSuitesRequest - Represents a request to the list suites operation.
    
    Returns:
    
    Result of the ListSuites operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To get information about suites
      The following example returns information about suites, given a specific Device Farm project.
      
      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);
  - listTests
```
ListTestsResult listTests(ListTestsRequest listTestsRequest)
```
    Gets information about tests in a given test suite.
    Parameters:
    
    listTestsRequest - Represents a request to the list tests operation.
    
    Returns:
    
    Result of the ListTests operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To get information about tests
      The following example returns information about tests, given a specific Device Farm project.
      
      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);
  - listUniqueProblems
```
ListUniqueProblemsResult listUniqueProblems(ListUniqueProblemsRequest listUniqueProblemsRequest)
```
    Gets information about unique problems.
    Parameters:
    
    listUniqueProblemsRequest - Represents a request to the list unique problems operation.
    
    Returns:
    
    Result of the ListUniqueProblems operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To get information about unique problems
      The following example returns information about unique problems, given a specific Device Farm project.
      
      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);
  - listUploads
```
ListUploadsResult listUploads(ListUploadsRequest listUploadsRequest)
```
    Gets information about uploads, given an AWS Device Farm project ARN.
    Parameters:
    
    listUploadsRequest - Represents a request to the list uploads operation.
    
    Returns:
    
    Result of the ListUploads operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To get information about uploads
      The following example returns information about uploads, given a specific Device Farm project.
      
      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);
  - purchaseOffering
```
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 [email protected] if you believe that you should be able to invoke this operation.
    Parameters:
    
    purchaseOfferingRequest - Represents a request for a purchase offering.
    
    Returns:
    
    Result of the PurchaseOffering operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To purchase a device slot offering
      The following example purchases a specific device slot offering.
      
      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);
  - renewOffering
```
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 [email protected] if you believe that you should be able to invoke this operation.
    Parameters:
    
    renewOfferingRequest - A request representing an offering renewal.
    
    Returns:
    
    Result of the RenewOffering operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To renew a device slot offering
      The following example renews a specific device slot offering.
      
      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);
  - scheduleRun
```
ScheduleRunResult scheduleRun(ScheduleRunRequest scheduleRunRequest)
```
    Schedules a run.
    Parameters:
    
    scheduleRunRequest - Represents a request to the schedule run operation.
    
    Returns:
    
    Result of the ScheduleRun operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To schedule a test run
      The following example schedules a test run named MyRun.
      
      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);
  - stopRemoteAccessSession
```
StopRemoteAccessSessionResult stopRemoteAccessSession(StopRemoteAccessSessionRequest stopRemoteAccessSessionRequest)
```
    Ends a specified remote access session.
    
    Parameters:
    
    stopRemoteAccessSessionRequest - Represents the request to stop the remote access session.
    
    Returns:
    
    Result of the StopRemoteAccessSession operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - stopRun
```
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.
    Parameters:
    
    stopRunRequest - Represents the request to stop a specific run.
    
    Returns:
    
    Result of the StopRun operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To stop a test run
      The following example stops a specific test run.
      
      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);
  - updateDevicePool
```
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).
    Parameters:
    
    updateDevicePoolRequest - Represents a request to the update device pool operation.
    
    Returns:
    
    Result of the UpdateDevicePool operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To update a device pool
      The following example updates the specified device pool with a new name and description. It also enables remote access of devices in the device pool.
      
      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);
  - updateNetworkProfile
```
UpdateNetworkProfileResult updateNetworkProfile(UpdateNetworkProfileRequest updateNetworkProfileRequest)
```
    Updates the network profile with specific settings.
    
    Parameters:
    
    updateNetworkProfileRequest -
    
    Returns:
    
    Result of the UpdateNetworkProfile operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateProject
```
UpdateProjectResult updateProject(UpdateProjectRequest updateProjectRequest)
```
    Modifies the specified project name, given the project ARN and a new name.
    Parameters:
    
    updateProjectRequest - Represents a request to the update project operation.
    
    Returns:
    
    Result of the UpdateProject operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To update a device pool
      The following example updates the specified project with a new name.
      
      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);
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    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.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AWSDeviceFarm

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

setEndpoint

setRegion

createDevicePool

To create a new device pool

createNetworkProfile

createProject

To create a new project

createRemoteAccessSession

To create a remote access session

createUpload

To create a new test package upload

deleteDevicePool

To delete a device pool

deleteNetworkProfile

deleteProject

To delete a project

deleteRemoteAccessSession

To delete a specific remote access session

deleteRun

To delete a run

deleteUpload

To delete a specific upload

getAccountSettings

To get information about account settings

getDevice

To get information about a device

getDevicePool

To get information about a device pool

getDevicePoolCompatibility

To get information about the compatibility of a device pool

getJob

To get information about a job

getNetworkProfile

getOfferingStatus

To get status information about device offerings

getProject

To get information about a project

getRemoteAccessSession

To get a remote access session

getRun

To get information about a test run

getSuite

To get information about a test suite

getTest

To get information about a specific test

getUpload

To get information about a specific upload

installToRemoteAccessSession

To install to a remote access session

listArtifacts

To list artifacts for a resource

listDevicePools

To get information about device pools

listDevices

To get information about devices

listJobs

To get information about jobs

listNetworkProfiles

listOfferingPromotions

listOfferingTransactions

To get information about device offering transactions

listOfferings

To get information about device offerings

listProjects

To get information about a Device Farm project

listRemoteAccessSessions

To get information about a remote access session

listRuns

To get information about a test run

listSamples

To get information about samples

listSuites

To get information about suites