AWSDeviceFarm (AWS Java SDK for AWS Device Farm 1.11.1002 API)

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.

Welcome to the AWS Device Farm API documentation, which contains APIs for:
- Testing on desktop browsers
  
  Device Farm makes it possible for you to test your web applications on desktop browsers using Selenium. The APIs for desktop browser testing contain TestGrid in their names. For more information, see Testing Web Applications on Selenium with Device Farm.
- Testing on real mobile devices
  
  Device Farm makes it possible for you to test apps on physical phones, tablets, and other devices in the cloud. For more information, see the Device Farm Developer Guide.

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.
`CreateInstanceProfileResult`	`createInstanceProfile(CreateInstanceProfileRequest createInstanceProfileRequest)` Creates a profile that can be applied to one or more private fleet device instances.
`CreateNetworkProfileResult`	`createNetworkProfile(CreateNetworkProfileRequest createNetworkProfileRequest)` Creates a network profile.
`CreateProjectResult`	`createProject(CreateProjectRequest createProjectRequest)` Creates a project.
`CreateRemoteAccessSessionResult`	`createRemoteAccessSession(CreateRemoteAccessSessionRequest createRemoteAccessSessionRequest)` Specifies and starts a remote access session.
`CreateTestGridProjectResult`	`createTestGridProject(CreateTestGridProjectRequest createTestGridProjectRequest)` Creates a Selenium testing project.
`CreateTestGridUrlResult`	`createTestGridUrl(CreateTestGridUrlRequest createTestGridUrlRequest)` Creates a signed, short-term URL that can be passed to a Selenium `RemoteWebDriver` constructor.
`CreateUploadResult`	`createUpload(CreateUploadRequest createUploadRequest)` Uploads an app or test scripts.
`CreateVPCEConfigurationResult`	`createVPCEConfiguration(CreateVPCEConfigurationRequest createVPCEConfigurationRequest)` Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.
`DeleteDevicePoolResult`	`deleteDevicePool(DeleteDevicePoolRequest deleteDevicePoolRequest)` Deletes a device pool given the pool ARN.
`DeleteInstanceProfileResult`	`deleteInstanceProfile(DeleteInstanceProfileRequest deleteInstanceProfileRequest)` Deletes a profile that can be applied to one or more private device instances.
`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.
`DeleteTestGridProjectResult`	`deleteTestGridProject(DeleteTestGridProjectRequest deleteTestGridProjectRequest)` Deletes a Selenium testing project and all content generated under it.
`DeleteUploadResult`	`deleteUpload(DeleteUploadRequest deleteUploadRequest)` Deletes an upload given the upload ARN.
`DeleteVPCEConfigurationResult`	`deleteVPCEConfiguration(DeleteVPCEConfigurationRequest deleteVPCEConfigurationRequest)` Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.
`GetAccountSettingsResult`	`getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)` Returns the number of unmetered iOS or unmetered Android devices that have been purchased by the account.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetDeviceResult`	`getDevice(GetDeviceRequest getDeviceRequest)` Gets information about a unique device type.
`GetDeviceInstanceResult`	`getDeviceInstance(GetDeviceInstanceRequest getDeviceInstanceRequest)` Returns information about a device instance that belongs to a private device fleet.
`GetDevicePoolResult`	`getDevicePool(GetDevicePoolRequest getDevicePoolRequest)` Gets information about a device pool.
`GetDevicePoolCompatibilityResult`	`getDevicePoolCompatibility(GetDevicePoolCompatibilityRequest getDevicePoolCompatibilityRequest)` Gets information about compatibility with a device pool.
`GetInstanceProfileResult`	`getInstanceProfile(GetInstanceProfileRequest getInstanceProfileRequest)` Returns information about the specified instance profile.
`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.
`GetTestGridProjectResult`	`getTestGridProject(GetTestGridProjectRequest getTestGridProjectRequest)` Retrieves information about a Selenium testing project.
`GetTestGridSessionResult`	`getTestGridSession(GetTestGridSessionRequest getTestGridSessionRequest)` A session is an instance of a browser created through a `RemoteWebDriver` with the URL from CreateTestGridUrlResult$url.
`GetUploadResult`	`getUpload(GetUploadRequest getUploadRequest)` Gets information about an upload.
`GetVPCEConfigurationResult`	`getVPCEConfiguration(GetVPCEConfigurationRequest getVPCEConfigurationRequest)` Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.
`InstallToRemoteAccessSessionResult`	`installToRemoteAccessSession(InstallToRemoteAccessSessionRequest installToRemoteAccessSessionRequest)` Installs an application to the device in a remote access session.
`ListArtifactsResult`	`listArtifacts(ListArtifactsRequest listArtifactsRequest)` Gets information about artifacts.
`ListDeviceInstancesResult`	`listDeviceInstances(ListDeviceInstancesRequest listDeviceInstancesRequest)` Returns information about the private device instances associated with one or more AWS accounts.
`ListDevicePoolsResult`	`listDevicePools(ListDevicePoolsRequest listDevicePoolsRequest)` Gets information about device pools.
`ListDevicesResult`	`listDevices(ListDevicesRequest listDevicesRequest)` Gets information about unique device types.
`ListInstanceProfilesResult`	`listInstanceProfiles(ListInstanceProfilesRequest listInstanceProfilesRequest)` Returns information about all the instance profiles in an AWS account.
`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 job ARN.
`ListSuitesResult`	`listSuites(ListSuitesRequest listSuitesRequest)` Gets information about test suites for a given job.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` List the tags for an AWS Device Farm resource.
`ListTestGridProjectsResult`	`listTestGridProjects(ListTestGridProjectsRequest listTestGridProjectsRequest)` Gets a list of all Selenium testing projects in your account.
`ListTestGridSessionActionsResult`	`listTestGridSessionActions(ListTestGridSessionActionsRequest listTestGridSessionActionsRequest)` Returns a list of the actions taken in a TestGridSession.
`ListTestGridSessionArtifactsResult`	`listTestGridSessionArtifacts(ListTestGridSessionArtifactsRequest listTestGridSessionArtifactsRequest)` Retrieves a list of artifacts created during the session.
`ListTestGridSessionsResult`	`listTestGridSessions(ListTestGridSessionsRequest listTestGridSessionsRequest)` Retrieves a list of sessions for a TestGridProject.
`ListTestsResult`	`listTests(ListTestsRequest listTestsRequest)` Gets information about tests in a given test suite.
`ListUniqueProblemsResult`	`listUniqueProblems(ListUniqueProblemsRequest listUniqueProblemsRequest)` Gets information about unique problems, such as exceptions or crashes.
`ListUploadsResult`	`listUploads(ListUploadsRequest listUploadsRequest)` Gets information about uploads, given an AWS Device Farm project ARN.
`ListVPCEConfigurationsResult`	`listVPCEConfigurations(ListVPCEConfigurationsRequest listVPCEConfigurationsRequest)` Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.
`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.
`StopJobResult`	`stopJob(StopJobRequest stopJobRequest)` Initiates a stop request for the current job.
`StopRemoteAccessSessionResult`	`stopRemoteAccessSession(StopRemoteAccessSessionRequest stopRemoteAccessSessionRequest)` Ends a specified remote access session.
`StopRunResult`	`stopRun(StopRunRequest stopRunRequest)` Initiates a stop request for the current test run.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Associates the specified tags to a resource with the specified `resourceArn`.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Deletes the specified tags from a resource.
`UpdateDeviceInstanceResult`	`updateDeviceInstance(UpdateDeviceInstanceRequest updateDeviceInstanceRequest)` Updates information about a private device instance.
`UpdateDevicePoolResult`	`updateDevicePool(UpdateDevicePoolRequest updateDevicePoolRequest)` Modifies the name, description, and rules in a device pool given the attributes and the pool ARN.
`UpdateInstanceProfileResult`	`updateInstanceProfile(UpdateInstanceProfileRequest updateInstanceProfileRequest)` Updates information about an existing private device instance profile.
`UpdateNetworkProfileResult`	`updateNetworkProfile(UpdateNetworkProfileRequest updateNetworkProfileRequest)` Updates the network profile.
`UpdateProjectResult`	`updateProject(UpdateProjectRequest updateProjectRequest)` Modifies the specified project name, given the project ARN and a new name.
`UpdateTestGridProjectResult`	`updateTestGridProject(UpdateTestGridProjectRequest updateTestGridProjectRequest)` Change details of a project.
`UpdateUploadResult`	`updateUpload(UpdateUploadRequest updateUploadRequest)` Updates an uploaded test spec.
`UpdateVPCEConfigurationResult`	`updateVPCEConfiguration(UpdateVPCEConfigurationRequest updateVPCEConfigurationRequest)` Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.

