SearchSummary

A summary of a single search as returned by ListSearches.

queryStatement

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

Type: String

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

Required: Yes

searchId

The unique identifier of the search.

Type: String

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

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

Required: Yes

searchType

The search strategy used for the search.

Type: String

Valid Values: DEEP | QUICK

Required: Yes

status

The current status of the search.

Type: String

Valid Values: QUEUED | RUNNING | SUCCEEDED | FAILED

Required: Yes

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_-]+$

Required: Yes

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

Required: No

startedAt

The time at which the search was started.

Type: Timestamp

Required: No

statusReason

A human-readable explanation of the current status. Populated when the search has FAILED.

Type: String

Required: No

Contents