Class: Aws::DeviceFarm::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::DeviceFarm::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb
Overview
An API client for DeviceFarm. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::DeviceFarm::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_device_pool(params = {}) ⇒ Types::CreateDevicePoolResult
Creates a device pool.
-
#create_instance_profile(params = {}) ⇒ Types::CreateInstanceProfileResult
Creates a profile that can be applied to one or more private fleet device instances.
-
#create_network_profile(params = {}) ⇒ Types::CreateNetworkProfileResult
Creates a network profile.
-
#create_project(params = {}) ⇒ Types::CreateProjectResult
Creates a project.
-
#create_remote_access_session(params = {}) ⇒ Types::CreateRemoteAccessSessionResult
Specifies and starts a remote access session.
-
#create_test_grid_project(params = {}) ⇒ Types::CreateTestGridProjectResult
Creates a Selenium testing project.
-
#create_test_grid_url(params = {}) ⇒ Types::CreateTestGridUrlResult
Creates a signed, short-term URL that can be passed to a Selenium
RemoteWebDriver
constructor. -
#create_upload(params = {}) ⇒ Types::CreateUploadResult
Uploads an app or test scripts.
-
#create_vpce_configuration(params = {}) ⇒ Types::CreateVPCEConfigurationResult
Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.
-
#delete_device_pool(params = {}) ⇒ Struct
Deletes a device pool given the pool ARN.
-
#delete_instance_profile(params = {}) ⇒ Struct
Deletes a profile that can be applied to one or more private device instances.
-
#delete_network_profile(params = {}) ⇒ Struct
Deletes a network profile.
-
#delete_project(params = {}) ⇒ Struct
Deletes an AWS Device Farm project, given the project ARN.
-
#delete_remote_access_session(params = {}) ⇒ Struct
Deletes a completed remote access session and its results.
-
#delete_run(params = {}) ⇒ Struct
Deletes the run, given the run ARN.
-
#delete_test_grid_project(params = {}) ⇒ Struct
Deletes a Selenium testing project and all content generated under it.
-
#delete_upload(params = {}) ⇒ Struct
Deletes an upload given the upload ARN.
-
#delete_vpce_configuration(params = {}) ⇒ Struct
Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.
-
#get_account_settings(params = {}) ⇒ Types::GetAccountSettingsResult
Returns the number of unmetered iOS or unmetered Android devices that have been purchased by the account.
-
#get_device(params = {}) ⇒ Types::GetDeviceResult
Gets information about a unique device type.
-
#get_device_instance(params = {}) ⇒ Types::GetDeviceInstanceResult
Returns information about a device instance that belongs to a private device fleet.
-
#get_device_pool(params = {}) ⇒ Types::GetDevicePoolResult
Gets information about a device pool.
-
#get_device_pool_compatibility(params = {}) ⇒ Types::GetDevicePoolCompatibilityResult
Gets information about compatibility with a device pool.
-
#get_instance_profile(params = {}) ⇒ Types::GetInstanceProfileResult
Returns information about the specified instance profile.
-
#get_job(params = {}) ⇒ Types::GetJobResult
Gets information about a job.
-
#get_network_profile(params = {}) ⇒ Types::GetNetworkProfileResult
Returns information about a network profile.
-
#get_offering_status(params = {}) ⇒ Types::GetOfferingStatusResult
Gets the current status and future status of all offerings purchased by an AWS account.
-
#get_project(params = {}) ⇒ Types::GetProjectResult
Gets information about a project.
-
#get_remote_access_session(params = {}) ⇒ Types::GetRemoteAccessSessionResult
Returns a link to a currently running remote access session.
-
#get_run(params = {}) ⇒ Types::GetRunResult
Gets information about a run.
-
#get_suite(params = {}) ⇒ Types::GetSuiteResult
Gets information about a suite.
-
#get_test(params = {}) ⇒ Types::GetTestResult
Gets information about a test.
-
#get_test_grid_project(params = {}) ⇒ Types::GetTestGridProjectResult
Retrieves information about a Selenium testing project.
-
#get_test_grid_session(params = {}) ⇒ Types::GetTestGridSessionResult
A session is an instance of a browser created through a
RemoteWebDriver
with the URL from CreateTestGridUrlResult$url. -
#get_upload(params = {}) ⇒ Types::GetUploadResult
Gets information about an upload.
-
#get_vpce_configuration(params = {}) ⇒ Types::GetVPCEConfigurationResult
Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.
-
#install_to_remote_access_session(params = {}) ⇒ Types::InstallToRemoteAccessSessionResult
Installs an application to the device in a remote access session.
-
#list_artifacts(params = {}) ⇒ Types::ListArtifactsResult
Gets information about artifacts.
-
#list_device_instances(params = {}) ⇒ Types::ListDeviceInstancesResult
Returns information about the private device instances associated with one or more AWS accounts.
-
#list_device_pools(params = {}) ⇒ Types::ListDevicePoolsResult
Gets information about device pools.
-
#list_devices(params = {}) ⇒ Types::ListDevicesResult
Gets information about unique device types.
-
#list_instance_profiles(params = {}) ⇒ Types::ListInstanceProfilesResult
Returns information about all the instance profiles in an AWS account.
-
#list_jobs(params = {}) ⇒ Types::ListJobsResult
Gets information about jobs for a given test run.
-
#list_network_profiles(params = {}) ⇒ Types::ListNetworkProfilesResult
Returns the list of available network profiles.
-
#list_offering_promotions(params = {}) ⇒ Types::ListOfferingPromotionsResult
Returns a list of offering promotions.
-
#list_offering_transactions(params = {}) ⇒ Types::ListOfferingTransactionsResult
Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account.
-
#list_offerings(params = {}) ⇒ Types::ListOfferingsResult
Returns a list of products or offerings that the user can manage through the API.
-
#list_projects(params = {}) ⇒ Types::ListProjectsResult
Gets information about projects.
-
#list_remote_access_sessions(params = {}) ⇒ Types::ListRemoteAccessSessionsResult
Returns a list of all currently running remote access sessions.
-
#list_runs(params = {}) ⇒ Types::ListRunsResult
Gets information about runs, given an AWS Device Farm project ARN.
-
#list_samples(params = {}) ⇒ Types::ListSamplesResult
Gets information about samples, given an AWS Device Farm job ARN.
-
#list_suites(params = {}) ⇒ Types::ListSuitesResult
Gets information about test suites for a given job.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List the tags for an AWS Device Farm resource.
-
#list_test_grid_projects(params = {}) ⇒ Types::ListTestGridProjectsResult
Gets a list of all Selenium testing projects in your account.
-
#list_test_grid_session_actions(params = {}) ⇒ Types::ListTestGridSessionActionsResult
Returns a list of the actions taken in a TestGridSession.
-
#list_test_grid_session_artifacts(params = {}) ⇒ Types::ListTestGridSessionArtifactsResult
Retrieves a list of artifacts created during the session.
-
#list_test_grid_sessions(params = {}) ⇒ Types::ListTestGridSessionsResult
Retrieves a list of sessions for a TestGridProject.
-
#list_tests(params = {}) ⇒ Types::ListTestsResult
Gets information about tests in a given test suite.
-
#list_unique_problems(params = {}) ⇒ Types::ListUniqueProblemsResult
Gets information about unique problems, such as exceptions or crashes.
-
#list_uploads(params = {}) ⇒ Types::ListUploadsResult
Gets information about uploads, given an AWS Device Farm project ARN.
-
#list_vpce_configurations(params = {}) ⇒ Types::ListVPCEConfigurationsResult
Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.
-
#purchase_offering(params = {}) ⇒ Types::PurchaseOfferingResult
Immediately purchases offerings for an AWS account.
-
#renew_offering(params = {}) ⇒ Types::RenewOfferingResult
Explicitly sets the quantity of devices to renew for an offering, starting from the
effectiveDate
of the next period. -
#schedule_run(params = {}) ⇒ Types::ScheduleRunResult
Schedules a run.
-
#stop_job(params = {}) ⇒ Types::StopJobResult
Initiates a stop request for the current job.
-
#stop_remote_access_session(params = {}) ⇒ Types::StopRemoteAccessSessionResult
Ends a specified remote access session.
-
#stop_run(params = {}) ⇒ Types::StopRunResult
Initiates a stop request for the current test run.
-
#tag_resource(params = {}) ⇒ Struct
Associates the specified tags to a resource with the specified
resourceArn
. -
#untag_resource(params = {}) ⇒ Struct
Deletes the specified tags from a resource.
-
#update_device_instance(params = {}) ⇒ Types::UpdateDeviceInstanceResult
Updates information about a private device instance.
-
#update_device_pool(params = {}) ⇒ Types::UpdateDevicePoolResult
Modifies the name, description, and rules in a device pool given the attributes and the pool ARN.
-
#update_instance_profile(params = {}) ⇒ Types::UpdateInstanceProfileResult
Updates information about an existing private device instance profile.
-
#update_network_profile(params = {}) ⇒ Types::UpdateNetworkProfileResult
Updates the network profile.
-
#update_project(params = {}) ⇒ Types::UpdateProjectResult
Modifies the specified project name, given the project ARN and a new name.
-
#update_test_grid_project(params = {}) ⇒ Types::UpdateTestGridProjectResult
Change details of a project.
-
#update_upload(params = {}) ⇒ Types::UpdateUploadResult
Updates an uploaded test spec.
-
#update_vpce_configuration(params = {}) ⇒ Types::UpdateVPCEConfigurationResult
Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
480 481 482 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 480 def initialize(*args) super end |
Instance Method Details
#create_device_pool(params = {}) ⇒ Types::CreateDevicePoolResult
Creates a device pool.
565 566 567 568 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 565 def create_device_pool(params = {}, = {}) req = build_request(:create_device_pool, params) req.send_request() end |
#create_instance_profile(params = {}) ⇒ Types::CreateInstanceProfileResult
Creates a profile that can be applied to one or more private fleet device instances.
622 623 624 625 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 622 def create_instance_profile(params = {}, = {}) req = build_request(:create_instance_profile, params) req.send_request() end |
#create_network_profile(params = {}) ⇒ Types::CreateNetworkProfileResult
Creates a network profile.
714 715 716 717 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 714 def create_network_profile(params = {}, = {}) req = build_request(:create_network_profile, params) req.send_request() end |
#create_project(params = {}) ⇒ Types::CreateProjectResult
Creates a project.
782 783 784 785 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 782 def create_project(params = {}, = {}) req = build_request(:create_project, params) req.send_request() end |
#create_remote_access_session(params = {}) ⇒ Types::CreateRemoteAccessSessionResult
Specifies and starts a remote access session.
1003 1004 1005 1006 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1003 def create_remote_access_session(params = {}, = {}) req = build_request(:create_remote_access_session, params) req.send_request() end |
#create_test_grid_project(params = {}) ⇒ Types::CreateTestGridProjectResult
Creates a Selenium testing project. Projects are used to track TestGridSession instances.
1052 1053 1054 1055 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1052 def create_test_grid_project(params = {}, = {}) req = build_request(:create_test_grid_project, params) req.send_request() end |
#create_test_grid_url(params = {}) ⇒ Types::CreateTestGridUrlResult
Creates a signed, short-term URL that can be passed to a Selenium
RemoteWebDriver
constructor.
1088 1089 1090 1091 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1088 def create_test_grid_url(params = {}, = {}) req = build_request(:create_test_grid_url, params) req.send_request() end |
#create_upload(params = {}) ⇒ Types::CreateUploadResult
Uploads an app or test scripts.
1227 1228 1229 1230 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1227 def create_upload(params = {}, = {}) req = build_request(:create_upload, params) req.send_request() end |
#create_vpce_configuration(params = {}) ⇒ Types::CreateVPCEConfigurationResult
Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.
1276 1277 1278 1279 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1276 def create_vpce_configuration(params = {}, = {}) req = build_request(:create_vpce_configuration, params) req.send_request() end |
#delete_device_pool(params = {}) ⇒ Struct
Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.
1313 1314 1315 1316 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1313 def delete_device_pool(params = {}, = {}) req = build_request(:delete_device_pool, params) req.send_request() end |
#delete_instance_profile(params = {}) ⇒ Struct
Deletes a profile that can be applied to one or more private device instances.
1337 1338 1339 1340 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1337 def delete_instance_profile(params = {}, = {}) req = build_request(:delete_instance_profile, params) req.send_request() end |
#delete_network_profile(params = {}) ⇒ Struct
Deletes a network profile.
1359 1360 1361 1362 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1359 def delete_network_profile(params = {}, = {}) req = build_request(:delete_network_profile, params) req.send_request() end |
#delete_project(params = {}) ⇒ Struct
Deletes an AWS Device Farm project, given the project ARN.
Deleting this resource does not stop an in-progress run.
1397 1398 1399 1400 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1397 def delete_project(params = {}, = {}) req = build_request(:delete_project, params) req.send_request() end |
#delete_remote_access_session(params = {}) ⇒ Struct
Deletes a completed remote access session and its results.
1433 1434 1435 1436 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1433 def delete_remote_access_session(params = {}, = {}) req = build_request(:delete_remote_access_session, params) req.send_request() end |
#delete_run(params = {}) ⇒ Struct
Deletes the run, given the run ARN.
Deleting this resource does not stop an in-progress run.
1470 1471 1472 1473 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1470 def delete_run(params = {}, = {}) req = build_request(:delete_run, params) req.send_request() end |
#delete_test_grid_project(params = {}) ⇒ Struct
Deletes a Selenium testing project and all content generated under it.
You cannot undo this operation.
1499 1500 1501 1502 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1499 def delete_test_grid_project(params = {}, = {}) req = build_request(:delete_test_grid_project, params) req.send_request() end |
#delete_upload(params = {}) ⇒ Struct
Deletes an upload given the upload ARN.
1535 1536 1537 1538 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1535 def delete_upload(params = {}, = {}) req = build_request(:delete_upload, params) req.send_request() end |
#delete_vpce_configuration(params = {}) ⇒ Struct
Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.
1559 1560 1561 1562 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1559 def delete_vpce_configuration(params = {}, = {}) req = build_request(:delete_vpce_configuration, params) req.send_request() end |
#get_account_settings(params = {}) ⇒ Types::GetAccountSettingsResult
Returns the number of unmetered iOS or unmetered Android devices that have been purchased by the account.
1609 1610 1611 1612 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1609 def get_account_settings(params = {}, = {}) req = build_request(:get_account_settings, params) req.send_request() end |
#get_device(params = {}) ⇒ Types::GetDeviceResult
Gets information about a unique device type.
1707 1708 1709 1710 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1707 def get_device(params = {}, = {}) req = build_request(:get_device, params) req.send_request() end |
#get_device_instance(params = {}) ⇒ Types::GetDeviceInstanceResult
Returns information about a device instance that belongs to a private device fleet.
1749 1750 1751 1752 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1749 def get_device_instance(params = {}, = {}) req = build_request(:get_device_instance, params) req.send_request() end |
#get_device_pool(params = {}) ⇒ Types::GetDevicePoolResult
Gets information about a device pool.
1800 1801 1802 1803 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1800 def get_device_pool(params = {}, = {}) req = build_request(:get_device_pool, params) req.send_request() end |
#get_device_pool_compatibility(params = {}) ⇒ Types::GetDevicePoolCompatibilityResult
Gets information about compatibility with a device pool.
2016 2017 2018 2019 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2016 def get_device_pool_compatibility(params = {}, = {}) req = build_request(:get_device_pool_compatibility, params) req.send_request() end |
#get_instance_profile(params = {}) ⇒ Types::GetInstanceProfileResult
Returns information about the specified instance profile.
2050 2051 2052 2053 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2050 def get_instance_profile(params = {}, = {}) req = build_request(:get_instance_profile, params) req.send_request() end |
#get_job(params = {}) ⇒ Types::GetJobResult
Gets information about a job.
2151 2152 2153 2154 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2151 def get_job(params = {}, = {}) req = build_request(:get_job, params) req.send_request() end |
#get_network_profile(params = {}) ⇒ Types::GetNetworkProfileResult
Returns information about a network profile.
2190 2191 2192 2193 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2190 def get_network_profile(params = {}, = {}) req = build_request(:get_network_profile, params) req.send_request() end |
#get_offering_status(params = {}) ⇒ Types::GetOfferingStatusResult
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2290 2291 2292 2293 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2290 def get_offering_status(params = {}, = {}) req = build_request(:get_offering_status, params) req.send_request() end |
#get_project(params = {}) ⇒ Types::GetProjectResult
Gets information about a project.
2344 2345 2346 2347 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2344 def get_project(params = {}, = {}) req = build_request(:get_project, params) req.send_request() end |
#get_remote_access_session(params = {}) ⇒ Types::GetRemoteAccessSessionResult
Returns a link to a currently running remote access session.
2454 2455 2456 2457 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2454 def get_remote_access_session(params = {}, = {}) req = build_request(:get_remote_access_session, params) req.send_request() end |
#get_run(params = {}) ⇒ Types::GetRunResult
Gets information about a run.
2591 2592 2593 2594 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2591 def get_run(params = {}, = {}) req = build_request(:get_run, params) req.send_request() end |
#get_suite(params = {}) ⇒ Types::GetSuiteResult
Gets information about a suite.
2652 2653 2654 2655 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2652 def get_suite(params = {}, = {}) req = build_request(:get_suite, params) req.send_request() end |
#get_test(params = {}) ⇒ Types::GetTestResult
Gets information about a test.
2713 2714 2715 2716 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2713 def get_test(params = {}, = {}) req = build_request(:get_test, params) req.send_request() end |
#get_test_grid_project(params = {}) ⇒ Types::GetTestGridProjectResult
Retrieves information about a Selenium testing project.
2750 2751 2752 2753 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2750 def get_test_grid_project(params = {}, = {}) req = build_request(:get_test_grid_project, params) req.send_request() end |
#get_test_grid_session(params = {}) ⇒ Types::GetTestGridSessionResult
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).
2800 2801 2802 2803 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2800 def get_test_grid_session(params = {}, = {}) req = build_request(:get_test_grid_session, params) req.send_request() end |
#get_upload(params = {}) ⇒ Types::GetUploadResult
Gets information about an upload.
2852 2853 2854 2855 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2852 def get_upload(params = {}, = {}) req = build_request(:get_upload, params) req.send_request() end |
#get_vpce_configuration(params = {}) ⇒ Types::GetVPCEConfigurationResult
Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.
2886 2887 2888 2889 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2886 def get_vpce_configuration(params = {}, = {}) req = build_request(:get_vpce_configuration, params) req.send_request() end |
#install_to_remote_access_session(params = {}) ⇒ Types::InstallToRemoteAccessSessionResult
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.
2946 2947 2948 2949 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2946 def install_to_remote_access_session(params = {}, = {}) req = build_request(:install_to_remote_access_session, params) req.send_request() end |
#list_artifacts(params = {}) ⇒ Types::ListArtifactsResult
Gets information about artifacts.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3011 3012 3013 3014 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 3011 def list_artifacts(params = {}, = {}) req = build_request(:list_artifacts, params) req.send_request() end |
#list_device_instances(params = {}) ⇒ Types::ListDeviceInstancesResult
Returns information about the private device instances associated with one or more AWS accounts.
3062 3063 3064 3065 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 3062 def list_device_instances(params = {}, = {}) req = build_request(:list_device_instances, params) req.send_request() end |
#list_device_pools(params = {}) ⇒ Types::ListDevicePoolsResult
Gets information about device pools.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3161 3162 3163 3164 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 3161 def list_device_pools(params = {}, = {}) req = build_request(:list_device_pools, params) req.send_request() end |
#list_devices(params = {}) ⇒ Types::ListDevicesResult
Gets information about unique device types.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3325 3326 3327 3328 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 3325 def list_devices(params = {}, = {}) req = build_request(:list_devices, params) req.send_request() end |
#list_instance_profiles(params = {}) ⇒ Types::ListInstanceProfilesResult
Returns information about all the instance profiles in an AWS account.
3369 3370 3371 3372 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 3369 def list_instance_profiles(params = {}, = {}) req = build_request(:list_instance_profiles, params) req.send_request() end |
#list_jobs(params = {}) ⇒ Types::ListJobsResult
Gets information about jobs for a given test run.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3475 3476 3477 3478 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 3475 def list_jobs(params = {}, = {}) req = build_request(:list_jobs, params) req.send_request() end |
#list_network_profiles(params = {}) ⇒ Types::ListNetworkProfilesResult
Returns the list of available network profiles.
3529 3530 3531 3532 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 3529 def list_network_profiles(params = {}, = {}) req = build_request(:list_network_profiles, params) req.send_request() end |
#list_offering_promotions(params = {}) ⇒ Types::ListOfferingPromotionsResult
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.
3568 3569 3570 3571 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 3568 def list_offering_promotions(params = {}, = {}) req = build_request(:list_offering_promotions, params) req.send_request() end |
#list_offering_transactions(params = {}) ⇒ Types::ListOfferingTransactionsResult
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3715 3716 3717 3718 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 3715 def list_offering_transactions(params = {}, = {}) req = build_request(:list_offering_transactions, params) req.send_request() end |
#list_offerings(params = {}) ⇒ Types::ListOfferingsResult
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3837 3838 3839 3840 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 3837 def list_offerings(params = {}, = {}) req = build_request(:list_offerings, params) req.send_request() end |
#list_projects(params = {}) ⇒ Types::ListProjectsResult
Gets information about projects.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3912 3913 3914 3915 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 3912 def list_projects(params = {}, = {}) req = build_request(:list_projects, params) req.send_request() end |
#list_remote_access_sessions(params = {}) ⇒ Types::ListRemoteAccessSessionsResult
Returns a list of all currently running remote access sessions.
4032 4033 4034 4035 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 4032 def list_remote_access_sessions(params = {}, = {}) req = build_request(:list_remote_access_sessions, params) req.send_request() end |
#list_runs(params = {}) ⇒ Types::ListRunsResult
Gets information about runs, given an AWS Device Farm project ARN.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4184 4185 4186 4187 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 4184 def list_runs(params = {}, = {}) req = build_request(:list_runs, params) req.send_request() end |
#list_samples(params = {}) ⇒ Types::ListSamplesResult
Gets information about samples, given an AWS Device Farm job ARN.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4241 4242 4243 4244 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 4241 def list_samples(params = {}, = {}) req = build_request(:list_samples, params) req.send_request() end |
#list_suites(params = {}) ⇒ Types::ListSuitesResult
Gets information about test suites for a given job.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4314 4315 4316 4317 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 4314 def list_suites(params = {}, = {}) req = build_request(:list_suites, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List the tags for an AWS Device Farm resource.
4348 4349 4350 4351 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 4348 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_test_grid_projects(params = {}) ⇒ Types::ListTestGridProjectsResult
Gets a list of all Selenium testing projects in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4393 4394 4395 4396 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 4393 def list_test_grid_projects(params = {}, = {}) req = build_request(:list_test_grid_projects, params) req.send_request() end |
#list_test_grid_session_actions(params = {}) ⇒ Types::ListTestGridSessionActionsResult
Returns a list of the actions taken in a TestGridSession.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4438 4439 4440 4441 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 4438 def list_test_grid_session_actions(params = {}, = {}) req = build_request(:list_test_grid_session_actions, params) req.send_request() end |
#list_test_grid_session_artifacts(params = {}) ⇒ Types::ListTestGridSessionArtifactsResult
Retrieves a list of artifacts created during the session.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4485 4486 4487 4488 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 4485 def list_test_grid_session_artifacts(params = {}, = {}) req = build_request(:list_test_grid_session_artifacts, params) req.send_request() end |
#list_test_grid_sessions(params = {}) ⇒ Types::ListTestGridSessionsResult
Retrieves a list of sessions for a TestGridProject.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4551 4552 4553 4554 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 4551 def list_test_grid_sessions(params = {}, = {}) req = build_request(:list_test_grid_sessions, params) req.send_request() end |
#list_tests(params = {}) ⇒ Types::ListTestsResult
Gets information about tests in a given test suite.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4624 4625 4626 4627 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 4624 def list_tests(params = {}, = {}) req = build_request(:list_tests, params) req.send_request() end |
#list_unique_problems(params = {}) ⇒ Types::ListUniqueProblemsResult
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4734 4735 4736 4737 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 4734 def list_unique_problems(params = {}, = {}) req = build_request(:list_unique_problems, params) req.send_request() end |
#list_uploads(params = {}) ⇒ Types::ListUploadsResult
Gets information about uploads, given an AWS Device Farm project ARN.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4863 4864 4865 4866 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 4863 def list_uploads(params = {}, = {}) req = build_request(:list_uploads, params) req.send_request() end |
#list_vpce_configurations(params = {}) ⇒ Types::ListVPCEConfigurationsResult
Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.
4906 4907 4908 4909 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 4906 def list_vpce_configurations(params = {}, = {}) req = build_request(:list_vpce_configurations, params) req.send_request() end |
#purchase_offering(params = {}) ⇒ Types::PurchaseOfferingResult
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.
4995 4996 4997 4998 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 4995 def purchase_offering(params = {}, = {}) req = build_request(:purchase_offering, params) req.send_request() end |
#renew_offering(params = {}) ⇒ Types::RenewOfferingResult
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.
5079 5080 5081 5082 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 5079 def renew_offering(params = {}, = {}) req = build_request(:renew_offering, params) req.send_request() end |
#schedule_run(params = {}) ⇒ Types::ScheduleRunResult
Schedules a run.
5283 5284 5285 5286 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 5283 def schedule_run(params = {}, = {}) req = build_request(:schedule_run, params) req.send_request() end |
#stop_job(params = {}) ⇒ Types::StopJobResult
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.
5375 5376 5377 5378 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 5375 def stop_job(params = {}, = {}) req = build_request(:stop_job, params) req.send_request() end |
#stop_remote_access_session(params = {}) ⇒ Types::StopRemoteAccessSessionResult
Ends a specified remote access session.
5469 5470 5471 5472 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 5469 def stop_remote_access_session(params = {}, = {}) req = build_request(:stop_remote_access_session, params) req.send_request() end |
#stop_run(params = {}) ⇒ Types::StopRunResult
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.
5589 5590 5591 5592 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 5589 def stop_run(params = {}, = {}) req = build_request(:stop_run, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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.
5629 5630 5631 5632 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 5629 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes the specified tags from a resource.
5659 5660 5661 5662 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 5659 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_device_instance(params = {}) ⇒ Types::UpdateDeviceInstanceResult
Updates information about a private device instance.
5709 5710 5711 5712 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 5709 def update_device_instance(params = {}, = {}) req = build_request(:update_device_instance, params) req.send_request() end |
#update_device_pool(params = {}) ⇒ Types::UpdateDevicePoolResult
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).
5819 5820 5821 5822 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 5819 def update_device_pool(params = {}, = {}) req = build_request(:update_device_pool, params) req.send_request() end |
#update_instance_profile(params = {}) ⇒ Types::UpdateInstanceProfileResult
Updates information about an existing private device instance profile.
5879 5880 5881 5882 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 5879 def update_instance_profile(params = {}, = {}) req = build_request(:update_instance_profile, params) req.send_request() end |
#update_network_profile(params = {}) ⇒ Types::UpdateNetworkProfileResult
Updates the network profile.
5974 5975 5976 5977 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 5974 def update_network_profile(params = {}, = {}) req = build_request(:update_network_profile, params) req.send_request() end |
#update_project(params = {}) ⇒ Types::UpdateProjectResult
Modifies the specified project name, given the project ARN and a new name.
6048 6049 6050 6051 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 6048 def update_project(params = {}, = {}) req = build_request(:update_project, params) req.send_request() end |
#update_test_grid_project(params = {}) ⇒ Types::UpdateTestGridProjectResult
Change details of a project.
6100 6101 6102 6103 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 6100 def update_test_grid_project(params = {}, = {}) req = build_request(:update_test_grid_project, params) req.send_request() end |
#update_upload(params = {}) ⇒ Types::UpdateUploadResult
Updates an uploaded test spec.
6152 6153 6154 6155 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 6152 def update_upload(params = {}, = {}) req = build_request(:update_upload, params) req.send_request() end |
#update_vpce_configuration(params = {}) ⇒ Types::UpdateVPCEConfigurationResult
Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.
6206 6207 6208 6209 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 6206 def update_vpce_configuration(params = {}, = {}) req = build_request(:update_vpce_configuration, params) req.send_request() end |