SageMaker / Paginator / ListAlgorithms

ListAlgorithms

class SageMaker.Paginator.ListAlgorithms

paginator = client.get_paginator('list_algorithms')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    NameContains='string',
    SortBy='Name'|'CreationTime',
    SortOrder='Ascending'|'Descending',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

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

• NameContains (string) – A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.

• SortBy (string) – The parameter by which to sort the results. The default is CreationTime.

• SortOrder (string) – The sort order for the results. The default is Ascending.

• 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

{
    'AlgorithmSummaryList': [
        {
            'AlgorithmName': 'string',
            'AlgorithmArn': 'string',
            'AlgorithmDescription': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'AlgorithmStatus': 'Pending'|'InProgress'|'Completed'|'Failed'|'Deleting'
        },
    ],

}

Response Structure

• (dict) –

  • AlgorithmSummaryList (list) –

    >An array of AlgorithmSummary objects, each of which lists an algorithm.

    • (dict) –

      Provides summary information about an algorithm.

      • AlgorithmName (string) –

        The name of the algorithm that is described by the summary.

      • AlgorithmArn (string) –

        The Amazon Resource Name (ARN) of the algorithm.

      • AlgorithmDescription (string) –

        A brief description of the algorithm.

      • CreationTime (datetime) –

        A timestamp that shows when the algorithm was created.

      • AlgorithmStatus (string) –

        The overall status of the algorithm.