AbstractAWSDeviceFarm (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.devicefarm.AbstractAWSDeviceFarm

All Implemented Interfaces:

AWSDeviceFarm

Direct Known Subclasses:

AbstractAWSDeviceFarmAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSDeviceFarm
extends Object
implements AWSDeviceFarm
```
Abstract implementation of AWSDeviceFarm. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.devicefarm.AWSDeviceFarm
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateDevicePoolResult`	`createDevicePool(CreateDevicePoolRequest request)` Creates a device pool.
`CreateNetworkProfileResult`	`createNetworkProfile(CreateNetworkProfileRequest request)` Creates a network profile.
`CreateProjectResult`	`createProject(CreateProjectRequest request)` Creates a new project.
`CreateRemoteAccessSessionResult`	`createRemoteAccessSession(CreateRemoteAccessSessionRequest request)` Specifies and starts a remote access session.
`CreateUploadResult`	`createUpload(CreateUploadRequest request)` Uploads an app or test scripts.
`DeleteDevicePoolResult`	`deleteDevicePool(DeleteDevicePoolRequest request)` Deletes a device pool given the pool ARN.
`DeleteNetworkProfileResult`	`deleteNetworkProfile(DeleteNetworkProfileRequest request)` Deletes a network profile.
`DeleteProjectResult`	`deleteProject(DeleteProjectRequest request)` Deletes an AWS Device Farm project, given the project ARN.
`DeleteRemoteAccessSessionResult`	`deleteRemoteAccessSession(DeleteRemoteAccessSessionRequest request)` Deletes a completed remote access session and its results.
`DeleteRunResult`	`deleteRun(DeleteRunRequest request)` Deletes the run, given the run ARN.
`DeleteUploadResult`	`deleteUpload(DeleteUploadRequest request)` Deletes an upload given the upload ARN.
`GetAccountSettingsResult`	`getAccountSettings(GetAccountSettingsRequest request)` 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 request)` Gets information about a unique device type.
`GetDevicePoolResult`	`getDevicePool(GetDevicePoolRequest request)` Gets information about a device pool.
`GetDevicePoolCompatibilityResult`	`getDevicePoolCompatibility(GetDevicePoolCompatibilityRequest request)` Gets information about compatibility with a device pool.
`GetJobResult`	`getJob(GetJobRequest request)` Gets information about a job.
`GetNetworkProfileResult`	`getNetworkProfile(GetNetworkProfileRequest request)` Returns information about a network profile.
`GetOfferingStatusResult`	`getOfferingStatus(GetOfferingStatusRequest request)` Gets the current status and future status of all offerings purchased by an AWS account.
`GetProjectResult`	`getProject(GetProjectRequest request)` Gets information about a project.
`GetRemoteAccessSessionResult`	`getRemoteAccessSession(GetRemoteAccessSessionRequest request)` Returns a link to a currently running remote access session.
`GetRunResult`	`getRun(GetRunRequest request)` Gets information about a run.
`GetSuiteResult`	`getSuite(GetSuiteRequest request)` Gets information about a suite.
`GetTestResult`	`getTest(GetTestRequest request)` Gets information about a test.
`GetUploadResult`	`getUpload(GetUploadRequest request)` Gets information about an upload.
`InstallToRemoteAccessSessionResult`	`installToRemoteAccessSession(InstallToRemoteAccessSessionRequest request)` Installs an application to the device in a remote access session.
`ListArtifactsResult`	`listArtifacts(ListArtifactsRequest request)` Gets information about artifacts.
`ListDevicePoolsResult`	`listDevicePools(ListDevicePoolsRequest request)` Gets information about device pools.
`ListDevicesResult`	`listDevices(ListDevicesRequest request)` Gets information about unique device types.
`ListJobsResult`	`listJobs(ListJobsRequest request)` Gets information about jobs.
`ListNetworkProfilesResult`	`listNetworkProfiles(ListNetworkProfilesRequest request)` Returns the list of available network profiles.
`ListOfferingPromotionsResult`	`listOfferingPromotions(ListOfferingPromotionsRequest request)` Returns a list of offering promotions.
`ListOfferingsResult`	`listOfferings(ListOfferingsRequest request)` Returns a list of products or offerings that the user can manage through the API.
`ListOfferingTransactionsResult`	`listOfferingTransactions(ListOfferingTransactionsRequest request)` Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account.
`ListProjectsResult`	`listProjects(ListProjectsRequest request)` Gets information about projects.
`ListRemoteAccessSessionsResult`	`listRemoteAccessSessions(ListRemoteAccessSessionsRequest request)` Returns a list of all currently running remote access sessions.
`ListRunsResult`	`listRuns(ListRunsRequest request)` Gets information about runs, given an AWS Device Farm project ARN.
`ListSamplesResult`	`listSamples(ListSamplesRequest request)` Gets information about samples, given an AWS Device Farm project ARN
`ListSuitesResult`	`listSuites(ListSuitesRequest request)` Gets information about suites.
`ListTestsResult`	`listTests(ListTestsRequest request)` Gets information about tests.
`ListUniqueProblemsResult`	`listUniqueProblems(ListUniqueProblemsRequest request)` Gets information about unique problems.
`ListUploadsResult`	`listUploads(ListUploadsRequest request)` Gets information about uploads, given an AWS Device Farm project ARN.
`PurchaseOfferingResult`	`purchaseOffering(PurchaseOfferingRequest request)` Immediately purchases offerings for an AWS account.
`RenewOfferingResult`	`renewOffering(RenewOfferingRequest request)` Explicitly sets the quantity of devices to renew for an offering, starting from the `effectiveDate` of the next period.
`ScheduleRunResult`	`scheduleRun(ScheduleRunRequest request)` Schedules a run.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("https://devicefarm.us-west-2.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `AWSDeviceFarm.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StopRemoteAccessSessionResult`	`stopRemoteAccessSession(StopRemoteAccessSessionRequest request)` Ends a specified remote access session.
`StopRunResult`	`stopRun(StopRunRequest request)` Initiates a stop request for the current test run.
`UpdateDevicePoolResult`	`updateDevicePool(UpdateDevicePoolRequest request)` Modifies the name, description, and rules in a device pool given the attributes and the pool ARN.
`UpdateNetworkProfileResult`	`updateNetworkProfile(UpdateNetworkProfileRequest request)` Updates the network profile with specific settings.
`UpdateProjectResult`	`updateProject(UpdateProjectRequest request)` Modifies the specified project name, given the project ARN and a new name.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AWSDeviceFarm
    
    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.
    
    Specified by:
    
    setEndpoint in interface AWSDeviceFarm
    
    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
```
public void setRegion(Region region)
```
    Description copied from interface: AWSDeviceFarm
    
    An alternative to AWSDeviceFarm.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.
    
    Specified by:
    
    setRegion in interface AWSDeviceFarm
    
    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
```
public CreateDevicePoolResult createDevicePool(CreateDevicePoolRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Creates a device pool.
    
    Specified by:
    
    createDevicePool in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the create device pool operation.
    
    Returns:
    
    Result of the CreateDevicePool operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createNetworkProfile
```
public CreateNetworkProfileResult createNetworkProfile(CreateNetworkProfileRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Creates a network profile.
    
    Specified by:
    
    createNetworkProfile in interface AWSDeviceFarm
    
    Returns:
    
    Result of the CreateNetworkProfile operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createProject
```
public CreateProjectResult createProject(CreateProjectRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Creates a new project.
    
    Specified by:
    
    createProject in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the create project operation.
    
    Returns:
    
    Result of the CreateProject operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createRemoteAccessSession
```
public CreateRemoteAccessSessionResult createRemoteAccessSession(CreateRemoteAccessSessionRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Specifies and starts a remote access session.
    
    Specified by:
    
    createRemoteAccessSession in interface AWSDeviceFarm
    
    Parameters:
    
    request - Creates and submits a request to start a remote access session.
    
    Returns:
    
    Result of the CreateRemoteAccessSession operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createUpload
```
public CreateUploadResult createUpload(CreateUploadRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Uploads an app or test scripts.
    
    Specified by:
    
    createUpload in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the create upload operation.
    
    Returns:
    
    Result of the CreateUpload operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDevicePool
```
public DeleteDevicePoolResult deleteDevicePool(DeleteDevicePoolRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.
    
    Specified by:
    
    deleteDevicePool in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the delete device pool operation.
    
    Returns:
    
    Result of the DeleteDevicePool operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteNetworkProfile
```
public DeleteNetworkProfileResult deleteNetworkProfile(DeleteNetworkProfileRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Deletes a network profile.
    
    Specified by:
    
    deleteNetworkProfile in interface AWSDeviceFarm
    
    Returns:
    
    Result of the DeleteNetworkProfile operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteProject
```
public DeleteProjectResult deleteProject(DeleteProjectRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Deletes an AWS Device Farm project, given the project ARN.
    
    Note Deleting this resource does not stop an in-progress run.
    
    Specified by:
    
    deleteProject in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the delete project operation.
    
    Returns:
    
    Result of the DeleteProject operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteRemoteAccessSession
```
public DeleteRemoteAccessSessionResult deleteRemoteAccessSession(DeleteRemoteAccessSessionRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Deletes a completed remote access session and its results.
    
    Specified by:
    
    deleteRemoteAccessSession in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents the request to delete the specified remote access session.
    
    Returns:
    
    Result of the DeleteRemoteAccessSession operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteRun
```
public DeleteRunResult deleteRun(DeleteRunRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Deletes the run, given the run ARN.
    
    Note Deleting this resource does not stop an in-progress run.
    
    Specified by:
    
    deleteRun in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the delete run operation.
    
    Returns:
    
    Result of the DeleteRun operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteUpload
```
public DeleteUploadResult deleteUpload(DeleteUploadRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Deletes an upload given the upload ARN.
    
    Specified by:
    
    deleteUpload in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the delete upload operation.
    
    Returns:
    
    Result of the DeleteUpload operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getAccountSettings
```
public GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account.
    
    Specified by:
    
    getAccountSettings in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents the request sent to retrieve the account settings.
    
    Returns:
    
    Result of the GetAccountSettings operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDevice
```
public GetDeviceResult getDevice(GetDeviceRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Gets information about a unique device type.
    
    Specified by:
    
    getDevice in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the get device request.
    
    Returns:
    
    Result of the GetDevice operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDevicePool
```
public GetDevicePoolResult getDevicePool(GetDevicePoolRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Gets information about a device pool.
    
    Specified by:
    
    getDevicePool in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the get device pool operation.
    
    Returns:
    
    Result of the GetDevicePool operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDevicePoolCompatibility
```
public GetDevicePoolCompatibilityResult getDevicePoolCompatibility(GetDevicePoolCompatibilityRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Gets information about compatibility with a device pool.
    
    Specified by:
    
    getDevicePoolCompatibility in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the get device pool compatibility operation.
    
    Returns:
    
    Result of the GetDevicePoolCompatibility operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getJob
```
public GetJobResult getJob(GetJobRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Gets information about a job.
    
    Specified by:
    
    getJob in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the get job operation.
    
    Returns:
    
    Result of the GetJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getNetworkProfile
```
public GetNetworkProfileResult getNetworkProfile(GetNetworkProfileRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Returns information about a network profile.
    
    Specified by:
    
    getNetworkProfile in interface AWSDeviceFarm
    
    Returns:
    
    Result of the GetNetworkProfile operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getOfferingStatus
```
public GetOfferingStatusResult getOfferingStatus(GetOfferingStatusRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Gets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and the offerings that will be available in the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
    
    Specified by:
    
    getOfferingStatus in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents the request to retrieve the offering status for the specified customer or account.
    
    Returns:
    
    Result of the GetOfferingStatus operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getProject
```
public GetProjectResult getProject(GetProjectRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Gets information about a project.
    
    Specified by:
    
    getProject in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the get project operation.
    
    Returns:
    
    Result of the GetProject operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getRemoteAccessSession
```
public GetRemoteAccessSessionResult getRemoteAccessSession(GetRemoteAccessSessionRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Returns a link to a currently running remote access session.
    
    Specified by:
    
    getRemoteAccessSession in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents the request to get information about the specified remote access session.
    
    Returns:
    
    Result of the GetRemoteAccessSession operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getRun
```
public GetRunResult getRun(GetRunRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Gets information about a run.
    
    Specified by:
    
    getRun in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the get run operation.
    
    Returns:
    
    Result of the GetRun operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getSuite
```
public GetSuiteResult getSuite(GetSuiteRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Gets information about a suite.
    
    Specified by:
    
    getSuite in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the get suite operation.
    
    Returns:
    
    Result of the GetSuite operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getTest
```
public GetTestResult getTest(GetTestRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Gets information about a test.
    
    Specified by:
    
    getTest in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the get test operation.
    
    Returns:
    
    Result of the GetTest operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getUpload
```
public GetUploadResult getUpload(GetUploadRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Gets information about an upload.
    
    Specified by:
    
    getUpload in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the get upload operation.
    
    Returns:
    
    Result of the GetUpload operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - installToRemoteAccessSession
```
public InstallToRemoteAccessSessionResult installToRemoteAccessSession(InstallToRemoteAccessSessionRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    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.
    
    Specified by:
    
    installToRemoteAccessSession in interface AWSDeviceFarm
    
    Parameters:
    
    request - 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.
    
    See Also:
    
    AWS API Documentation
  - listArtifacts
```
public ListArtifactsResult listArtifacts(ListArtifactsRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Gets information about artifacts.
    
    Specified by:
    
    listArtifacts in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the list artifacts operation.
    
    Returns:
    
    Result of the ListArtifacts operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDevicePools
```
public ListDevicePoolsResult listDevicePools(ListDevicePoolsRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Gets information about device pools.
    
    Specified by:
    
    listDevicePools in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents the result of a list device pools request.
    
    Returns:
    
    Result of the ListDevicePools operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDevices
```
public ListDevicesResult listDevices(ListDevicesRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Gets information about unique device types.
    
    Specified by:
    
    listDevices in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents the result of a list devices request.
    
    Returns:
    
    Result of the ListDevices operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listJobs
```
public ListJobsResult listJobs(ListJobsRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Gets information about jobs.
    
    Specified by:
    
    listJobs in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the list jobs operation.
    
    Returns:
    
    Result of the ListJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listNetworkProfiles
```
public ListNetworkProfilesResult listNetworkProfiles(ListNetworkProfilesRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Returns the list of available network profiles.
    
    Specified by:
    
    listNetworkProfiles in interface AWSDeviceFarm
    
    Returns:
    
    Result of the ListNetworkProfiles operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listOfferingPromotions
```
public ListOfferingPromotionsResult listOfferingPromotions(ListOfferingPromotionsRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a NotEligible error if the caller is not permitted to invoke the operation. Contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
    
    Specified by:
    
    listOfferingPromotions in interface AWSDeviceFarm
    
    Returns:
    
    Result of the ListOfferingPromotions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listOfferingTransactions
```
public ListOfferingTransactionsResult listOfferingTransactions(ListOfferingTransactionsRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account. The list is paginated and ordered by a descending timestamp (most recent transactions are first). The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
    
    Specified by:
    
    listOfferingTransactions in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents the request to list the offering transaction history.
    
    Returns:
    
    Result of the ListOfferingTransactions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listOfferings
```
public ListOfferingsResult listOfferings(ListOfferingsRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Returns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the frequency for that offering. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
    
    Specified by:
    
    listOfferings in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents the request to list all offerings.
    
    Returns:
    
    Result of the ListOfferings operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listProjects
```
public ListProjectsResult listProjects(ListProjectsRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Gets information about projects.
    
    Specified by:
    
    listProjects in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the list projects operation.
    
    Returns:
    
    Result of the ListProjects operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listRemoteAccessSessions
```
public ListRemoteAccessSessionsResult listRemoteAccessSessions(ListRemoteAccessSessionsRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Returns a list of all currently running remote access sessions.
    
    Specified by:
    
    listRemoteAccessSessions in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents the request to return information about the remote access session.
    
    Returns:
    
    Result of the ListRemoteAccessSessions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listRuns
```
public ListRunsResult listRuns(ListRunsRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Gets information about runs, given an AWS Device Farm project ARN.
    
    Specified by:
    
    listRuns in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the list runs operation.
    
    Returns:
    
    Result of the ListRuns operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSamples
```
public ListSamplesResult listSamples(ListSamplesRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Gets information about samples, given an AWS Device Farm project ARN
    
    Specified by:
    
    listSamples in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the list samples operation.
    
    Returns:
    
    Result of the ListSamples operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSuites
```
public ListSuitesResult listSuites(ListSuitesRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Gets information about suites.
    
    Specified by:
    
    listSuites in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the list suites operation.
    
    Returns:
    
    Result of the ListSuites operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTests
```
public ListTestsResult listTests(ListTestsRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Gets information about tests.
    
    Specified by:
    
    listTests in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the list tests operation.
    
    Returns:
    
    Result of the ListTests operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listUniqueProblems
```
public ListUniqueProblemsResult listUniqueProblems(ListUniqueProblemsRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Gets information about unique problems.
    
    Specified by:
    
    listUniqueProblems in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the list unique problems operation.
    
    Returns:
    
    Result of the ListUniqueProblems operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listUploads
```
public ListUploadsResult listUploads(ListUploadsRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Gets information about uploads, given an AWS Device Farm project ARN.
    
    Specified by:
    
    listUploads in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the list uploads operation.
    
    Returns:
    
    Result of the ListUploads operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - purchaseOffering
```
public PurchaseOfferingResult purchaseOffering(PurchaseOfferingRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
    
    Specified by:
    
    purchaseOffering in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request for a purchase offering.
    
    Returns:
    
    Result of the PurchaseOffering operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - renewOffering
```
public RenewOfferingResult renewOffering(RenewOfferingRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
    
    Specified by:
    
    renewOffering in interface AWSDeviceFarm
    
    Parameters:
    
    request - A request representing an offering renewal.
    
    Returns:
    
    Result of the RenewOffering operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - scheduleRun
```
public ScheduleRunResult scheduleRun(ScheduleRunRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Schedules a run.
    
    Specified by:
    
    scheduleRun in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the schedule run operation.
    
    Returns:
    
    Result of the ScheduleRun operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopRemoteAccessSession
```
public StopRemoteAccessSessionResult stopRemoteAccessSession(StopRemoteAccessSessionRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Ends a specified remote access session.
    
    Specified by:
    
    stopRemoteAccessSession in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents the request to stop the remote access session.
    
    Returns:
    
    Result of the StopRemoteAccessSession operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopRun
```
public StopRunResult stopRun(StopRunRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    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.
    
    Specified by:
    
    stopRun in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents the request to stop a specific run.
    
    Returns:
    
    Result of the StopRun operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDevicePool
```
public UpdateDevicePoolResult updateDevicePool(UpdateDevicePoolRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    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).
    
    Specified by:
    
    updateDevicePool in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the update device pool operation.
    
    Returns:
    
    Result of the UpdateDevicePool operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateNetworkProfile
```
public UpdateNetworkProfileResult updateNetworkProfile(UpdateNetworkProfileRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Updates the network profile with specific settings.
    
    Specified by:
    
    updateNetworkProfile in interface AWSDeviceFarm
    
    Returns:
    
    Result of the UpdateNetworkProfile operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateProject
```
public UpdateProjectResult updateProject(UpdateProjectRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    Modifies the specified project name, given the project ARN and a new name.
    
    Specified by:
    
    updateProject in interface AWSDeviceFarm
    
    Parameters:
    
    request - Represents a request to the update project operation.
    
    Returns:
    
    Result of the UpdateProject operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSDeviceFarm
    
    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.
    
    Specified by:
    
    shutdown in interface AWSDeviceFarm
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSDeviceFarm
    
    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.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSDeviceFarm
    
    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?

Class AbstractAWSDeviceFarm

Field Summary

Fields inherited from interface com.amazonaws.services.devicefarm.AWSDeviceFarm

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

createDevicePool

createNetworkProfile

createProject

createRemoteAccessSession

createUpload

deleteDevicePool

deleteNetworkProfile

deleteProject

deleteRemoteAccessSession

deleteRun

deleteUpload

getAccountSettings

getDevice

getDevicePool

getDevicePoolCompatibility

getJob

getNetworkProfile

getOfferingStatus

getProject

getRemoteAccessSession

getRun

getSuite

getTest

getUpload

installToRemoteAccessSession

listArtifacts

listDevicePools

listDevices

listJobs

listNetworkProfiles

listOfferingPromotions

listOfferingTransactions

listOfferings

listProjects

listRemoteAccessSessions

listRuns

listSamples

listSuites

listTests

listUniqueProblems

listUploads

purchaseOffering

renewOffering

scheduleRun

stopRemoteAccessSession

stopRun

updateDevicePool

updateNetworkProfile

updateProject

shutdown

getCachedResponseMetadata