AWS CLI Command Reference

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 ]

list-searches

Description

Lists the searches in a workspace, most recently started first. Results can be narrowed with optional filters (status, search type, group, and started-at time range) and are paginated: when nextToken is present, pass it on a subsequent call to retrieve the next page.

See also: AWS API Documentation

list-searches is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: searchSummaries

Synopsis

  list-searches
--workspace-name <value>
[--list-searches-filters <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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 searches are listed.

--list-searches-filters (structure)

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 -> (timestamp)

Returns only searches started at or after this time.

startedBefore -> (timestamp)

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 .

Shorthand Syntax:

statusFilter=string,string,startedAfter=timestamp,startedBefore=timestamp,groupIdFilter=string,string,searchTypeFilter=string,string

JSON Syntax:

{
  "statusFilter": ["QUEUED"|"RUNNING"|"SUCCEEDED"|"FAILED", ...],
  "startedAfter": timestamp,
  "startedBefore": timestamp,
  "groupIdFilter": ["string", ...],
  "searchTypeFilter": ["DEEP"|"QUICK", ...]
}

--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.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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

searchSummaries -> (list)

A page of search summaries, most recently started first.

(structure)

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 -> (timestamp)

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)

The pagination token to use in a subsequent ListSearches call to retrieve the next page. Absent when there are no more searches.