SageMaker / Paginator / ListProjects

ListProjects

class SageMaker.Paginator.ListProjects

paginator = client.get_paginator('list_projects')

paginate(**kwargs)

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

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 the projects that were created after a specified time.

• CreationTimeBefore (datetime) – A filter that returns the projects that were created before a specified time.

• NameContains (string) – A filter that returns the projects whose name contains a specified string.

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

• SortOrder (string) – The sort order for 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

{
    'ProjectSummaryList': [
        {
            'ProjectName': 'string',
            'ProjectDescription': 'string',
            'ProjectArn': 'string',
            'ProjectId': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'ProjectStatus': 'Pending'|'CreateInProgress'|'CreateCompleted'|'CreateFailed'|'DeleteInProgress'|'DeleteFailed'|'DeleteCompleted'|'UpdateInProgress'|'UpdateCompleted'|'UpdateFailed'
        },
    ],

}

Response Structure

• (dict) –

  • ProjectSummaryList (list) –

    A list of summaries of projects.

    • (dict) –

      Information about a project.

      • ProjectName (string) –

        The name of the project.

      • ProjectDescription (string) –

        The description of the project.

      • ProjectArn (string) –

        The Amazon Resource Name (ARN) of the project.

      • ProjectId (string) –

        The ID of the project.

      • CreationTime (datetime) –

        The time that the project was created.

      • ProjectStatus (string) –

        The status of the project.