AWS.DeviceFarm (aws-elixir v0.8.0) View Source

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.

Link to this section Summary

Functions

Creates a profile that can be applied to one or more private fleet device instances.

Specifies and starts a remote access session.

Creates a Selenium testing project.

Creates a signed, short-term URL that can be passed to a Selenium RemoteWebDriver constructor.

Uploads an app or test scripts.

Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.

Deletes a device pool given the pool ARN.

Deletes a profile that can be applied to one or more private device instances.

Deletes an AWS Device Farm project, given the project ARN.

Deletes a completed remote access session and its results.

Deletes the run, given the run ARN.

Deletes a Selenium testing project and all content generated under it.

Deletes an upload given the upload ARN.

Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.

Returns the number of unmetered iOS or unmetered Android devices that have been purchased by the account.

Gets information about a unique device type.

Returns information about a device instance that belongs to a private device fleet.

Gets information about a device pool.

Gets information about compatibility with a device pool.

Returns information about the specified instance profile.

Gets information about a job.

Returns information about a network profile.

Gets the current status and future status of all offerings purchased by an AWS account.

Gets information about a project.

Returns a link to a currently running remote access session.

Gets information about a run.

Gets information about a suite.

Gets information about a test.

Retrieves information about a Selenium testing project.

A session is an instance of a browser created through a RemoteWebDriver with the URL from CreateTestGridUrlResult$url.

Gets information about an upload.

Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.

Installs an application to the device in a remote access session.

Gets information about artifacts.

Returns information about the private device instances associated with one or more AWS accounts.

Gets information about device pools.

Gets information about unique device types.

Returns information about all the instance profiles in an AWS account.

Gets information about jobs for a given test run.

Returns the list of available network profiles.

Returns a list of offering promotions.

Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account.

Returns a list of products or offerings that the user can manage through the API.

Gets information about projects.

Returns a list of all currently running remote access sessions.

Gets information about runs, given an AWS Device Farm project ARN.

Gets information about samples, given an AWS Device Farm job ARN.

Gets information about test suites for a given job.

List the tags for an AWS Device Farm resource.

Gets a list of all Selenium testing projects in your account.

Returns a list of the actions taken in a TestGridSession.

Retrieves a list of artifacts created during the session.

Retrieves a list of sessions for a TestGridProject.

Gets information about tests in a given test suite.

Gets information about unique problems, such as exceptions or crashes.

Gets information about uploads, given an AWS Device Farm project ARN.

Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.

Immediately purchases offerings for an AWS account.

Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period.

Initiates a stop request for the current job.

Ends a specified remote access session.

Initiates a stop request for the current test run.

Associates the specified tags to a resource with the specified resourceArn.

Deletes the specified tags from a resource.

Updates information about a private device instance.

Modifies the name, description, and rules in a device pool given the attributes and the pool ARN.

Updates information about an existing private device instance profile.

Modifies the specified project name, given the project ARN and a new name.

Updates an uploaded test spec.

Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.

Link to this section Functions

Link to this function

create_device_pool(client, input, options \\ [])

View Source

Creates a device pool.

Link to this function

create_instance_profile(client, input, options \\ [])

View Source

Creates a profile that can be applied to one or more private fleet device instances.

Link to this function

create_network_profile(client, input, options \\ [])

View Source

Creates a network profile.

Link to this function

create_project(client, input, options \\ [])

View Source

Creates a project.

Link to this function

create_remote_access_session(client, input, options \\ [])

View Source

Specifies and starts a remote access session.

Link to this function

create_test_grid_project(client, input, options \\ [])

View Source

Creates a Selenium testing project.

Projects are used to track TestGridSession instances.

Link to this function

create_test_grid_url(client, input, options \\ [])

View Source

Creates a signed, short-term URL that can be passed to a Selenium RemoteWebDriver constructor.

Link to this function

create_upload(client, input, options \\ [])

View Source

Uploads an app or test scripts.

Link to this function

create_vpce_configuration(client, input, options \\ [])

View Source

Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.

Link to this function

delete_device_pool(client, input, options \\ [])

View Source

Deletes a device pool given the pool ARN.

Does not allow deletion of curated pools owned by the system.

Link to this function

delete_instance_profile(client, input, options \\ [])

View Source

Deletes a profile that can be applied to one or more private device instances.

Link to this function

delete_network_profile(client, input, options \\ [])

View Source

Deletes a network profile.

Link to this function

delete_project(client, input, options \\ [])

View Source

Deletes an AWS Device Farm project, given the project ARN.

Deleting this resource does not stop an in-progress run.

Link to this function

delete_remote_access_session(client, input, options \\ [])

View Source

Deletes a completed remote access session and its results.

Link to this function

delete_run(client, input, options \\ [])

View Source

Deletes the run, given the run ARN.

Deleting this resource does not stop an in-progress run.

Link to this function

delete_test_grid_project(client, input, options \\ [])

View Source

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.

Link to this function

delete_upload(client, input, options \\ [])

View Source

Deletes an upload given the upload ARN.

Link to this function

delete_vpce_configuration(client, input, options \\ [])

View Source

Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.

Link to this function

get_account_settings(client, input, options \\ [])

View Source

Returns the number of unmetered iOS or unmetered Android devices that have been purchased by the account.

Link to this function

get_device(client, input, options \\ [])

View Source

Gets information about a unique device type.

Link to this function

get_device_instance(client, input, options \\ [])

View Source

Returns information about a device instance that belongs to a private device fleet.

Link to this function

get_device_pool(client, input, options \\ [])

View Source

Gets information about a device pool.

Link to this function

