aws_device_farm

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.

Summary

Functions

• create_device_pool(Client, Input)
  Creates a device pool.
• create_device_pool(Client, Input, Options)
• create_instance_profile(Client, Input)
  Creates a profile that can be applied to one or more private fleet device instances.
• create_instance_profile(Client, Input, Options)
• create_network_profile(Client, Input)
  Creates a network profile.
• create_network_profile(Client, Input, Options)
• create_project(Client, Input)
  Creates a project.
• create_project(Client, Input, Options)
• create_remote_access_session(Client, Input)
  Specifies and starts a remote access session.
• create_remote_access_session(Client, Input, Options)
• create_test_grid_project(Client, Input)
  Creates a Selenium testing project.
• create_test_grid_project(Client, Input, Options)
• create_test_grid_url(Client, Input)
  Creates a signed, short-term URL that can be passed to a Selenium RemoteWebDriver constructor.
• create_test_grid_url(Client, Input, Options)
• create_upload(Client, Input)
  Uploads an app or test scripts.
• create_upload(Client, Input, Options)
• create_v_p_c_e_configuration(Client, Input)
  Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.
• create_v_p_c_e_configuration(Client, Input, Options)
• delete_device_pool(Client, Input)
  Deletes a device pool given the pool ARN.
• delete_device_pool(Client, Input, Options)
• delete_instance_profile(Client, Input)
  Deletes a profile that can be applied to one or more private device instances.
• delete_instance_profile(Client, Input, Options)
• delete_network_profile(Client, Input)
  Deletes a network profile.
• delete_network_profile(Client, Input, Options)
• delete_project(Client, Input)
  Deletes an AWS Device Farm project, given the project ARN.
• delete_project(Client, Input, Options)
• delete_remote_access_session(Client, Input)
  Deletes a completed remote access session and its results.
• delete_remote_access_session(Client, Input, Options)
• delete_run(Client, Input)
  Deletes the run, given the run ARN.
• delete_run(Client, Input, Options)
• delete_test_grid_project(Client, Input)
  Deletes a Selenium testing project and all content generated under it.
• delete_test_grid_project(Client, Input, Options)
• delete_upload(Client, Input)
  Deletes an upload given the upload ARN.
• delete_upload(Client, Input, Options)
• delete_v_p_c_e_configuration(Client, Input)
  Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.
• delete_v_p_c_e_configuration(Client, Input, Options)
• get_account_settings(Client, Input)
  Returns the number of unmetered iOS or unmetered Android devices that have been purchased by the account.
• get_account_settings(Client, Input, Options)
• get_device(Client, Input)
  Gets information about a unique device type.
• get_device(Client, Input, Options)
• get_device_instance(Client, Input)
  Returns information about a device instance that belongs to a private device fleet.
• get_device_instance(Client, Input, Options)
• get_device_pool(Client, Input)
  Gets information about a device pool.
• get_device_pool(Client, Input, Options)
• get_device_pool_compatibility(Client, Input)
  Gets information about compatibility with a device pool.
• get_device_pool_compatibility(Client, Input, Options)
• get_instance_profile(Client, Input)
  Returns information about the specified instance profile.
• get_instance_profile(Client, Input, Options)
• get_job(Client, Input)
  Gets information about a job.
• get_job(Client, Input, Options)
• get_network_profile(Client, Input)
  Returns information about a network profile.
• get_network_profile(Client, Input, Options)
• get_offering_status(Client, Input)
  Gets the current status and future status of all offerings purchased by an AWS account.
• get_offering_status(Client, Input, Options)
• get_project(Client, Input)
  Gets information about a project.
• get_project(Client, Input, Options)
• get_remote_access_session(Client, Input)
  Returns a link to a currently running remote access session.
• get_remote_access_session(Client, Input, Options)
• get_run(Client, Input)
  Gets information about a run.
• get_run(Client, Input, Options)
• get_suite(Client, Input)
  Gets information about a suite.
• get_suite(Client, Input, Options)
• get_test(Client, Input)
  Gets information about a test.
• get_test(Client, Input, Options)
• get_test_grid_project(Client, Input)
  Retrieves information about a Selenium testing project.
• get_test_grid_project(Client, Input, Options)
• get_test_grid_session(Client, Input)
  A session is an instance of a browser created through a RemoteWebDriver with the URL from CreateTestGridUrlResult$url.
• get_test_grid_session(Client, Input, Options)
• get_upload(Client, Input)
  Gets information about an upload.
• get_upload(Client, Input, Options)
• get_v_p_c_e_configuration(Client, Input)
  Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.
• get_v_p_c_e_configuration(Client, Input, Options)
• install_to_remote_access_session(Client, Input)
  Installs an application to the device in a remote access session.
• install_to_remote_access_session(Client, Input, Options)
• list_artifacts(Client, Input)
  Gets information about artifacts.
• list_artifacts(Client, Input, Options)
• list_device_instances(Client, Input)
  Returns information about the private device instances associated with one or more AWS accounts.
• list_device_instances(Client, Input, Options)
• list_device_pools(Client, Input)
  Gets information about device pools.
• list_device_pools(Client, Input, Options)
• list_devices(Client, Input)
  Gets information about unique device types.
