Skip to content

describe_training_plan_extension_history

describe_training_plan_extension_history(
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    training_plan_arn: Optional[TrainingPlanArn] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> DescribeTrainingPlanExtensionHistoryResponse

Retrieves the extension history for a specified training plan. The response includes details about each extension, such as the offering ID, start and end dates, status, payment status, and cost information.

Parameters:

  • training_plan_arn (Optional[TrainingPlanArn], default: None ) –

    The Amazon Resource Name (ARN); of the training plan to retrieve extension history for.

  • next_token (Optional[NextToken], default: None ) –

    A token to continue pagination if more results are available.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of extensions to return in the response.

Raises:

Source code in docs_src/capo_sagemaker/_services/sage_maker.py
def describe_training_plan_extension_history(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    training_plan_arn: Optional[
        "capo_sagemaker.types.training_plan_arn.TrainingPlanArn"
    ] = None,
    next_token: Optional["capo_sagemaker.types.next_token.NextToken"] = None,
    max_results: Optional["capo_sagemaker.types.max_results.MaxResults"] = None,
) -> "capo_sagemaker.types.describe_training_plan_extension_history_response.DescribeTrainingPlanExtensionHistoryResponse":
    """<p>Retrieves the extension history for a specified training plan. The response includes details about each extension, such as the offering ID, start and end dates, status, payment status, and cost information.</p>

    Args:
        training_plan_arn: <p>The Amazon Resource Name (ARN); of the training plan to retrieve extension history for.</p>
        next_token: <p>A token to continue pagination if more results are available.</p>
        max_results: <p>The maximum number of extensions to return in the response.</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.describe_training_plan_extension_history_request.DescribeTrainingPlanExtensionHistoryRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.describe_training_plan_extension_history_response.DescribeTrainingPlanExtensionHistoryResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.describe_training_plan_extension_history

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeTrainingPlanExtensionHistory")
    )
    input_: capo_sagemaker.types.describe_training_plan_extension_history_request.DescribeTrainingPlanExtensionHistoryRequest = {}
    if training_plan_arn is not None:
        input_["training_plan_arn"] = training_plan_arn
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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