Skip to content

List Queries

cloudtrail_list_queries R Documentation

Returns a list of queries and query statuses for the past seven days

Description

Returns a list of queries and query statuses for the past seven days. You must specify an ARN value for EventDataStore. Optionally, to shorten the list of results, you can specify a time range, formatted as timestamps, by adding StartTime and EndTime parameters, and a QueryStatus value. Valid values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED.

Usage

cloudtrail_list_queries(EventDataStore, NextToken, MaxResults,
  StartTime, EndTime, QueryStatus)

Arguments

EventDataStore

[required] The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.

NextToken

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

MaxResults

The maximum number of queries to show on a page.

StartTime

Use with EndTime to bound a list_queries request, and limit its results to only those queries run within a specified time period.

EndTime

Use with StartTime to bound a list_queries request, and limit its results to only those queries run within a specified time period.

QueryStatus

The status of queries that you want to return in results. Valid values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED.

Value

A list with the following syntax: 

list(
  Queries = list(
    list(
      QueryId = "string",
      QueryStatus = "QUEUED"|"RUNNING"|"FINISHED"|"FAILED"|"CANCELLED"|"TIMED_OUT",
      CreationTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_queries(
  EventDataStore = "string",
  NextToken = "string",
  MaxResults = 123,
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  QueryStatus = "QUEUED"|"RUNNING"|"FINISHED"|"FAILED"|"CANCELLED"|"TIMED_OUT"
)