Skip to content

Returns a list of DB log files for the DB instance

Description

Returns a list of DB log files for the DB instance.

This command doesn't apply to RDS Custom.

Usage

rds_describe_db_log_files(DBInstanceIdentifier, FilenameContains,
  FileLastWritten, FileSize, Filters, MaxRecords, Marker)

Arguments

  • DBInstanceIdentifier

    [required] The customer-assigned name of the DB instance that contains the log files you want to list.

    Constraints:

    • Must match the identifier of an existing DBInstance.

  • FilenameContains

    Filters the available log files for log file names that contain the specified string.

  • FileLastWritten

    Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

  • FileSize

    Filters the available log files for files larger than the specified size.

  • Filters

    This parameter isn't currently supported.

  • MaxRecords

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

  • Marker

    The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

Value

A list with the following syntax:

list(
  DescribeDBLogFiles = list(
    list(
      LogFileName = "string",
      LastWritten = 123,
      Size = 123
    )
  ),
  Marker = "string"
)

Request syntax

svc$describe_db_log_files(
  DBInstanceIdentifier = "string",
  FilenameContains = "string",
  FileLastWritten = 123,
  FileSize = 123,
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxRecords = 123,
  Marker = "string"
)

Examples

# This example lists matching log file names for the specified DB
# instance, file name pattern, last write date in POSIX time with
# milleseconds, and minimum file size.
svc$describe_db_log_files(
  DBInstanceIdentifier = "mymysqlinstance",
  FileLastWritten = 1470873600000,
  FileSize = 0L,
  FilenameContains = "error"
)