- 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: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
    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
  - createInstanceProfile
```
CreateInstanceProfileResult createInstanceProfile(CreateInstanceProfileRequest createInstanceProfileRequest)
```
    Creates a profile that can be applied to one or more private fleet device instances.
    
    Parameters:
    
    createInstanceProfileRequest -
    
    Returns:
    
    Result of the CreateInstanceProfile 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
  - 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 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.
    
    TagOperationException - The operation was not successful. Try again.
    
    See Also:
    
    AWS API Documentation
  - 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
  - createTestGridProject
```
CreateTestGridProjectResult createTestGridProject(CreateTestGridProjectRequest createTestGridProjectRequest)
```
    Creates a Selenium testing project. Projects are used to track TestGridSession instances.
    
    Parameters:
    
    createTestGridProjectRequest -
    
    Returns:
    
    Result of the CreateTestGridProject operation returned by the service.
    
    Throws:
    
    InternalServiceException - An internal exception was raised in the service. Contact [email protected] if you see this error.
    
    See Also:
    
    AWS API Documentation
  - createTestGridUrl
```
CreateTestGridUrlResult createTestGridUrl(CreateTestGridUrlRequest createTestGridUrlRequest)
```
    Creates a signed, short-term URL that can be passed to a Selenium RemoteWebDriver constructor.
    
    Parameters:
    
    createTestGridUrlRequest -
    
    Returns:
    
    Result of the CreateTestGridUrl operation returned by the service.
    
    Throws:
    
    NotFoundException - The specified entity was not found.
    
    ArgumentException - An invalid argument was specified.
    
    InternalServiceException - An internal exception was raised in the service. Contact [email protected] if you see this error.
    
    See Also:
    
    AWS API Documentation
  - 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
  - createVPCEConfiguration
