Skip to content

stop_suite_run async

stop_suite_run(
    suite_definition_id: UUID,
    suite_run_id: UUID,
    *,
    config_overrides: Optional[AsyncIotDeviceAdvisorClientConfig] = None,
) -> StopSuiteRunResponse

Stops a Device Advisor test suite run that is currently running.

Requires permission to access the StopSuiteRun action.

Parameters:

  • suite_definition_id (UUID) –

    Suite definition ID of the test suite run to be stopped.

  • suite_run_id (UUID) –

    Suite run ID of the test suite run to be stopped.

Raises:

Source code in docs_src/capo_iotdeviceadvisor/_services/async_iot_device_advisor.py
async def stop_suite_run(
    self,
    suite_definition_id: "capo_iotdeviceadvisor.types.uuid.UUID",
    suite_run_id: "capo_iotdeviceadvisor.types.uuid.UUID",
    *,
    config_overrides: Optional[AsyncIotDeviceAdvisorClientConfig] = None,
) -> "capo_iotdeviceadvisor.types.stop_suite_run_response.StopSuiteRunResponse":
    """<p>Stops a Device Advisor test suite run that is currently running.</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">StopSuiteRun</a> action.</p>

    Args:
        suite_definition_id: <p>Suite definition ID of the test suite run to be stopped.</p>
        suite_run_id: <p>Suite run ID of the test suite run to be stopped.</p>

    Raises:
        capo_iotdeviceadvisor.errors.internal_server_exception.InternalServerException: <p>Sends an Internal Failure exception.</p>
        capo_iotdeviceadvisor.errors.resource_not_found_exception.ResourceNotFoundException: <p>Sends a Resource Not Found 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.stop_suite_run_request.StopSuiteRunRequest]",
    ) -> AsyncOperationResponse[
        "capo_iotdeviceadvisor.types.stop_suite_run_response.StopSuiteRunResponse"
    ]:
        import capo_iotdeviceadvisor._operations.iot_senate_service.stop_suite_run

        (
            output,
            http_response,
        ) = await capo_iotdeviceadvisor._operations.iot_senate_service.stop_suite_run.async_stop_suite_run(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopSuiteRun")
    )
    input_: capo_iotdeviceadvisor.types.stop_suite_run_request.StopSuiteRunRequest = {
        "suite_definition_id": suite_definition_id,
        "suite_run_id": suite_run_id,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output