IoTEvents / Client / get_detector_model_analysis_results

get_detector_model_analysis_results#

IoTEvents.Client.get_detector_model_analysis_results(**kwargs)#

Retrieves one or more analysis results of the detector model.

Note

After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.

Request Syntax

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

Parameters:

analysisId (string) –
[REQUIRED]

The ID of the analysis result that you want to retrieve.
nextToken (string) – The token that you can use to return the next set of results.
maxResults (integer) – The maximum number of results to be returned per request.

Return type:

dict

Returns:

Response Syntax

{
    'analysisResults': [
        {
            'type': 'string',
            'level': 'INFO'|'WARNING'|'ERROR',
            'message': 'string',
            'locations': [
                {
                    'path': 'string'
                },
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- analysisResults (list) –
  
  Contains information about one or more analysis results.
  - (dict) –
    
    Contains the result of the analysis.
    - type (string) –
      
      The type of the analysis result. Analyses fall into the following types based on the validators used to generate the analysis result:
      - supported-actions - You must specify AWS IoT Events supported actions that work with other AWS services in a supported AWS Region.
      - service-limits - Resources or API operations can’t exceed service quotas (also known as limits). Update your detector model or request a quota increase.
      - structure - The detector model must follow a structure that AWS IoT Events supports.
      - expression-syntax - Your expression must follow the required syntax.
      - data-type - Data types referenced in the detector model must be compatible.
      - referenced-data - You must define the data referenced in your detector model before you can use the data.
      - referenced-resource - Resources that the detector model uses must be available.
      For more information, see Running detector model analyses in the AWS IoT Events Developer Guide.
    - level (string) –
      
      The severity level of the analysis result. Based on the severity level, analysis results fall into three general categories:
      - INFO - An information result tells you about a significant field in your detector model. This type of result usually doesn’t require immediate action.
      - WARNING - A warning result draws special attention to fields that might cause issues for your detector model. We recommend that you review warnings and take necessary actions before you use your detector model in production environments. Otherwise, the detector model might not work as expected.
      - ERROR - An error result notifies you about a problem found in your detector model. You must fix all errors before you can publish your detector model.
    - message (string) –
      
      Contains additional information about the analysis result.
    - locations (list) –
      
      Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.
      - (dict) –
        
        Contains information that you can use to locate the field in your detector model that the analysis result references.
        
        path (string) –
        
        A JsonPath expression that identifies the error field in your detector model.
- nextToken (string) –
  
  The token that you can use to return the next set of results, or null if there are no more results.

Exceptions

IoTEvents.Client.exceptions.InvalidRequestException
IoTEvents.Client.exceptions.ResourceNotFoundException
IoTEvents.Client.exceptions.ThrottlingException
IoTEvents.Client.exceptions.InternalFailureException
IoTEvents.Client.exceptions.ServiceUnavailableException