baiji v0.6.7 Baiji.DeviceFarm

AWS Device Farm is a service that enables mobile app developers to test Android, iOS, and Fire OS apps on physical phones, tablets, and other devices in the cloud.

Link to this section Summary

Functions

Returns a map containing the input/output shapes for this endpoint

Outputs values common to all actions

Specifies and starts a remote access session

Uploads an app or test scripts

Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system

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 an upload given the upload ARN

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

Gets information about a unique device type

Gets information about a device pool

Gets information about compatibility with a device pool

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. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation

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

Gets information about an upload

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

Gets information about device pools

Gets information about unique device types

Gets information about jobs

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 believe that you should 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. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation

Returns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the frequency for that offering. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation

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 project ARN

Gets information about suites

Gets information about tests

Gets information about unique problems

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

Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation

Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation

Ends a specified remote access session

Initiates a stop request for the current test run. AWS Device Farm will immediately stop the run on devices where tests have not started executing, and you will not be billed for these devices. On devices where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on those devices. You will be billed for Setup, Teardown, and any tests that were in progress or already completed

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 the network profile with specific settings

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

Link to this section Functions

Returns a map containing the input/output shapes for this endpoint

Outputs values common to all actions

Link to this function create_device_pool(input \\ %{}, options \\ [])

Creates a device pool.

Link to this function create_network_profile(input \\ %{}, options \\ [])

Creates a network profile.

Link to this function create_project(input \\ %{}, options \\ [])

Creates a new project.

Link to this function create_remote_access_session(input \\ %{}, options \\ [])

Specifies and starts a remote access session.

Link to this function create_upload(input \\ %{}, options \\ [])

Uploads an app or test scripts.

Link to this function delete_device_pool(input \\ %{}, options \\ [])

Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.

Link to this function delete_network_profile(input \\ %{}, options \\ [])

Deletes a network profile.

Link to this function delete_project(input \\ %{}, options \\ [])

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

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

Link to this function delete_remote_access_session(input \\ %{}, options \\ [])

Deletes a completed remote access session and its results.

Link to this function delete_run(input \\ %{}, options \\ [])

Deletes the run, given the run ARN.

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

Link to this function delete_upload(input \\ %{}, options \\ [])

Deletes an upload given the upload ARN.

Link to this function get_account_settings(input \\ %{}, options \\ [])

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

Link to this function get_device(input \\ %{}, options \\ [])

Gets information about a unique device type.

Link to this function get_device_pool(input \\ %{}, options \\ [])

Gets information about a device pool.

Link to this function get_device_pool_compatibility(input \\ %{}, options \\ [])

Gets information about compatibility with a device pool.

Link to this function get_job(input \\ %{}, options \\ [])

Gets information about a job.

Link to this function get_network_profile(input \\ %{}, options \\ [])

Returns information about a network profile.

Link to this function get_offering_status(input \\ %{}, options \\ [])

Gets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and the offerings that will be available in the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

Link to this function get_project(input \\ %{}, options \\ [])

Gets information about a project.

Link to this function get_remote_access_session(input \\ %{}, options \\ [])

Returns a link to a currently running remote access session.

Link to this function get_run(input \\ %{}, options \\ [])

Gets information about a run.

Link to this function get_suite(input \\ %{}, options \\ [])

Gets information about a suite.

Link to this function get_test(input \\ %{}, options \\ [])

Gets information about a test.

Link to this function get_upload(input \\ %{}, options \\ [])

Gets information about an upload.

Link to this function install_to_remote_access_session(input \\ %{}, options \\ [])

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(input \\ %{}, options \\ [])

Gets information about artifacts.

Link to this function list_device_pools(input \\ %{}, options \\ [])

Gets information about device pools.

Link to this function list_devices(input \\ %{}, options \\ [])

Gets information about unique device types.

Link to this function list_jobs(input \\ %{}, options \\ [])

Gets information about jobs.

Link to this function list_network_profiles(input \\ %{}, options \\ [])

Returns the list of available network profiles.

Link to this function list_offering_promotions(input \\ %{}, options \\ [])

Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a NotEligible error if the caller is not permitted to invoke the operation. Contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

Link to this function list_offering_transactions(input \\ %{}, options \\ [])

Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account. The list is paginated and ordered by a descending timestamp (most recent transactions are first). The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

Link to this function list_offerings(input \\ %{}, options \\ [])

Returns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the frequency for that offering. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

Link to this function list_projects(input \\ %{}, options \\ [])

Gets information about projects.

Link to this function list_remote_access_sessions(input \\ %{}, options \\ [])

Returns a list of all currently running remote access sessions.

Link to this function list_runs(input \\ %{}, options \\ [])

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

Link to this function list_samples(input \\ %{}, options \\ [])

Gets information about samples, given an AWS Device Farm project ARN

Link to this function list_suites(input \\ %{}, options \\ [])

Gets information about suites.

Link to this function list_tests(input \\ %{}, options \\ [])

Gets information about tests.

Link to this function list_unique_problems(input \\ %{}, options \\ [])

Gets information about unique problems.

Link to this function list_uploads(input \\ %{}, options \\ [])

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

Link to this function purchase_offering(input \\ %{}, options \\ [])

Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

Link to this function renew_offering(input \\ %{}, options \\ [])

Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

Link to this function schedule_run(input \\ %{}, options \\ [])

Schedules a run.

Link to this function stop_remote_access_session(input \\ %{}, options \\ [])

Ends a specified remote access session.

Link to this function stop_run(input \\ %{}, options \\ [])

Initiates a stop request for the current test run. AWS Device Farm will immediately stop the run on devices where tests have not started executing, and you will not be billed for these devices. On devices where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on those devices. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.

Link to this function update_device_pool(input \\ %{}, options \\ [])

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_network_profile(input \\ %{}, options \\ [])

Updates the network profile with specific settings.

Link to this function update_project(input \\ %{}, options \\ [])

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