Skip to content

delete_training_session

delete_training_session(
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    training_session_name: Optional[TrainingSessionName] = None,
) -> DeleteTrainingSessionResponse

Deletes a training session. You must stop a running session before deleting it. Use the StopTrainingSession operation to stop the session first.

The following operations are related to DeleteTrainingSession:

  • CreateTrainingSession

  • DescribeTrainingSession

  • StopTrainingSession

Parameters:

Raises:

Source code in docs_src/capo_sagemaker/_services/sage_maker.py
def delete_training_session(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    training_session_name: Optional[
        "capo_sagemaker.types.training_session_name.TrainingSessionName"
    ] = None,
) -> "capo_sagemaker.types.delete_training_session_response.DeleteTrainingSessionResponse":
    """<p>Deletes a training session. You must stop a running session before deleting it. Use the <code>StopTrainingSession</code> operation to stop the session first.</p> <p>The following operations are related to <code>DeleteTrainingSession</code>:</p> <ul> <li> <p> <code>CreateTrainingSession</code> </p> </li> <li> <p> <code>DescribeTrainingSession</code> </p> </li> <li> <p> <code>StopTrainingSession</code> </p> </li> </ul>

    Args:
        training_session_name: <p>The name of the training session to delete.</p>

    Raises:
        capo_sagemaker.errors.resource_not_found.ResourceNotFound: <p>Resource being access is not found.</p>
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sagemaker.types.delete_training_session_request.DeleteTrainingSessionRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.delete_training_session_response.DeleteTrainingSessionResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.delete_training_session

        output, http_response = (
            capo_sagemaker._operations.sage_maker.delete_training_session.delete_training_session(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteTrainingSession")
    )
    input_: capo_sagemaker.types.delete_training_session_request.DeleteTrainingSessionRequest = {}
    if training_session_name is not None:
        input_["training_session_name"] = training_session_name

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