Iotdeviceadvisor
This page documents function available when using the Iotdeviceadvisor module, created with @service Iotdeviceadvisor.
Index
Main.Iotdeviceadvisor.create_suite_definitionMain.Iotdeviceadvisor.delete_suite_definitionMain.Iotdeviceadvisor.get_suite_definitionMain.Iotdeviceadvisor.get_suite_runMain.Iotdeviceadvisor.get_suite_run_reportMain.Iotdeviceadvisor.list_suite_definitionsMain.Iotdeviceadvisor.list_suite_runsMain.Iotdeviceadvisor.list_tags_for_resourceMain.Iotdeviceadvisor.list_test_casesMain.Iotdeviceadvisor.start_suite_runMain.Iotdeviceadvisor.tag_resourceMain.Iotdeviceadvisor.untag_resourceMain.Iotdeviceadvisor.update_suite_definition
Documentation
Main.Iotdeviceadvisor.create_suite_definition — Methodcreate_suite_definition()
create_suite_definition(params::Dict{String,<:Any})Creates a Device Advisor test suite.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"suiteDefinitionConfiguration": Creates a Device Advisor test suite with suite definition configuration."tags": The tags to be attached to the suite definition.
Main.Iotdeviceadvisor.delete_suite_definition — Methoddelete_suite_definition(suite_definition_id)
delete_suite_definition(suite_definition_id, params::Dict{String,<:Any})Deletes a Device Advisor test suite.
Arguments
suite_definition_id: Deletes a Device Advisor test suite with defined suite Id.
Main.Iotdeviceadvisor.get_suite_definition — Methodget_suite_definition(suite_definition_id)
get_suite_definition(suite_definition_id, params::Dict{String,<:Any})Gets information about a Device Advisor test suite.
Arguments
suite_definition_id: Requests suite definition Id with GetSuiteDefinition API call.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"suiteDefinitionVersion": Requests the suite definition version of a test suite.
Main.Iotdeviceadvisor.get_suite_run — Methodget_suite_run(suite_definition_id, suite_run_id)
get_suite_run(suite_definition_id, suite_run_id, params::Dict{String,<:Any})Gets information about a Device Advisor test suite run.
Arguments
suite_definition_id: Requests the information about Device Advisor test suite run based on suite definition Id.suite_run_id: Requests the information about Device Advisor test suite run based on suite run Id.
Main.Iotdeviceadvisor.get_suite_run_report — Methodget_suite_run_report(suite_definition_id, suite_run_id)
get_suite_run_report(suite_definition_id, suite_run_id, params::Dict{String,<:Any})Gets a report download link for a successful Device Advisor qualifying test suite run.
Arguments
suite_definition_id: Device Advisor suite definition Id.suite_run_id: Device Advisor suite run Id.
Main.Iotdeviceadvisor.list_suite_definitions — Methodlist_suite_definitions()
list_suite_definitions(params::Dict{String,<:Any})Lists the Device Advisor test suites you have created.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": Request the list of all the Device Advisor test suites."nextToken": Requests the Device Advisor test suites next token.
Main.Iotdeviceadvisor.list_suite_runs — Methodlist_suite_runs()
list_suite_runs(params::Dict{String,<:Any})Lists the 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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": MaxResults for list suite run API request."nextToken": Next pagination token for list suite run request."suiteDefinitionId": Lists the runs of the specified Device Advisor test suite based on suite definition Id."suiteDefinitionVersion": Lists the runs of the specified Device Advisor test suite based on suite definition version.
Main.Iotdeviceadvisor.list_tags_for_resource — Methodlist_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})Lists the tags attached to an IoT Device Advisor resource.
Arguments
resource_arn: The ARN of the IoT Device Advisor resource.
Main.Iotdeviceadvisor.list_test_cases — Methodlist_test_cases()
list_test_cases(params::Dict{String,<:Any})Lists all the test cases in the test suite.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"intendedForQualification": Lists all the qualification test cases in the test suite."maxResults": Requests the test cases max results."nextToken": Requests the test cases next token.
Main.Iotdeviceadvisor.start_suite_run — Methodstart_suite_run(suite_definition_id)
start_suite_run(suite_definition_id, params::Dict{String,<:Any})Starts a Device Advisor test suite run.
Arguments
suite_definition_id: Request to start suite run based on suite definition Id.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"suiteDefinitionVersion": Request to start suite run based on suite definition version."suiteRunConfiguration": Request to start suite run based on suite configuration."tags": The tags to be attached to the suite run.
Main.Iotdeviceadvisor.tag_resource — Methodtag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})Adds to and modifies existing tags of an IoT Device Advisor resource.
Arguments
resource_arn: The resource ARN of an IoT Device Advisor resource.tags: The tags to be attached to the IoT Device Advisor resource.
Main.Iotdeviceadvisor.untag_resource — Methoduntag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})Removes tags from an IoT Device Advisor resource.
Arguments
resource_arn: The resource ARN of an IoT Device Advisor resource.tag_keys: List of tag keys to remove from the IoT Device Advisor resource.
Main.Iotdeviceadvisor.update_suite_definition — Methodupdate_suite_definition(suite_definition_id)
update_suite_definition(suite_definition_id, params::Dict{String,<:Any})Updates a Device Advisor test suite.
Arguments
suite_definition_id: Updates a Device Advisor test suite with suite definition id.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"suiteDefinitionConfiguration": Updates a Device Advisor test suite with suite definition configuration.