Class: Aws::IoTDeviceAdvisor::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::IoTDeviceAdvisor::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/client.rb
Overview
An API client for IoTDeviceAdvisor. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::IoTDeviceAdvisor::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_suite_definition(params = {}) ⇒ Types::CreateSuiteDefinitionResponse
Creates a Device Advisor test suite.
-
#delete_suite_definition(params = {}) ⇒ Struct
Deletes a Device Advisor test suite.
-
#get_endpoint(params = {}) ⇒ Types::GetEndpointResponse
Gets information about an Device Advisor endpoint.
-
#get_suite_definition(params = {}) ⇒ Types::GetSuiteDefinitionResponse
Gets information about a Device Advisor test suite.
-
#get_suite_run(params = {}) ⇒ Types::GetSuiteRunResponse
Gets information about a Device Advisor test suite run.
-
#get_suite_run_report(params = {}) ⇒ Types::GetSuiteRunReportResponse
Gets a report download link for a successful Device Advisor qualifying test suite run.
-
#list_suite_definitions(params = {}) ⇒ Types::ListSuiteDefinitionsResponse
Lists the Device Advisor test suites you have created.
-
#list_suite_runs(params = {}) ⇒ Types::ListSuiteRunsResponse
Lists runs of the specified Device Advisor test suite.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags attached to an IoT Device Advisor resource.
-
#start_suite_run(params = {}) ⇒ Types::StartSuiteRunResponse
Starts a Device Advisor test suite run.
-
#stop_suite_run(params = {}) ⇒ Struct
Stops a Device Advisor test suite run that is currently running.
-
#tag_resource(params = {}) ⇒ Struct
Adds to and modifies existing tags of an IoT Device Advisor resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from an IoT Device Advisor resource.
-
#update_suite_definition(params = {}) ⇒ Types::UpdateSuiteDefinitionResponse
Updates a Device Advisor test suite.
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.
434 435 436 |
# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/client.rb', line 434 def initialize(*args) super end |
Instance Method Details
#create_suite_definition(params = {}) ⇒ Types::CreateSuiteDefinitionResponse
Creates a Device Advisor test suite.
Requires permission to access the CreateSuiteDefinition action.
494 495 496 497 |
# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/client.rb', line 494 def create_suite_definition(params = {}, = {}) req = build_request(:create_suite_definition, params) req.send_request() end |
#delete_suite_definition(params = {}) ⇒ Struct
Deletes a Device Advisor test suite.
Requires permission to access the DeleteSuiteDefinition action.
520 521 522 523 |
# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/client.rb', line 520 def delete_suite_definition(params = {}, = {}) req = build_request(:delete_suite_definition, params) req.send_request() end |
#get_endpoint(params = {}) ⇒ Types::GetEndpointResponse
Gets information about an Device Advisor endpoint.
558 559 560 561 |
# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/client.rb', line 558 def get_endpoint(params = {}, = {}) req = build_request(:get_endpoint, params) req.send_request() end |
#get_suite_definition(params = {}) ⇒ Types::GetSuiteDefinitionResponse
Gets information about a Device Advisor test suite.
Requires permission to access the GetSuiteDefinition action.
618 619 620 621 |
# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/client.rb', line 618 def get_suite_definition(params = {}, = {}) req = build_request(:get_suite_definition, params) req.send_request() end |
#get_suite_run(params = {}) ⇒ Types::GetSuiteRunResponse
Gets information about a Device Advisor test suite run.
Requires permission to access the GetSuiteRun action.
698 699 700 701 |
# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/client.rb', line 698 def get_suite_run(params = {}, = {}) req = build_request(:get_suite_run, params) req.send_request() end |
#get_suite_run_report(params = {}) ⇒ Types::GetSuiteRunReportResponse
Gets a report download link for a successful Device Advisor qualifying test suite run.
Requires permission to access the GetSuiteRunReport action.
735 736 737 738 |
# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/client.rb', line 735 def get_suite_run_report(params = {}, = {}) req = build_request(:get_suite_run_report, params) req.send_request() end |
#list_suite_definitions(params = {}) ⇒ Types::ListSuiteDefinitionsResponse
Lists the Device Advisor test suites you have created.
Requires permission to access the ListSuiteDefinitions action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
785 786 787 788 |
# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/client.rb', line 785 def list_suite_definitions(params = {}, = {}) req = build_request(:list_suite_definitions, params) req.send_request() end |
#list_suite_runs(params = {}) ⇒ Types::ListSuiteRunsResponse
Lists runs of the specified Device Advisor test suite. You can list all runs of the test suite, or the runs of a specific version of the test suite.
Requires permission to access the ListSuiteRuns action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
847 848 849 850 |
# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/client.rb', line 847 def list_suite_runs(params = {}, = {}) req = build_request(:list_suite_runs, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags attached to an IoT Device Advisor resource.
Requires permission to access the ListTagsForResource action.
881 882 883 884 |
# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/client.rb', line 881 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#start_suite_run(params = {}) ⇒ Types::StartSuiteRunResponse
Starts a Device Advisor test suite run.
Requires permission to access the StartSuiteRun action.
941 942 943 944 |
# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/client.rb', line 941 def start_suite_run(params = {}, = {}) req = build_request(:start_suite_run, params) req.send_request() end |
#stop_suite_run(params = {}) ⇒ Struct
Stops a Device Advisor test suite run that is currently running.
Requires permission to access the StopSuiteRun action.
971 972 973 974 |
# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/client.rb', line 971 def stop_suite_run(params = {}, = {}) req = build_request(:stop_suite_run, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds to and modifies existing tags of an IoT Device Advisor resource.
Requires permission to access the TagResource action.
1004 1005 1006 1007 |
# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/client.rb', line 1004 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from an IoT Device Advisor resource.
Requires permission to access the UntagResource action.
1035 1036 1037 1038 |
# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/client.rb', line 1035 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_suite_definition(params = {}) ⇒ Types::UpdateSuiteDefinitionResponse
Updates a Device Advisor test suite.
Requires permission to access the UpdateSuiteDefinition action.
1096 1097 1098 1099 |
# File 'gems/aws-sdk-iotdeviceadvisor/lib/aws-sdk-iotdeviceadvisor/client.rb', line 1096 def update_suite_definition(params = {}, = {}) req = build_request(:update_suite_definition, params) req.send_request() end |