IoTSiteWise / Client / list_projects

list_projects#

IoTSiteWise.Client.list_projects(**kwargs)#

Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.

Request Syntax

response = client.list_projects(
    portalId='string',
    nextToken='string',
    maxResults=123
)

Parameters:

portalId (string) –
[REQUIRED]

The ID of the portal.
nextToken (string) – The token to be used for the next set of paginated results.
maxResults (integer) –
The maximum number of results to return for each paginated request.

Default: 50

Return type:

dict

Returns:

Response Syntax

{
    'projectSummaries': [
        {
            'id': 'string',
            'name': 'string',
            'description': 'string',
            'creationDate': datetime(2015, 1, 1),
            'lastUpdateDate': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- projectSummaries (list) –
  
  A list that summarizes each project in the portal.
  - (dict) –
    
    Contains project summary information.
    - id (string) –
      
      The ID of the project.
    - name (string) –
      
      The name of the project.
    - description (string) –
      
      The project’s description.
    - creationDate (datetime) –
      
      The date the project was created, in Unix epoch time.
    - lastUpdateDate (datetime) –
      
      The date the project was last updated, in Unix epoch time.
- nextToken (string) –
  
  The token for the next set of results, or null if there are no additional results.

Exceptions

IoTSiteWise.Client.exceptions.InvalidRequestException
IoTSiteWise.Client.exceptions.InternalFailureException
IoTSiteWise.Client.exceptions.ThrottlingException