Start Query

cloudtrail_start_query

R Documentation

Starts a CloudTrail Lake query¶

Description¶

Starts a CloudTrail Lake query. Use the QueryStatement parameter to provide your SQL query, enclosed in single quotation marks. Use the optional DeliveryS3Uri parameter to deliver the query results to an S3 bucket.

start_query requires you specify either the QueryStatement parameter, or a QueryAlias and any QueryParameters. In the current release, the QueryAlias and QueryParameters parameters are used only for the queries that populate the CloudTrail Lake dashboards.

Usage¶

cloudtrail_start_query(QueryStatement, DeliveryS3Uri, QueryAlias,
  QueryParameters)

Arguments¶

QueryStatement: The SQL code of your query.
DeliveryS3Uri: The URI for the S3 bucket where CloudTrail delivers the query results.
QueryAlias: The alias that identifies a query template.
QueryParameters: The query parameters for the specified QueryAlias.

Value¶

A list with the following syntax:

list(
  QueryId = "string"
)

Request syntax¶

svc$start_query(
  QueryStatement = "string",
  DeliveryS3Uri = "string",
  QueryAlias = "string",
  QueryParameters = list(
    "string"
  )
)