SageMaker / Client / extend_training_plan

extend_training_plan

SageMaker.Client.extend_training_plan(**kwargs)

Extends an existing training plan by purchasing an extension offering. This allows you to add additional compute capacity time to your training plan without creating a new plan or reconfiguring your workloads.

To find available extension offerings, use the SearchTrainingPlanOfferings API with the TrainingPlanArn parameter.

To view the history of extensions for a training plan, use the DescribeTrainingPlanExtensionHistory API.

See also: AWS API Documentation

Request Syntax

response = client.extend_training_plan(
    TrainingPlanExtensionOfferingId='string'
)
Parameters:

TrainingPlanExtensionOfferingId (string) –

[REQUIRED]

The unique identifier of the extension offering to purchase. You can retrieve this ID from the TrainingPlanExtensionOfferings in the response of the SearchTrainingPlanOfferings API.

Return type:

dict

Returns:

Response Syntax

{
    'TrainingPlanExtensions': [
        {
            'TrainingPlanExtensionOfferingId': 'string',
            'ExtendedAt': datetime(2015, 1, 1),
            'StartDate': datetime(2015, 1, 1),
            'EndDate': datetime(2015, 1, 1),
            'Status': 'string',
            'PaymentStatus': 'string',
            'AvailabilityZone': 'string',
            'AvailabilityZoneId': 'string',
            'DurationHours': 123,
            'UpfrontFee': 'string',
            'CurrencyCode': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • TrainingPlanExtensions (list) –

      The list of extensions for the training plan, including the newly created extension.

      • (dict) –

        Details about an extension to a training plan, including the offering ID, dates, status, and cost information.

        • TrainingPlanExtensionOfferingId (string) –

          The unique identifier of the extension offering that was used to create this extension.

        • ExtendedAt (datetime) –

          The timestamp when the extension was created.

        • StartDate (datetime) –

          The start date of the extension period.

        • EndDate (datetime) –

          The end date of the extension period.

        • Status (string) –

          The current status of the extension (e.g., Pending, Active, Scheduled, Failed, Expired).

        • PaymentStatus (string) –

          The payment processing status of the extension.

        • AvailabilityZone (string) –

          The Availability Zone of the extension.

        • AvailabilityZoneId (string) –

          The Availability Zone ID of the extension.

        • DurationHours (integer) –

          The duration of the extension in hours.

        • UpfrontFee (string) –

          The upfront fee for the extension.

        • CurrencyCode (string) –

          The currency code for the upfront fee (e.g., USD).

Exceptions