Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

SearchSampleQueries

Important

CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.

Searches sample queries and returns a list of sample queries that are sorted by relevance. To search for sample queries, provide a natural language SearchPhrase in English.

Request Syntax


{
   "MaxResults": number,
   "NextToken": "string",
   "SearchPhrase": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxResults

The maximum number of results to return on a single page. The default value is 10.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

NextToken

A token you can use to get the next page of results. The length constraint is in characters, not words.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 1000.

Pattern: .*

Required: No

SearchPhrase

The natural language phrase to use for the semantic search. The phrase must be in English. The length constraint is in characters, not words.

Type: String

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

Pattern: ^[ -~\n]*$

Required: Yes

Response Syntax


{
   "NextToken": "string",
   "SearchResults": [ 
      { 
         "Description": "string",
         "Name": "string",
         "Relevance": number,
         "SQL": "string"
      }
   ]
}

Response Elements

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

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

NextToken

A token you can use to get the next page of results.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 1000.

Pattern: .*

SearchResults

A list of objects containing the search results ordered from most relevant to least relevant.

Type: Array of SearchSampleQueriesSearchResult objects

Errors

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

InvalidParameterException

The request includes a parameter that is not valid.

HTTP Status Code: 400

OperationNotPermittedException

This exception is thrown when the requested operation is not permitted.

HTTP Status Code: 400

UnsupportedOperationException

This exception is thrown when the requested operation is not supported.

HTTP Status Code: 400