```
CreateVPCEConfigurationResult createVPCEConfiguration(CreateVPCEConfigurationRequest createVPCEConfigurationRequest)
```
    Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.
    
    Parameters:
    
    createVPCEConfigurationRequest -
    
    Returns:
    
    Result of the CreateVPCEConfiguration operation returned by the service.
    
    Throws:
    
    ArgumentException - An invalid argument was specified.
    
    LimitExceededException - A limit was exceeded.
    
    ServiceAccountException - There was a problem with the service account.
    
    See Also:
    
    AWS API Documentation
  - 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
  - deleteInstanceProfile
```
DeleteInstanceProfileResult deleteInstanceProfile(DeleteInstanceProfileRequest deleteInstanceProfileRequest)
```
    Deletes a profile that can be applied to one or more private device instances.
    
    Parameters:
    
    deleteInstanceProfileRequest -
    
    Returns:
    
    Result of the DeleteInstanceProfile 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
  - 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.
    
    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
  - 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
  - deleteRun
```
DeleteRunResult deleteRun(DeleteRunRequest deleteRunRequest)
```
    Deletes the run, given the run ARN.
    
    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
  - deleteTestGridProject
```
DeleteTestGridProjectResult deleteTestGridProject(DeleteTestGridProjectRequest deleteTestGridProjectRequest)
```
    Deletes a Selenium testing project and all content generated under it.
    
    You cannot undo this operation.
    
    You cannot delete a project if it has active sessions.
    
    Parameters:
    
    deleteTestGridProjectRequest -
    
    Returns:
    
    Result of the DeleteTestGridProject operation returned by the service.
    
    Throws:
    
    NotFoundException - The specified entity was not found.
    
    ArgumentException - An invalid argument was specified.
    
    CannotDeleteException - The requested object could not be deleted.
    
    InternalServiceException - An internal exception was raised in the service. Contact [email protected] if you see this error.
    
    See Also:
    
    AWS API Documentation
  - 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
  - deleteVPCEConfiguration
```
DeleteVPCEConfigurationResult deleteVPCEConfiguration(DeleteVPCEConfigurationRequest deleteVPCEConfigurationRequest)
```
    Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.
    
    Parameters:
    
    deleteVPCEConfigurationRequest -
    
    Returns:
    
    Result of the DeleteVPCEConfiguration operation returned by the service.
    
    Throws:
    
    ArgumentException - An invalid argument was specified.
    
    NotFoundException - The specified entity was not found.
    
    ServiceAccountException - There was a problem with the service account.
    
    InvalidOperationException - There was an error with the update request, or you do not have sufficient permissions to update this VPC endpoint configuration.
    
    See Also:
    
    AWS API Documentation
  - getAccountSettings
```
GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)
```
    Returns the number of unmetered iOS 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
  - 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
  - getDeviceInstance
