DescribeTrainingPlanExtensionHistory
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
{
"MaxResults": number,
"NextToken": "string",
"TrainingPlanArn": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- MaxResults
-
The maximum number of extensions to return in the response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
A token to continue pagination if more results are available.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern:
.*Required: No
- TrainingPlanArn
-
The Amazon Resource Name (ARN); of the training plan to retrieve extension history for.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 2048.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:training-plan/.*Required: Yes
Response Syntax
{
"NextToken": "string",
"TrainingPlanExtensions": [
{
"AvailabilityZone": "string",
"AvailabilityZoneId": "string",
"CurrencyCode": "string",
"DurationHours": number,
"EndDate": number,
"ExtendedAt": number,
"PaymentStatus": "string",
"StartDate": number,
"Status": "string",
"TrainingPlanExtensionOfferingId": "string",
"UpfrontFee": "string"
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- NextToken
-
A token to continue pagination if more results are available.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern:
.* - TrainingPlanExtensions
-
A list of extensions for the specified training plan.
Type: Array of TrainingPlanExtension objects
Array Members: Minimum number of 0 items.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFound
-
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: