List Event Logs

codecatalyst_list_event_logs

R Documentation

Retrieves a list of events that occurred during a specific time in a space

Description

Retrieves a list of events that occurred during a specific time in a space. You can use these events to audit user and system activity in a space. For more information, see Monitoring in the Amazon CodeCatalyst User Guide.

ListEventLogs guarantees events for the last 30 days in a given space. You can also view and retrieve a list of management events over the last 90 days for Amazon CodeCatalyst in the CloudTrail console by viewing Event history, or by creating a trail to create and maintain a record of events that extends past 90 days. For more information, see Working with CloudTrail Event History and Working with CloudTrail trails.

Usage

codecatalyst_list_event_logs(spaceName, startTime, endTime, eventName,
  nextToken, maxResults)

Arguments

spaceName

[required] The name of the space.

startTime

[required] The date and time when you want to start retrieving events, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

endTime

[required] The time after which you do not want any events retrieved, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

eventName

The name of the event.

nextToken

A token returned from a call to this API to indicate the next batch of results to return, if any.

maxResults

The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

Value

A list with the following syntax:

list(
  nextToken = "string",
  items = list(
    list(
      id = "string",
      eventName = "string",
      eventType = "string",
      eventCategory = "string",
      eventSource = "string",
      eventTime = as.POSIXct(
        "2015-01-01"
      ),
      operationType = "READONLY"|"MUTATION",
      userIdentity = list(
        userType = "USER"|"AWS_ACCOUNT"|"UNKNOWN",
        principalId = "string",
        userName = "string",
        awsAccountId = "string"
      ),
      projectInformation = list(
        name = "string",
        projectId = "string"
      ),
      requestId = "string",
      requestPayload = list(
        contentType = "string",
        data = "string"
      ),
      responsePayload = list(
        contentType = "string",
        data = "string"
      ),
      errorCode = "string",
      sourceIpAddress = "string",
      userAgent = "string"
    )
  )
)

Request syntax

svc$list_event_logs(
  spaceName = "string",
  startTime = as.POSIXct(
    "2015-01-01"
  ),
  endTime = as.POSIXct(
    "2015-01-01"
  ),
  eventName = "string",
  nextToken = "string",
  maxResults = 123
)