Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StartSearch

Starts an asynchronous search over the data in a workspace. The search runs in the background; the response returns immediately with a searchId and an initial status of QUEUED. Use DescribeSearch to poll for completion and GetSearchResults to retrieve the results once the search reaches SUCCEEDED. The request is idempotent on clientToken: repeating a call with the same token returns the original search instead of starting a new one.

Request Syntax


POST /workspaces/workspaceName/searches HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "groupId": "string",
   "queryStatement": "string",
   "searchFilters": { 
      "datasetIds": [ "string" ],
      "timeIntervals": [ 
         { 
            "endTime": { 
               "offsetInNanos": number,
               "timeInSeconds": number
            },
            "startTime": { 
               "offsetInNanos": number,
               "timeInSeconds": number
            }
         }
      ],
      "timeSeriesIds": [ "string" ]
   },
   "searchType": "string"
}

URI Request Parameters

The request uses the following URI parameters.

workspaceName

The name of the workspace whose data is searched.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

A unique, case-sensitive identifier you provide to ensure the request is idempotent. Repeating a StartSearch call with the same clientToken returns the original search rather than starting a new one. If omitted, the SDK autogenerates one.

Type: String

Length Constraints: Minimum length of 36. Maximum length of 64.

Pattern: \S{36,64}

Required: No

groupId

An optional caller-supplied identifier used to group related searches together.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]*

Required: No

queryStatement

The natural-language query describing the data to search for.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 5000.

Required: Yes

searchFilters

Optional filters that restrict the search to a subset of the workspace's data.

Type: SearchFilters object

Required: No

searchType

The search strategy to use. Defaults to QUICK when omitted.

Type: String

Valid Values: DEEP | QUICK

Required: No

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "groupId": "string",
   "searchId": "string",
   "status": "string",
   "workspaceName": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

groupId

The group identifier associated with the search, if one was supplied on the request.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]*

searchId

The unique identifier assigned to the newly started search.

Type: String

Length Constraints: Minimum length of 23. Maximum length of 36.

Pattern: [a-zA-Z0-9]+(-[a-zA-Z0-9]+)*

status

The initial status of the search. A newly started search is QUEUED.

Type: String

Valid Values: QUEUED | RUNNING | SUCCEEDED | FAILED

workspaceName

The name of the workspace the search runs against.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

Access is denied.

HTTP Status Code: 403

ConflictingOperationException

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

resourceArn: The ARN of the resource that conflicts with this operation.
resourceId: The ID of the resource that conflicts with this operation.

HTTP Status Code: 409

InternalFailureException

AWS IoT SiteWise can't process your request right now. Try again later.

HTTP Status Code: 500

InvalidRequestException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

HTTP Status Code: 400

LimitExceededException

You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

For more information, see Quotas in the AWS IoT SiteWise User Guide.

HTTP Status Code: 410

ResourceNotFoundException

The requested resource can't be found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the AWS IoT SiteWise User Guide.

HTTP Status Code: 429