IoTSiteWise / Paginator / ListSearches

ListSearches¶

class IoTSiteWise.Paginator.ListSearches¶

paginator = client.get_paginator('list_searches')

paginate(**kwargs)¶

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

Request Syntax

response_iterator = paginator.paginate(
    workspaceName='string',
    listSearchesFilters={
        'statusFilter': [
            'QUEUED'|'RUNNING'|'SUCCEEDED'|'FAILED',
        ],
        'startedAfter': datetime(2015, 1, 1),
        'startedBefore': datetime(2015, 1, 1),
        'groupIdFilter': [
            'string',
        ],
        'searchTypeFilter': [
            'DEEP'|'QUICK',
        ]
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

workspaceName (string) –
[REQUIRED]

The name of the workspace whose searches are listed.
listSearchesFilters (dict) –
Optional filters that restrict which searches are returned.
- statusFilter (list) –
  
  Returns only searches whose status is one of the listed values.
  - (string) –
    
    The lifecycle status of a search.
- startedAfter (datetime) –
  
  Returns only searches started at or after this time.
- startedBefore (datetime) –
  
  Returns only searches started at or before this time.
- groupIdFilter (list) –
  
  Returns only searches whose groupId is one of the listed values.
  - (string) –
    
    A caller-supplied identifier used to group related searches together.
- searchTypeFilter (list) –
  
  Returns only searches whose searchType is one of the listed values.
  - (string) –
    
    The search strategy, which trades off latency against recall. DEEP runs the full semantic and structured search for the highest-quality matches; QUICK returns faster, lower-recall results. When searchType is omitted on a request, the search defaults to QUICK.
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

{
    'searchSummaries': [
        {
            'searchId': 'string',
            'workspaceName': 'string',
            'status': 'QUEUED'|'RUNNING'|'SUCCEEDED'|'FAILED',
            'queryStatement': 'string',
            'searchType': 'DEEP'|'QUICK',
            'statusReason': 'string',
            'startedAt': datetime(2015, 1, 1),
            'groupId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –

Output of the ListSearches operation.
- searchSummaries (list) –
  
  A page of search summaries, most recently started first.
  - (dict) –
    
    A summary of a single search as returned by ListSearches.
    - searchId (string) –
      
      The unique identifier of the search.
    - workspaceName (string) –
      
      The name of the workspace the search runs against.
    - status (string) –
      
      The current status of the search.
    - queryStatement (string) –
      
      The natural-language query that was submitted for the search.
    - searchType (string) –
      
      The search strategy used for the search.
    - statusReason (string) –
      
      A human-readable explanation of the current status. Populated when the search has FAILED.
    - startedAt (datetime) –
      
      The time at which the search was started.
    - groupId (string) –
      
      The group identifier associated with the search, if one was supplied on the request.
- NextToken (string) –
  
  A token to resume pagination.