LookoutforVision / Client / list_projects

list_projects#

LookoutforVision.Client.list_projects(**kwargs)#

Lists the Amazon Lookout for Vision projects in your AWS account that are in the AWS Region in which you call ListProjects.

The ListProjects operation is eventually consistent. Recent calls to CreateProject and DeleteProject might take a while to appear in the response from ListProjects.

This operation requires permissions to perform the lookoutvision:ListProjects operation.

See also: AWS API Documentation

Request Syntax

response = client.list_projects(
    NextToken='string',
    MaxResults=123
)
Parameters:

  • NextToken (string) – If the previous response was incomplete (because there is more data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of projects.

  • MaxResults (integer) – The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

Return type:

dict

Returns:

Response Syntax

{
    'Projects': [
        {
            'ProjectArn': 'string',
            'ProjectName': 'string',
            'CreationTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Projects (list) –

      A list of projects in your AWS account.

      • (dict) –

        Metadata about an Amazon Lookout for Vision project.

        • ProjectArn (string) –

          The Amazon Resource Name (ARN) of the project.

        • ProjectName (string) –

          The name of the project.

        • CreationTimestamp (datetime) –

          The unix timestamp for the date and time that the project was created.

    • NextToken (string) –

      If the response is truncated, Amazon Lookout for Vision returns this token that you can use in the subsequent request to retrieve the next set of projects.

Exceptions