Skip to content

delete_suite_definition

delete_suite_definition(
    suite_definition_id: UUID,
    *,
    config_overrides: Optional[IotDeviceAdvisorClientConfig] = None,
) -> DeleteSuiteDefinitionResponse

Deletes a Device Advisor test suite.

Requires permission to access the DeleteSuiteDefinition action.

Parameters:

  • suite_definition_id (UUID) –

    Suite definition ID of the test suite to be deleted.

Raises:

Source code in docs_src/capo_iotdeviceadvisor/_services/iot_device_advisor.py
def delete_suite_definition(
    self,
    suite_definition_id: "capo_iotdeviceadvisor.types.uuid.UUID",
    *,
    config_overrides: Optional[IotDeviceAdvisorClientConfig] = None,
) -> "capo_iotdeviceadvisor.types.delete_suite_definition_response.DeleteSuiteDefinitionResponse":
    """<p>Deletes a Device Advisor test suite.</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">DeleteSuiteDefinition</a> action.</p>

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

    Raises:
        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.
    """

    def _handler(
        req: "OperationRequest[capo_iotdeviceadvisor.types.delete_suite_definition_request.DeleteSuiteDefinitionRequest]",
    ) -> OperationResponse[
        "capo_iotdeviceadvisor.types.delete_suite_definition_response.DeleteSuiteDefinitionResponse"
    ]:
        import capo_iotdeviceadvisor._operations.iot_senate_service.delete_suite_definition

        output, http_response = (
            capo_iotdeviceadvisor._operations.iot_senate_service.delete_suite_definition.delete_suite_definition(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteSuiteDefinition")
    )
    input_: capo_iotdeviceadvisor.types.delete_suite_definition_request.DeleteSuiteDefinitionRequest = {
        "suite_definition_id": suite_definition_id
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output