```
GetDeviceInstanceResult getDeviceInstance(GetDeviceInstanceRequest getDeviceInstanceRequest)
```
    Returns information about a device instance that belongs to a private device fleet.
    
    Parameters:
    
    getDeviceInstanceRequest -
    
    Returns:
    
    Result of the GetDeviceInstance 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
  - 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
  - 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
  - getInstanceProfile
```
GetInstanceProfileResult getInstanceProfile(GetInstanceProfileRequest getInstanceProfileRequest)
```
    Returns information about the specified instance profile.
    
    Parameters:
    
    getInstanceProfileRequest -
    
    Returns:
    
    Result of the GetInstanceProfile 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
  - 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
  - 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. If you must be able to invoke this operation, contact [email protected].
    
    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
  - 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
  - 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
  - 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
  - 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
  - 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
  - getTestGridProject
```
GetTestGridProjectResult getTestGridProject(GetTestGridProjectRequest getTestGridProjectRequest)
```
    Retrieves information about a Selenium testing project.
    
    Parameters:
    
    getTestGridProjectRequest -
    
    Returns:
    
    Result of the GetTestGridProject operation returned by the service.
    
    Throws:
    
    NotFoundException - The specified entity was not found.
    
    ArgumentException - An invalid argument was specified.
    
    InternalServiceException - An internal exception was raised in the service. Contact [email protected] if you see this error.
    
    See Also:
    
    AWS API Documentation
  - getTestGridSession
```
GetTestGridSessionResult getTestGridSession(GetTestGridSessionRequest getTestGridSessionRequest)
```
    A session is an instance of a browser created through a RemoteWebDriver with the URL from CreateTestGridUrlResult$url. You can use the following to look up sessions:
    - The session ARN (GetTestGridSessionRequest$sessionArn).
    - The project ARN and a session ID (GetTestGridSessionRequest$projectArn and GetTestGridSessionRequest$sessionId).
    Parameters:
    
    getTestGridSessionRequest -
    
    Returns:
    
    Result of the GetTestGridSession operation returned by the service.
    
    Throws:
    
    NotFoundException - The specified entity was not found.
    
    ArgumentException - An invalid argument was specified.
    
    InternalServiceException - An internal exception was raised in the service. Contact [email protected] if you see this error.
    
    See Also:
    
    AWS API Documentation
  - 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
  - getVPCEConfiguration
```
GetVPCEConfigurationResult getVPCEConfiguration(GetVPCEConfigurationRequest getVPCEConfigurationRequest)
```
    Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.
    
    Parameters:
    
    getVPCEConfigurationRequest -
    
    Returns:
    
    Result of the GetVPCEConfiguration operation returned by the service.
    
    Throws:
    
    ArgumentException - An invalid argument was specified.
    
    NotFoundException - The specified entity was not found.
    
    ServiceAccountException - There was a problem with the service account.
    
    See Also:
    
    AWS API Documentation
  - 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
  - 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
  - listDeviceInstances
```
ListDeviceInstancesResult listDeviceInstances(ListDeviceInstancesRequest listDeviceInstancesRequest)
```
    Returns information about the private device instances associated with one or more AWS accounts.
    
    Parameters:
    
    listDeviceInstancesRequest -
    
    Returns:
    
    Result of the ListDeviceInstances 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
  - 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
  - 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
  - listInstanceProfiles
```
ListInstanceProfilesResult listInstanceProfiles(ListInstanceProfilesRequest listInstanceProfilesRequest)
```
    Returns information about all the instance profiles in an AWS account.
    
    Parameters:
    
    listInstanceProfilesRequest -
    
    Returns:
    
    Result of the ListInstanceProfiles 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
  - 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
  - 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 must 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. If you must be able to invoke this operation, contact [email protected].
    
    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
  - 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. If you must be able to invoke this operation, contact [email protected].
    
    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
  - 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
  - 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
  - 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
  - listSamples
```
ListSamplesResult listSamples(ListSamplesRequest listSamplesRequest)
```
    Gets information about samples, given an AWS Device Farm job 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
  - 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
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    List the tags for an AWS Device Farm resource.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    ArgumentException - An invalid argument was specified.
    
    NotFoundException - The specified entity was not found.
    
    TagOperationException - The operation was not successful. Try again.
    
    See Also:
    
    AWS API Documentation
  - listTestGridProjects