• list_devices(Client, Input, Options)
• list_instance_profiles(Client, Input)
  Returns information about all the instance profiles in an AWS account.
• list_instance_profiles(Client, Input, Options)
• list_jobs(Client, Input)
  Gets information about jobs for a given test run.
• list_jobs(Client, Input, Options)
• list_network_profiles(Client, Input)
  Returns the list of available network profiles.
• list_network_profiles(Client, Input, Options)
• list_offering_promotions(Client, Input)
  Returns a list of offering promotions.
• list_offering_promotions(Client, Input, Options)
• list_offering_transactions(Client, Input)
  Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account.
• list_offering_transactions(Client, Input, Options)
• list_offerings(Client, Input)
  Returns a list of products or offerings that the user can manage through the API.
• list_offerings(Client, Input, Options)
• list_projects(Client, Input)
  Gets information about projects.
• list_projects(Client, Input, Options)
• list_remote_access_sessions(Client, Input)
  Returns a list of all currently running remote access sessions.
• list_remote_access_sessions(Client, Input, Options)
• list_runs(Client, Input)
  Gets information about runs, given an AWS Device Farm project ARN.
• list_runs(Client, Input, Options)
• list_samples(Client, Input)
  Gets information about samples, given an AWS Device Farm job ARN.
• list_samples(Client, Input, Options)
• list_suites(Client, Input)
  Gets information about test suites for a given job.
• list_suites(Client, Input, Options)
• list_tags_for_resource(Client, Input)
  List the tags for an AWS Device Farm resource.
• list_tags_for_resource(Client, Input, Options)
• list_test_grid_projects(Client, Input)
  Gets a list of all Selenium testing projects in your account.
• list_test_grid_projects(Client, Input, Options)
• list_test_grid_session_actions(Client, Input)
  Returns a list of the actions taken in a TestGridSession.
• list_test_grid_session_actions(Client, Input, Options)
• list_test_grid_session_artifacts(Client, Input)
  Retrieves a list of artifacts created during the session.
• list_test_grid_session_artifacts(Client, Input, Options)
• list_test_grid_sessions(Client, Input)
  Retrieves a list of sessions for a TestGridProject.
• list_test_grid_sessions(Client, Input, Options)
• list_tests(Client, Input)
  Gets information about tests in a given test suite.
• list_tests(Client, Input, Options)
• list_unique_problems(Client, Input)
  Gets information about unique problems, such as exceptions or crashes.
• list_unique_problems(Client, Input, Options)
• list_uploads(Client, Input)
  Gets information about uploads, given an AWS Device Farm project ARN.
• list_uploads(Client, Input, Options)
• list_v_p_c_e_configurations(Client, Input)
  Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.
• list_v_p_c_e_configurations(Client, Input, Options)
• purchase_offering(Client, Input)
  Immediately purchases offerings for an AWS account.
• purchase_offering(Client, Input, Options)
• renew_offering(Client, Input)
  Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period.
• renew_offering(Client, Input, Options)
• schedule_run(Client, Input)
  Schedules a run.
• schedule_run(Client, Input, Options)
• stop_job(Client, Input)
  Initiates a stop request for the current job.
• stop_job(Client, Input, Options)
• stop_remote_access_session(Client, Input)
  Ends a specified remote access session.
• stop_remote_access_session(Client, Input, Options)
• stop_run(Client, Input)
  Initiates a stop request for the current test run.
• stop_run(Client, Input, Options)
• tag_resource(Client, Input)
  Associates the specified tags to a resource with the specified resourceArn.
• tag_resource(Client, Input, Options)
• untag_resource(Client, Input)
  Deletes the specified tags from a resource.
• untag_resource(Client, Input, Options)
• update_device_instance(Client, Input)
  Updates information about a private device instance.
• update_device_instance(Client, Input, Options)
• update_device_pool(Client, Input)
  Modifies the name, description, and rules in a device pool given the attributes and the pool ARN.
• update_device_pool(Client, Input, Options)
• update_instance_profile(Client, Input)
  Updates information about an existing private device instance profile.
• update_instance_profile(Client, Input, Options)
• update_network_profile(Client, Input)
  Updates the network profile.
• update_network_profile(Client, Input, Options)
• update_project(Client, Input)
  Modifies the specified project name, given the project ARN and a new name.
• update_project(Client, Input, Options)
• update_test_grid_project(Client, Input)
  Change details of a project.
• update_test_grid_project(Client, Input, Options)
• update_upload(Client, Input)
  Updates an uploaded test spec.
• update_upload(Client, Input, Options)
• update_v_p_c_e_configuration(Client, Input)
  Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.
• update_v_p_c_e_configuration(Client, Input, Options)

Functions

Creates a device pool.

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

Creates a network profile.

Creates a project.

Specifies and starts a remote access session.

Creates a Selenium testing project. Projects are used to track TestGridSession instances.

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. Does not allow deletion of curated pools owned by the system.

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

Deletes a network profile.

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

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

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. For Android applications, the file must be in .apk format. For iOS applications, the file must be in .ipa format.

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

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.

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.

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

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.

Schedules a run.

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.

Ends a specified remote access session.

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.

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.

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. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all).

Updates information about an existing private device instance profile.

Updates the network profile.

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

Change details of a project.

Updates an uploaded test spec.

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