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.

Synopsis¶

  list-searches
--workspace-name <value>
[--list-searches-filters <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--workspace-name (string) [required]

The name of the workspace whose searches are listed.

Constraints:

min: 1

max: 64

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

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

Constraints:

min: 1

max: 4

(string)

The lifecycle status of a search.

Possible values:

QUEUED

RUNNING

SUCCEEDED

FAILED

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.

Constraints:

min: 1

max: 100

(string)

A caller-supplied identifier used to group related searches together.

Constraints:

min: 2

max: 36

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

searchTypeFilter -> (list)

Returns only searches whose searchType is one of the listed values.

Constraints:

min: 1

max: 2

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

Possible values:

DEEP

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", ...]
}

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

Constraints:

min: 1

max: 1000

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
yaml
yaml-stream
off

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

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) [required]

The unique identifier of the search.

Constraints:

min: 23

max: 36

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

workspaceName -> (string) [required]

The name of the workspace the search runs against.

Constraints:

min: 1

max: 64

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

status -> (string) [required]

The current status of the search.

Possible values:

QUEUED

RUNNING

SUCCEEDED

FAILED

queryStatement -> (string) [required]

The natural-language query that was submitted for the search.

Constraints:

min: 1

max: 5000

searchType -> (string) [required]

The search strategy used for the search.

Possible values:

DEEP

QUICK

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.

Constraints:

min: 2

max: 36

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

nextToken -> (string)

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

Constraints:

min: 1

max: 4096

pattern: [A-Za-z0-9+/=]+

Table of Contents

Feedback

User Guide