```
ListTestGridProjectsResult listTestGridProjects(ListTestGridProjectsRequest listTestGridProjectsRequest)
```
    Gets a list of all Selenium testing projects in your account.
    
    Parameters:
    
    listTestGridProjectsRequest -
    
    Returns:
    
    Result of the ListTestGridProjects operation returned by the service.
    
    Throws:
    
    ArgumentException - An invalid argument was specified.
    
    InternalServiceException - An internal exception was raised in the service. Contact [email protected] if you see this error.
    
    See Also:
    
    AWS API Documentation
  - listTestGridSessionActions
```
ListTestGridSessionActionsResult listTestGridSessionActions(ListTestGridSessionActionsRequest listTestGridSessionActionsRequest)
```
    Returns a list of the actions taken in a TestGridSession.
    
    Parameters:
    
    listTestGridSessionActionsRequest -
    
    Returns:
    
    Result of the ListTestGridSessionActions operation returned by the service.
    
    Throws:
    
    NotFoundException - The specified entity was not found.
    
    ArgumentException - An invalid argument was specified.
    
    InternalServiceException - An internal exception was raised in the service. Contact [email protected] if you see this error.
    
    See Also:
    
    AWS API Documentation
  - listTestGridSessionArtifacts
```
ListTestGridSessionArtifactsResult listTestGridSessionArtifacts(ListTestGridSessionArtifactsRequest listTestGridSessionArtifactsRequest)
```
    Retrieves a list of artifacts created during the session.
    
    Parameters:
    
    listTestGridSessionArtifactsRequest -
    
    Returns:
    
    Result of the ListTestGridSessionArtifacts operation returned by the service.
    
    Throws:
    
    NotFoundException - The specified entity was not found.
    
    ArgumentException - An invalid argument was specified.
    
    InternalServiceException - An internal exception was raised in the service. Contact [email protected] if you see this error.
    
    See Also:
    
    AWS API Documentation
  - listTestGridSessions
```
ListTestGridSessionsResult listTestGridSessions(ListTestGridSessionsRequest listTestGridSessionsRequest)
```
    Retrieves a list of sessions for a TestGridProject.
    
    Parameters:
    
    listTestGridSessionsRequest -
    
    Returns:
    
    Result of the ListTestGridSessions operation returned by the service.
    
    Throws:
    
    NotFoundException - The specified entity was not found.
    
    ArgumentException - An invalid argument was specified.
    
    InternalServiceException - An internal exception was raised in the service. Contact [email protected] if you see this error.
    
    See Also:
    
    AWS API Documentation
  - 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
  - listUniqueProblems
```
ListUniqueProblemsResult listUniqueProblems(ListUniqueProblemsRequest listUniqueProblemsRequest)
```
    Gets information about unique problems, such as exceptions or crashes.
    
    Unique problems are defined as a single instance of an error across a run, job, or suite. For example, if a call in your application consistently raises an exception (OutOfBoundsException in MyActivity.java:386), ListUniqueProblems returns a single entry instead of many individual entries for that exception.
    
    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
  - 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
  - listVPCEConfigurations
```
ListVPCEConfigurationsResult listVPCEConfigurations(ListVPCEConfigurationsRequest listVPCEConfigurationsRequest)
```
    Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.
    
    Parameters:
    
    listVPCEConfigurationsRequest -
    
    Returns:
    
    Result of the ListVPCEConfigurations operation returned by the service.
    
    Throws:
    
    ArgumentException - An invalid argument was specified.
    
    ServiceAccountException - There was a problem with the service account.
    
    See Also:
    
    AWS API Documentation
  - 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. If you must be able to invoke this operation, contact [email protected].
    
    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
  - 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. If you must be able to invoke this operation, contact [email protected].
    
    Parameters:
    
    renewOfferingRequest - A request that represents 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
  - 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
  - stopJob
```
StopJobResult stopJob(StopJobRequest stopJobRequest)
```
    Initiates a stop request for the current job. AWS Device Farm immediately stops the job on the device where tests have not started. You are not billed for this device. On the device where tests have started, setup suite and teardown suite tests run to completion on the device. You are billed for setup, teardown, and any tests that were in progress or already completed.
    
    Parameters:
    
    stopJobRequest -
    
    Returns:
    
    Result of the StopJob 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
  - 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 immediately stops the run on devices where tests have not started. You are not billed for these devices. On devices where tests have started executing, setup suite and teardown suite tests run to completion on those devices. You are billed for setup, teardown, and any tests that were in progress or already completed.
    
    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
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    ArgumentException - An invalid argument was specified.
    
    NotFoundException - The specified entity was not found.
    
    TagOperationException - The operation was not successful. Try again.
    
    TooManyTagsException - The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.
    
    TagPolicyException - The request doesn't comply with the AWS Identity and Access Management (IAM) tag policy. Correct your request and then retry it.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Deletes the specified tags from a resource.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ArgumentException - An invalid argument was specified.
    
    NotFoundException - The specified entity was not found.
    
    TagOperationException - The operation was not successful. Try again.
    
    See Also:
    
    AWS API Documentation
  - updateDeviceInstance
