SageMaker / Paginator / ListTrainingSessions

ListTrainingSessions

class SageMaker.Paginator.ListTrainingSessions

paginator = client.get_paginator('list_training_sessions')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    NameContains='string',
    StatusEquals='Created'|'Blocked'|'Running'|'Failed'|'Scheduled'|'Stopping'|'Stopped'|'Expired'|'Deleting'|'DeletionFailed',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

• 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

{
    '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) –

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