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.
453 454 455 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 453 def initialize(*args) super end |
Instance Method Details
#create_device_pool(params = {}) ⇒ Types::CreateDevicePoolResult
Creates a device pool.
538 539 540 541 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 538 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.
595 596 597 598 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 595 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.
687 688 689 690 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 687 def create_network_profile(params = {}, = {}) req = build_request(:create_network_profile, params) req.send_request() end |
#create_project(params = {}) ⇒ Types::CreateProjectResult
Creates a project.
755 756 757 758 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 755 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.
963 964 965 966 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 963 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.
1012 1013 1014 1015 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1012 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.
1048 1049 1050 1051 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1048 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.
1187 1188 1189 1190 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1187 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.
1236 1237 1238 1239 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1236 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.
1273 1274 1275 1276 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1273 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.
1297 1298 1299 1300 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1297 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.
1319 1320 1321 1322 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1319 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.
1357 1358 1359 1360 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1357 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.
1393 1394 1395 1396 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1393 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.
1430 1431 1432 1433 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1430 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.
1459 1460 1461 1462 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1459 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.
1495 1496 1497 1498 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1495 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.
1519 1520 1521 1522 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1519 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.
1569 1570 1571 1572 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1569 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.
1667 1668 1669 1670 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1667 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.
1709 1710 1711 1712 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1709 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.
1760 1761 1762 1763 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1760 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.
1967 1968 1969 1970 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 1967 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.
2001 2002 2003 2004 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2001 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.
2102 2103 2104 2105 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2102 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.
2141 2142 2143 2144 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2141 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.
2241 2242 2243 2244 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2241 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.
2295 2296 2297 2298 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2295 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.
2402 2403 2404 2405 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2402 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.
2537 2538 2539 2540 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2537 def get_run(params = {}, = {}) req = build_request(:get_run, params) req.send_request() end |
#get_suite(params = {}) ⇒ Types::GetSuiteResult
Gets information about a suite.
2598 2599 2600 2601 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2598 def get_suite(params = {}, = {}) req = build_request(:get_suite, params) req.send_request() end |
#get_test(params = {}) ⇒ Types::GetTestResult
Gets information about a test.
2659 2660 2661 2662 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2659 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.
2696 2697 2698 2699 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2696 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).
2746 2747 2748 2749 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2746 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.
2798 2799 2800 2801 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2798 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.
2832 2833 2834 2835 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2832 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.
2892 2893 2894 2895 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2892 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.
2957 2958 2959 2960 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 2957 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.
3008 3009 3010 3011 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 3008 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.
3107 3108 3109 3110 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 3107 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.
3273 3274 3275 3276 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 3273 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.
3317 3318 3319 3320 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 3317 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.
3423 3424 3425 3426 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 3423 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.
3477 3478 3479 3480 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 3477 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.
3516 3517 3518 3519 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 3516 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.
3663 3664 3665 3666 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 3663 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.
3785 3786 3787 3788 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 3785 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.
3860 3861 3862 3863 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 3860 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.
3977 3978 3979 3980 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 3977 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.
4127 4128 4129 4130 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 4127 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.
4184 4185 4186 4187 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 4184 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.
4257 4258 4259 4260 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 4257 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.
4291 4292 4293 4294 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 4291 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.
4336 4337 4338 4339 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 4336 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.
4381 4382 4383 4384 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 4381 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.
4428 4429 4430 4431 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 4428 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.
4494 4495 4496 4497 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 4494 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.
4567 4568 4569 4570 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 4567 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.
4677 4678 4679 4680 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 4677 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.
4806 4807 4808 4809 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 4806 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.
4849 4850 4851 4852 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 4849 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.
4938 4939 4940 4941 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 4938 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.
5022 5023 5024 5025 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 5022 def renew_offering(params = {}, = {}) req = build_request(:renew_offering, params) req.send_request() end |
#schedule_run(params = {}) ⇒ Types::ScheduleRunResult
Schedules a run.
5220 5221 5222 5223 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 5220 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.
5312 5313 5314 5315 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 5312 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.
5403 5404 5405 5406 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 5403 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.
5521 5522 5523 5524 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 5521 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.
5561 5562 5563 5564 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 5561 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.
5591 5592 5593 5594 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 5591 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.
5641 5642 5643 5644 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 5641 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).
5751 5752 5753 5754 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 5751 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.
5811 5812 5813 5814 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 5811 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.
5906 5907 5908 5909 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 5906 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.
5980 5981 5982 5983 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 5980 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.
6032 6033 6034 6035 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 6032 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.
6084 6085 6086 6087 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 6084 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.
6138 6139 6140 6141 |
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/client.rb', line 6138 def update_vpce_configuration(params = {}, = {}) req = build_request(:update_vpce_configuration, params) req.send_request() end |