IoTSiteWise / Paginator / ListComputationModels

ListComputationModels¶

class IoTSiteWise.Paginator.ListComputationModels¶

paginator = client.get_paginator('list_computation_models')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from IoTSiteWise.Client.list_computation_models().

Request Syntax

response_iterator = paginator.paginate(
    computationModelType='ANOMALY_DETECTION',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

computationModelType (string) – The type of computation model. If a computationModelType is not provided, all types of computation models are returned.
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

{
    'computationModelSummaries': [
        {
            'id': 'string',
            'arn': 'string',
            'name': 'string',
            'description': 'string',
            'type': 'ANOMALY_DETECTION',
            'creationDate': datetime(2015, 1, 1),
            'lastUpdateDate': datetime(2015, 1, 1),
            'status': {
                'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
                'error': {
                    'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
                    'message': 'string',
                    'details': [
                        {
                            'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
                            'message': 'string'
                        },
                    ]
                }
            },
            'version': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- computationModelSummaries (list) –
  
  A list summarizing each computation model.
  - (dict) –
    
    Contains a summary of a computation model.
    - id (string) –
      
      The ID of the computation model.
    - arn (string) –
      
      The ARN of the computation model, which has the following format.
      
      arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId}
    - name (string) –
      
      The name of the computation model.
    - description (string) –
      
      The description of the computation model.
    - type (string) –
      
      The type of the computation model.
    - creationDate (datetime) –
      
      The model creation date, in Unix epoch time.
    - lastUpdateDate (datetime) –
      
      The time the model was last updated, in Unix epoch time.
    - status (dict) –
      
      The current status of the computation model.
      - state (string) –
        
        The current state of the computation model.
      - error (dict) –
        
        Contains the details of an IoT SiteWise error.
        
        code (string) –
        
        The error code.
        
        message (string) –
        
        The error message.
        
        details (list) –
        
        A list of detailed errors.
        
        (dict) –
        
        Contains detailed error information.
        
        code (string) –
        
        The error code.
        
        message (string) –
        
        The error message.
    - version (string) –
      
      The version of the computation model.
- NextToken (string) –
  
  A token to resume pagination.