IoTSiteWise / Paginator / GetSearchResults

GetSearchResults¶

class IoTSiteWise.Paginator.GetSearchResults¶

paginator = client.get_paginator('get_search_results')

paginate(**kwargs)¶

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

Request Syntax

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

Parameters:

searchId (string) –
[REQUIRED]

The identifier of the search whose results are retrieved.
workspaceName (string) –
[REQUIRED]

The name of the workspace the search belongs to.
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

{
    'searchResults': [
        {
            'searchId': 'string',
            'workspaceName': 'string',
            'datasetId': 'string',
            'timeSeriesId': 'string',
            'startTimestamp': {
                'timeInSeconds': 123,
                'offsetInNanos': 123
            },
            'endTimestamp': {
                'timeInSeconds': 123,
                'offsetInNanos': 123
            },
            'topTimestamp': {
                'timeInSeconds': 123,
                'offsetInNanos': 123
            },
            'score': ...
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –

Output of the GetSearchResults operation.
- searchResults (list) –
  
  A page of search results, ordered by descending relevance score.
  - (dict) –
    
    A single matching segment of time-series data returned by a search.
    - searchId (string) –
      
      The identifier of the search that produced this result.
    - workspaceName (string) –
      
      The name of the workspace the search ran against.
    - datasetId (string) –
      
      The identifier of the dataset that contains the matching data.
    - timeSeriesId (string) –
      
      The identifier of the time series that contains the matching data.
    - startTimestamp (dict) –
      
      The start of the matching time-series segment, in nanoseconds since the Unix epoch.
      - timeInSeconds (integer) –
        
        The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
      - offsetInNanos (integer) –
        
        The nanosecond offset from timeInSeconds.
    - endTimestamp (dict) –
      
      The end of the matching time-series segment, in nanoseconds since the Unix epoch.
      - timeInSeconds (integer) –
        
        The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
      - offsetInNanos (integer) –
        
        The nanosecond offset from timeInSeconds.
    - topTimestamp (dict) –
      
      The timestamp of the most relevant point within the matching segment, in nanoseconds since the Unix epoch.
      - timeInSeconds (integer) –
        
        The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
      - offsetInNanos (integer) –
        
        The nanosecond offset from timeInSeconds.
    - score (float) –
      
      The relevance score of this result. Higher scores indicate a stronger match.
- NextToken (string) –
  
  A token to resume pagination.