Starts a Device Advisor test suite run.
Requires permission to access the StartSuiteRun action.
Parameters:
Raises:
Source code in docs_src/capo_iotdeviceadvisor/_services/async_iot_device_advisor.py
| async def start_suite_run(
self,
suite_definition_id: "capo_iotdeviceadvisor.types.uuid.UUID",
*,
config_overrides: Optional[AsyncIotDeviceAdvisorClientConfig] = None,
suite_definition_version: Optional[
"capo_iotdeviceadvisor.types.suite_definition_version.SuiteDefinitionVersion"
] = None,
suite_run_configuration: Optional[
"capo_iotdeviceadvisor.types.suite_run_configuration.SuiteRunConfiguration"
] = None,
tags: Optional["capo_iotdeviceadvisor.types.tag_map.TagMap"] = None,
) -> "capo_iotdeviceadvisor.types.start_suite_run_response.StartSuiteRunResponse":
"""<p>Starts a Device Advisor test suite run.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">StartSuiteRun</a> action.</p>
Args:
suite_definition_id: <p>Suite definition ID of the test suite.</p>
suite_definition_version: <p>Suite definition version of the test suite.</p>
suite_run_configuration: <p>Suite run configuration.</p>
tags: <p>The tags to be attached to the suite run.</p>
Raises:
capo_iotdeviceadvisor.errors.conflict_exception.ConflictException: <p>Sends a Conflict Exception.</p>
capo_iotdeviceadvisor.errors.internal_server_exception.InternalServerException: <p>Sends an Internal Failure exception.</p>
capo_iotdeviceadvisor.errors.validation_exception.ValidationException: <p>Sends a validation exception.</p>
capo_iotdeviceadvisor.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_iotdeviceadvisor.types.start_suite_run_request.StartSuiteRunRequest]",
) -> AsyncOperationResponse[
"capo_iotdeviceadvisor.types.start_suite_run_response.StartSuiteRunResponse"
]:
import capo_iotdeviceadvisor._operations.iot_senate_service.start_suite_run
(
output,
http_response,
) = await capo_iotdeviceadvisor._operations.iot_senate_service.start_suite_run.async_start_suite_run(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("StartSuiteRun")
)
input_: capo_iotdeviceadvisor.types.start_suite_run_request.StartSuiteRunRequest = {
"suite_definition_id": suite_definition_id
}
if suite_definition_version is not None:
input_["suite_definition_version"] = suite_definition_version
if suite_run_configuration is not None:
input_["suite_run_configuration"] = suite_run_configuration
if tags is not None:
input_["tags"] = tags
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|