IoTSiteWise / Client / list_applications

list_applications¶

IoTSiteWise.Client.list_applications(**kwargs)¶

Retrieves a paginated list of existing applications

Request Syntax

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

Parameters:

maxResults (integer) – Maximum number of results to return
nextToken (string) – Next Page Token

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'applications': [
        {
            'arn': 'string',
            'id': 'string',
            'name': 'string',
            'status': 'CREATING'|'ACTIVE'|'DELETING',
            'createdAt': datetime(2015, 1, 1),
            'workspaceName': 'string'
        },
    ]
}

Response Structure

(dict) –
- nextToken (string) –
  
  Next Page Token
- applications (list) –
  
  List of applications
  - (dict) –
    
    Summary of an application for list operations
    - arn (string) –
      
      ARN of the application
    - id (string) –
      
      Unique identifier of the application
    - name (string) –
      
      Name of the application
    - status (string) –
      
      Current status of the application
    - createdAt (datetime) –
      
      Timestamp when the application was created
    - workspaceName (string) –
      
      Name of the workspace this application belongs to

Exceptions

IoTSiteWise.Client.exceptions.InternalFailureException
IoTSiteWise.Client.exceptions.AccessDeniedException
IoTSiteWise.Client.exceptions.InvalidRequestException
IoTSiteWise.Client.exceptions.ResourceNotFoundException
IoTSiteWise.Client.exceptions.ThrottlingException