Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListTrainingPlans

Retrieves a list of training plans for the current account.

Request Syntax


{
   "Filters": [ 
      { 
         "Name": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string",
   "SortBy": "string",
   "SortOrder": "string",
   "StartTimeAfter": number,
   "StartTimeBefore": number
}

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.

Filters

Additional filters to apply to the list of training plans.

Type: Array of TrainingPlanFilter objects

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Required: No

MaxResults

The maximum number of results 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: Maximum length of 8192.

Pattern: .*

Required: No

SortBy

The training plan field to sort the results by (e.g., StartTime, Status).

Type: String

Valid Values: TrainingPlanName | StartTime | Status

Required: No

SortOrder

The order to sort the results (Ascending or Descending).

Type: String

Valid Values: Ascending | Descending

Required: No

StartTimeAfter

Filter to list only training plans with an actual start time after this date.

Type: Timestamp

Required: No

StartTimeBefore

Filter to list only training plans with an actual start time before this date.

Type: Timestamp

Required: No

Response Syntax


{
   "NextToken": "string",
   "TrainingPlanSummaries": [ 
      { 
         "AvailableInstanceCount": number,
         "CurrencyCode": "string",
         "DurationHours": number,
         "DurationMinutes": number,
         "EndTime": number,
         "InUseInstanceCount": number,
         "ReservedCapacitySummaries": [ 
            { 
               "AvailabilityZone": "string",
               "DurationHours": number,
               "DurationMinutes": number,
               "EndTime": number,
               "InstanceType": "string",
               "ReservedCapacityArn": "string",
               "StartTime": number,
               "Status": "string",
               "TotalInstanceCount": number
            }
         ],
         "StartTime": number,
         "Status": "string",
         "StatusMessage": "string",
         "TargetResources": [ "string" ],
         "TotalInstanceCount": number,
         "TrainingPlanArn": "string",
         "TrainingPlanName": "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: Maximum length of 8192.

Pattern: .*

TrainingPlanSummaries

A list of summary information for the training plans.

Type: Array of TrainingPlanSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.