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_endpointMain.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.start_suite_runMain.Iotdeviceadvisor.stop_suite_runMain.Iotdeviceadvisor.tag_resourceMain.Iotdeviceadvisor.untag_resourceMain.Iotdeviceadvisor.update_suite_definition
Documentation
Main.Iotdeviceadvisor.create_suite_definition — Methodcreate_suite_definition(suite_definition_configuration)
create_suite_definition(suite_definition_configuration, params::Dict{String,<:Any})Creates a Device Advisor test suite. Requires permission to access the CreateSuiteDefinition action.
Arguments
suite_definition_configuration: Creates a Device Advisor test suite with suite definition configuration.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"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. Requires permission to access the DeleteSuiteDefinition action.
Arguments
suite_definition_id: Suite definition ID of the test suite to be deleted.
Main.Iotdeviceadvisor.get_endpoint — Methodget_endpoint()
get_endpoint(params::Dict{String,<:Any})Gets information about an Device Advisor endpoint.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"authenticationMethod": The authentication method used during the device connection."certificateArn": The certificate ARN of the device. This is an optional parameter."deviceRoleArn": The device role ARN of the device. This is an optional parameter."thingArn": The thing ARN of the device. This is an optional parameter.
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. Requires permission to access the GetSuiteDefinition action.
Arguments
suite_definition_id: Suite definition ID of the test suite to get.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"suiteDefinitionVersion": Suite definition version of the test suite to get.
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. Requires permission to access the GetSuiteRun action.
Arguments
suite_definition_id: Suite definition ID for the test suite run.suite_run_id: Suite run ID for the test suite run.
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. Requires permission to access the GetSuiteRunReport action.
Arguments
suite_definition_id: Suite definition ID of the test suite.suite_run_id: Suite run ID of the test suite run.
Main.Iotdeviceadvisor.list_suite_definitions — Methodlist_suite_definitions()
list_suite_definitions(params::Dict{String,<:Any})Lists the Device Advisor test suites you have created. Requires permission to access the ListSuiteDefinitions action.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of results to return at once."nextToken": A token used to get the next set of results.
Main.Iotdeviceadvisor.list_suite_runs — Methodlist_suite_runs()
list_suite_runs(params::Dict{String,<:Any})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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of results to return at once."nextToken": A token to retrieve the next set of results."suiteDefinitionId": Lists the test suite runs of the specified test suite based on suite definition ID."suiteDefinitionVersion": Must be passed along with suiteDefinitionId. Lists the test suite runs of the specified 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. Requires permission to access the ListTagsForResource action.
Arguments
resource_arn: The resource ARN of the IoT Device Advisor resource. This can be SuiteDefinition ARN or SuiteRun ARN.
Main.Iotdeviceadvisor.start_suite_run — Methodstart_suite_run(suite_definition_id, suite_run_configuration)
start_suite_run(suite_definition_id, suite_run_configuration, params::Dict{String,<:Any})Starts a Device Advisor test suite run. Requires permission to access the StartSuiteRun action.
Arguments
suite_definition_id: Suite definition ID of the test suite.suite_run_configuration: Suite run configuration.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"suiteDefinitionVersion": Suite definition version of the test suite."tags": The tags to be attached to the suite run.
Main.Iotdeviceadvisor.stop_suite_run — Methodstop_suite_run(suite_definition_id, suite_run_id)
stop_suite_run(suite_definition_id, suite_run_id, params::Dict{String,<:Any})Stops a Device Advisor test suite run that is currently running. Requires permission to access the StopSuiteRun action.
Arguments
suite_definition_id: Suite definition ID of the test suite run to be stopped.suite_run_id: Suite run ID of the test suite run to be stopped.
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. Requires permission to access the TagResource action.
Arguments
resource_arn: The resource ARN of an IoT Device Advisor resource. This can be SuiteDefinition ARN or SuiteRun ARN.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. Requires permission to access the UntagResource action.
Arguments
resource_arn: The resource ARN of an IoT Device Advisor resource. This can be SuiteDefinition ARN or SuiteRun ARN.tag_keys: List of tag keys to remove from the IoT Device Advisor resource.
Main.Iotdeviceadvisor.update_suite_definition — Methodupdate_suite_definition(suite_definition_configuration, suite_definition_id)
update_suite_definition(suite_definition_configuration, suite_definition_id, params::Dict{String,<:Any})Updates a Device Advisor test suite. Requires permission to access the UpdateSuiteDefinition action.
Arguments
suite_definition_configuration: Updates a Device Advisor test suite with suite definition configuration.suite_definition_id: Suite definition ID of the test suite to be updated.