SageMaker / Client / describe_training_plan_extension_history

describe_training_plan_extension_history¶

SageMaker.Client.describe_training_plan_extension_history(**kwargs)¶

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.

Request Syntax

response = client.describe_training_plan_extension_history(
    TrainingPlanArn='string',
    NextToken='string',
    MaxResults=123
)

Parameters:

TrainingPlanArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN); of the training plan to retrieve extension history for.
NextToken (string) – A token to continue pagination if more results are available.
MaxResults (integer) – The maximum number of extensions to return in the response.

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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- TrainingPlanExtensions (list) –
  
  A list of extensions for the specified training plan.
  - (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).
- NextToken (string) –
  
  A token to continue pagination if more results are available.

Exceptions

SageMaker.Client.exceptions.ResourceNotFound