SageMaker / Paginator / DescribeTrainingPlanExtensionHistory

DescribeTrainingPlanExtensionHistory

class SageMaker.Paginator.DescribeTrainingPlanExtensionHistory

paginator = client.get_paginator('describe_training_plan_extension_history')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SageMaker.Client.describe_training_plan_extension_history().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    TrainingPlanArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• TrainingPlanArn (string) –

  [REQUIRED]

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous 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'
        },
    ],

}

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).