Skip to content

Get Relational Database Log Events

lightsail_get_relational_database_log_events R Documentation

Returns a list of log events for a database in Amazon Lightsail

Description

Returns a list of log events for a database in Amazon Lightsail.

Usage

lightsail_get_relational_database_log_events(relationalDatabaseName,
  logStreamName, startTime, endTime, startFromHead, pageToken)

Arguments

relationalDatabaseName

[required] The name of your database for which to get log events.

logStreamName

[required] The name of the log stream.

Use the ⁠get relational database log streams⁠ operation to get a list of available log streams.

startTime

The start of the time interval from which to get log events.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start time.

endTime

The end of the time interval from which to get log events.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end time.

startFromHead

Parameter to specify if the log should start from head or tail. If true is specified, the log event starts from the head of the log. If false is specified, the log event starts from the tail of the log.

For PostgreSQL, the default value of false is the only option available.

pageToken

The token to advance to the next or previous page of results from your request.

To get a page token, perform an initial get_relational_database_log_events request. If your results are paginated, the response will return a next forward token and/or next backward token that you can specify as the page token in a subsequent request.

Value

A list with the following syntax: 

list(
  resourceLogEvents = list(
    list(
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      message = "string"
    )
  ),
  nextBackwardToken = "string",
  nextForwardToken = "string"
)

Request syntax

svc$get_relational_database_log_events(
  relationalDatabaseName = "string",
  logStreamName = "string",
  startTime = as.POSIXct(
    "2015-01-01"
  ),
  endTime = as.POSIXct(
    "2015-01-01"
  ),
  startFromHead = TRUE|FALSE,
  pageToken = "string"
)