Skip to content

Search Sample Queries

cloudtrail_search_sample_queries R Documentation

Searches sample queries and returns a list of sample queries that are sorted by relevance

Description

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.

Usage

cloudtrail_search_sample_queries(SearchPhrase, MaxResults, NextToken)

Arguments

SearchPhrase

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

MaxResults

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

NextToken

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

Value

A list with the following syntax:

list(
  SearchResults = list(
    list(
      Name = "string",
      Description = "string",
      SQL = "string",
      Relevance = 123.0
    )
  ),
  NextToken = "string"
)

Request syntax

svc$search_sample_queries(
  SearchPhrase = "string",
  MaxResults = 123,
  NextToken = "string"
)