Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListTrainingSessions

Lists training sessions in your account. You can filter results by creation time, name, and status. The operation paginates results. To retrieve additional results, use the NextToken parameter.

The following operations are related to ListTrainingSessions:

CreateTrainingSession
DescribeTrainingSession

Request Syntax


{
   "CreationTimeAfter": number,
   "CreationTimeBefore": number,
   "MaxResults": number,
   "NameContains": "string",
   "NextToken": "string",
   "StatusEquals": "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.

CreationTimeAfter

A filter that returns only training sessions created after the specified time.

Type: Timestamp

Required: No

CreationTimeBefore

A filter that returns only training sessions created before the specified time.

Type: Timestamp

Required: No

MaxResults

The maximum number of training sessions to return in the response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NameContains

A string in the training session name to filter results. Only sessions whose name contains the specified string are returned.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 63.

Pattern: [a-zA-Z0-9\-]+

Required: No

NextToken

If the response was truncated, use the token returned in the previous response to retrieve the next page of results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: .*

Required: No

StatusEquals

A filter that returns only training sessions with the specified status.

Type: String

Required: No

Response Syntax


{
   "NextToken": "string",
   "TrainingSessionSummaries": [ 
      { 
         "CreationTime": number,
         "LastModifiedTime": number,
         "TrainingSessionArn": "string",
         "TrainingSessionStatus": "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

If the response is truncated, this token retrieves the next set of results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: .*

TrainingSessionSummaries

An array of TrainingSessionSummary objects that provide summary information about the training sessions.

Type: Array of TrainingSessionSummary objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Errors

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