Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iotsitewise ]

start-search

Description

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.

See also: AWS API Documentation

Synopsis

  start-search
--workspace-name <value>
--query-statement <value>
[--client-token <value>]
[--search-type <value>]
[--search-filters <value>]
[--group-id <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--workspace-name (string)

The name of the workspace whose data is searched.

--query-statement (string)

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

--client-token (string)

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.

--search-type (string)

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

Possible values:

• DEEP
• QUICK

--search-filters (structure)

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

timeSeriesIds -> (list)

Restricts the search to these time series.

(string)

datasetIds -> (list)

Restricts the search to these datasets.

(string)

Unique identifier for a dataset (UUID format)

timeIntervals -> (list)

Restricts the search to these time intervals.

(structure)

Contains a time interval with a start time and an end time. Use a time interval to restrict an operation, such as a search, to a specific time range.

startTime -> (structure)

The start of the time interval.

timeInSeconds -> (long)

The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos .

offsetInNanos -> (integer)

The nanosecond offset from timeInSeconds .

endTime -> (structure)

The end of the time interval.

timeInSeconds -> (long)

The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos .

offsetInNanos -> (integer)

The nanosecond offset from timeInSeconds .

JSON Syntax:

{
  "timeSeriesIds": ["string", ...],
  "datasetIds": ["string", ...],
  "timeIntervals": [
    {
      "startTime": {
        "timeInSeconds": long,
        "offsetInNanos": integer
      },
      "endTime": {
        "timeInSeconds": long,
        "offsetInNanos": integer
      }
    }
    ...
  ]
}

--group-id (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

searchId -> (string)

The unique identifier assigned to the newly started search.

workspaceName -> (string)

The name of the workspace the search runs against.

status -> (string)

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

groupId -> (string)

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