SageMaker / Client / list_training_sessions

list_training_sessions

SageMaker.Client.list_training_sessions(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_training_sessions(
    NextToken='string',
    MaxResults=123,
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    NameContains='string',
    StatusEquals='Created'|'Blocked'|'Running'|'Failed'|'Scheduled'|'Stopping'|'Stopped'|'Expired'|'Deleting'|'DeletionFailed'
)
Parameters:

  • NextToken (string) – If the response was truncated, use the token returned in the previous response to retrieve the next page of results.

  • MaxResults (integer) – The maximum number of training sessions to return in the response.

  • CreationTimeAfter (datetime) – A filter that returns only training sessions created after the specified time.

  • CreationTimeBefore (datetime) – A filter that returns only training sessions created before the specified time.

  • NameContains (string) – A string in the training session name to filter results. Only sessions whose name contains the specified string are returned.

  • StatusEquals (string) – A filter that returns only training sessions with the specified status.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'TrainingSessionSummaries': [
        {
            'TrainingSessionArn': 'string',
            'TrainingSessionStatus': 'Created'|'Blocked'|'Running'|'Failed'|'Scheduled'|'Stopping'|'Stopped'|'Expired'|'Deleting'|'DeletionFailed',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

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

    • TrainingSessionSummaries (list) –

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

      • (dict) –

        Contains summary information about a training session.

        • TrainingSessionArn (string) –

          The Amazon Resource Name (ARN) of the training session.

        • TrainingSessionStatus (string) –

          The current status of the training session.

        • CreationTime (datetime) –

          The date and time that the training session was created.

        • LastModifiedTime (datetime) –

          The date and time that the training session was last modified.