get_device_pool_compatibility(client, input, options \\ [])

View Source

Gets information about compatibility with a device pool.

Link to this function

get_instance_profile(client, input, options \\ [])

View Source

Returns information about the specified instance profile.

Link to this function

get_job(client, input, options \\ [])

View Source

Gets information about a job.

Link to this function

get_network_profile(client, input, options \\ [])

View Source

Returns information about a network profile.

Link to this function

get_offering_status(client, input, options \\ [])

View Source

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 aws-devicefarm-support@amazon.com.

Link to this function

get_project(client, input, options \\ [])

View Source

Gets information about a project.

Link to this function

get_remote_access_session(client, input, options \\ [])

View Source

Returns a link to a currently running remote access session.

Link to this function

get_run(client, input, options \\ [])

View Source

Gets information about a run.

Link to this function

get_suite(client, input, options \\ [])

View Source

Gets information about a suite.

Link to this function

get_test(client, input, options \\ [])

View Source

Gets information about a test.

Link to this function

get_test_grid_project(client, input, options \\ [])

View Source

Retrieves information about a Selenium testing project.

Link to this function

get_test_grid_session(client, input, options \\ [])

View Source

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).

Link to this function

get_upload(client, input, options \\ [])

View Source

Gets information about an upload.

Link to this function

get_vpce_configuration(client, input, options \\ [])

View Source

Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.

Link to this function

install_to_remote_access_session(client, input, options \\ [])

View Source

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.

Link to this function

list_artifacts(client, input, options \\ [])

View Source

Gets information about artifacts.

Link to this function

list_device_instances(client, input, options \\ [])

View Source

Returns information about the private device instances associated with one or more AWS accounts.

Link to this function

list_device_pools(client, input, options \\ [])

View Source

Gets information about device pools.

Link to this function

list_devices(client, input, options \\ [])

View Source

Gets information about unique device types.

Link to this function

list_instance_profiles(client, input, options \\ [])

View Source

Returns information about all the instance profiles in an AWS account.

Link to this function

list_jobs(client, input, options \\ [])

View Source

Gets information about jobs for a given test run.

Link to this function

list_network_profiles(client, input, options \\ [])

View Source

Returns the list of available network profiles.

Link to this function

list_offering_promotions(client, input, options \\ [])

View Source

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 must be able to invoke this operation.

Link to this function

list_offering_transactions(client, input, options \\ [])

View Source

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 aws-devicefarm-support@amazon.com.

Link to this function

list_offerings(client, input, options \\ [])

View Source

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 aws-devicefarm-support@amazon.com.

Link to this function

list_projects(client, input, options \\ [])

View Source

Gets information about projects.

Link to this function

list_remote_access_sessions(client, input, options \\ [])

View Source

Returns a list of all currently running remote access sessions.

Link to this function

list_runs(client, input, options \\ [])

View Source

Gets information about runs, given an AWS Device Farm project ARN.

Link to this function

list_samples(client, input, options \\ [])

View Source

Gets information about samples, given an AWS Device Farm job ARN.

Link to this function

list_suites(client, input, options \\ [])

View Source

Gets information about test suites for a given job.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

List the tags for an AWS Device Farm resource.

Link to this function

list_test_grid_projects(client, input, options \\ [])

View Source

Gets a list of all Selenium testing projects in your account.

Link to this function

list_test_grid_session_actions(client, input, options \\ [])

View Source

Returns a list of the actions taken in a TestGridSession.

Link to this function

list_test_grid_session_artifacts(client, input, options \\ [])

View Source

Retrieves a list of artifacts created during the session.

Link to this function

list_test_grid_sessions(client, input, options \\ [])

View Source

Retrieves a list of sessions for a TestGridProject.

Link to this function

list_tests(client, input, options \\ [])

View Source

Gets information about tests in a given test suite.

Link to this function

list_unique_problems(client, input, options \\ [])

View Source

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.

Link to this function

list_uploads(client, input, options \\ [])

View Source

Gets information about uploads, given an AWS Device Farm project ARN.

Link to this function

list_vpce_configurations(client, input, options \\ [])

View Source

Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.

Link to this function

purchase_offering(client, input, options \\ [])

View Source

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 aws-devicefarm-support@amazon.com.

Link to this function

renew_offering(client, input, options \\ [])

View Source

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 aws-devicefarm-support@amazon.com.

Link to this function

schedule_run(client, input, options \\ [])

View Source

Schedules a run.

Link to this function

stop_job(client, input, options \\ [])

View Source

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.

Link to this function

stop_remote_access_session(client, input, options \\ [])

View Source

Ends a specified remote access session.

Link to this function

stop_run(client, input, options \\ [])

View Source

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.

Link to this function

tag_resource(client, input, options \\ [])

View Source

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.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Deletes the specified tags from a resource.

Link to this function

update_device_instance(client, input, options \\ [])

View Source

Updates information about a private device instance.

Link to this function

update_device_pool(client, input, options \\ [])

View Source

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).

Link to this function

update_instance_profile(client, input, options \\ [])

View Source

Updates information about an existing private device instance profile.

Link to this function

update_network_profile(client, input, options \\ [])

View Source

Updates the network profile.

Link to this function

update_project(client, input, options \\ [])

View Source

Modifies the specified project name, given the project ARN and a new name.

Link to this function

update_test_grid_project(client, input, options \\ [])

View Source

Change details of a project.

Link to this function

update_upload(client, input, options \\ [])

View Source

Updates an uploaded test spec.

Link to this function

update_vpce_configuration(client, input, options \\ [])

View Source

Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.