```
UpdateDeviceInstanceResult updateDeviceInstance(UpdateDeviceInstanceRequest updateDeviceInstanceRequest)
```
    Updates information about a private device instance.
    
    Parameters:
    
    updateDeviceInstanceRequest -
    
    Returns:
    
    Result of the UpdateDeviceInstance 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
  - 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
  - updateInstanceProfile
```
UpdateInstanceProfileResult updateInstanceProfile(UpdateInstanceProfileRequest updateInstanceProfileRequest)
```
    Updates information about an existing private device instance profile.
    
    Parameters:
    
    updateInstanceProfileRequest -
    
    Returns:
    
    Result of the UpdateInstanceProfile 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
  - updateNetworkProfile
```
UpdateNetworkProfileResult updateNetworkProfile(UpdateNetworkProfileRequest updateNetworkProfileRequest)
```
    Updates the network profile.
    
    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
  - updateTestGridProject
```
UpdateTestGridProjectResult updateTestGridProject(UpdateTestGridProjectRequest updateTestGridProjectRequest)
```
    Change details of a project.
    
    Parameters:
    
    updateTestGridProjectRequest -
    
    Returns:
    
    Result of the UpdateTestGridProject operation returned by the service.
    
    Throws:
    
    NotFoundException - The specified entity was not found.
    
    ArgumentException - An invalid argument was specified.
    
    InternalServiceException - An internal exception was raised in the service. Contact [email protected] if you see this error.
    
    See Also:
    
    AWS API Documentation
  - updateUpload
```
UpdateUploadResult updateUpload(UpdateUploadRequest updateUploadRequest)
```
    Updates an uploaded test spec.
    
    Parameters:
    
    updateUploadRequest -
    
    Returns:
    
    Result of the UpdateUpload 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
  - updateVPCEConfiguration
```
UpdateVPCEConfigurationResult updateVPCEConfiguration(UpdateVPCEConfigurationRequest updateVPCEConfigurationRequest)
```
    Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.
    
    Parameters:
    
    updateVPCEConfigurationRequest -
    
    Returns:
    
    Result of the UpdateVPCEConfiguration operation returned by the service.
    
    Throws:
    
    ArgumentException - An invalid argument was specified.
    
    NotFoundException - The specified entity was not found.
    
    ServiceAccountException - There was a problem with the service account.
    
    InvalidOperationException - There was an error with the update request, or you do not have sufficient permissions to update this VPC endpoint configuration.
    
    See Also:
    
    AWS API Documentation
  - 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.

Interface AWSDeviceFarm

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

setEndpoint

setRegion

createDevicePool

createInstanceProfile

createNetworkProfile

createProject

createRemoteAccessSession

createTestGridProject

createTestGridUrl

createUpload

createVPCEConfiguration

deleteDevicePool

deleteInstanceProfile

deleteNetworkProfile

deleteProject

deleteRemoteAccessSession

deleteRun

deleteTestGridProject

deleteUpload

deleteVPCEConfiguration

getAccountSettings

getDevice

getDeviceInstance

getDevicePool

getDevicePoolCompatibility

getInstanceProfile

getJob

getNetworkProfile

getOfferingStatus

getProject

getRemoteAccessSession

getRun

getSuite

getTest

getTestGridProject

getTestGridSession

getUpload

getVPCEConfiguration

installToRemoteAccessSession

listArtifacts

listDeviceInstances

listDevicePools

listDevices

listInstanceProfiles

listJobs

listNetworkProfiles

listOfferingPromotions

listOfferingTransactions

listOfferings

listProjects

listRemoteAccessSessions

listRuns

listSamples

listSuites

listTagsForResource

listTestGridProjects

listTestGridSessionActions

listTestGridSessionArtifacts

listTestGridSessions

listTests

listUniqueProblems

listUploads

listVPCEConfigurations

purchaseOffering

renewOffering

scheduleRun

stopJob

stopRemoteAccessSession

stopRun

tagResource

untagResource

updateDeviceInstance

updateDevicePool

updateInstanceProfile