IoTSiteWise / Client / describe_search

describe_search¶

IoTSiteWise.Client.describe_search(**kwargs)¶

Returns the current status and metadata of a single search, including the query that was submitted, the search type, and — when the search has failed — the reason. Use this to poll a search started with StartSearch until it reaches a terminal status ( SUCCEEDED or FAILED).

Request Syntax

response = client.describe_search(
    workspaceName='string',
    searchId='string'
)

Parameters:

workspaceName (string) –
[REQUIRED]

The name of the workspace the search belongs to.
searchId (string) –
[REQUIRED]

The identifier of the search to describe.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –

Output of the DescribeSearch operation.
- 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.

describe_search¶

Request Syntax

Response Syntax

Response Structure

Exceptions