SageMaker / Client / list_projects

list_projects#

SageMaker.Client.list_projects(**kwargs)#

Gets a list of the projects in an Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.list_projects(
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    MaxResults=123,
    NameContains='string',
    NextToken='string',
    SortBy='Name'|'CreationTime',
    SortOrder='Ascending'|'Descending'
)
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.

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

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

  • NextToken (string) – If the result of the previous ListProjects request was truncated, the response includes a NextToken. To retrieve the next set of projects, use the token in the next request.

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

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

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'
        },
    ],
    'NextToken': 'string'
}

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.

    • NextToken (string) –

      If the result of the previous ListCompilationJobs request was truncated, the response includes a NextToken. To retrieve the next set of model compilation jobs, use the token in the next request.