Skip to content

Lookup Events

cloudtrail_lookup_events R Documentation

Looks up management events or CloudTrail Insights events that are captured by CloudTrail

Description

Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a Region within the last 90 days.

lookup_events returns recent Insights events for trails that enable Insights. To view Insights events for an event data store, you can run queries on your Insights event data store, and you can also view the Lake dashboard for Insights.

Lookup supports the following attributes for management events:

  • Amazon Web Services access key

  • Event ID

  • Event name

  • Event source

  • Read only

  • Resource name

  • Resource type

  • User name

Lookup supports the following attributes for Insights events:

  • Event ID

  • Event name

  • Event source

All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.

The rate of lookup requests is limited to two per second, per account, per Region. If this limit is exceeded, a throttling error occurs.

Usage

cloudtrail_lookup_events(LookupAttributes, StartTime, EndTime,
  EventCategory, MaxResults, NextToken)

Arguments

LookupAttributes

Contains a list of lookup attributes. Currently the list can contain only one item.

StartTime

Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.

EndTime

Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.

EventCategory

Specifies the event category. If you do not specify an event category, events of the category are not returned in the response. For example, if you do not specify insight as the value of EventCategory, no Insights events are returned.

MaxResults

The number of events to return. Possible values are 1 through 50. The default is 50.

NextToken

The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

Value

A list with the following syntax: 

list(
  Events = list(
    list(
      EventId = "string",
      EventName = "string",
      ReadOnly = "string",
      AccessKeyId = "string",
      EventTime = as.POSIXct(
        "2015-01-01"
      ),
      EventSource = "string",
      Username = "string",
      Resources = list(
        list(
          ResourceType = "string",
          ResourceName = "string"
        )
      ),
      CloudTrailEvent = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$lookup_events(
  LookupAttributes = list(
    list(
      AttributeKey = "EventId"|"EventName"|"ReadOnly"|"Username"|"ResourceType"|"ResourceName"|"EventSource"|"AccessKeyId",
      AttributeValue = "string"
    )
  ),
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  EventCategory = "insight",
  MaxResults = 123,
  NextToken = "string"
)