DownloadDBLogFilePortionCommand

Downloads all or a portion of the specified log file, up to 1 MB in size.

This command doesn't apply to RDS Custom.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { RDSClient, DownloadDBLogFilePortionCommand } from "@aws-sdk/client-rds"; // ES Modules import
// const { RDSClient, DownloadDBLogFilePortionCommand } = require("@aws-sdk/client-rds"); // CommonJS import
const client = new RDSClient(config);
const input = { // DownloadDBLogFilePortionMessage
  DBInstanceIdentifier: "STRING_VALUE", // required
  LogFileName: "STRING_VALUE", // required
  Marker: "STRING_VALUE",
  NumberOfLines: Number("int"),
};
const command = new DownloadDBLogFilePortionCommand(input);
const response = await client.send(command);
// { // DownloadDBLogFilePortionDetails
//   LogFileData: "STRING_VALUE",
//   Marker: "STRING_VALUE",
//   AdditionalDataPending: true || false,
// };

Example Usage

 There was an error loading the code editor. Retry

DownloadDBLogFilePortionCommand Input

Parameter
Type
Description
DBInstanceIdentifier
Required
string | undefined

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.

LogFileName
Required
string | undefined

The name of the log file to be downloaded.

Marker
string | undefined

The pagination token provided in the previous request or "0". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.

NumberOfLines
number | undefined

The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.

If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.

  • If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first.

  • If NumberOfLines is specified and Marker isn't specified, then the most recent lines from the end of the log file are returned.

  • If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned.

  • You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.

DownloadDBLogFilePortionCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
AdditionalDataPending
boolean | undefined

A Boolean value that, if true, indicates there is more data to be downloaded.

LogFileData
string | undefined

Entries from the specified log file.

Marker
string | undefined

A pagination token that can be used in a later DownloadDBLogFilePortion request.

Throws

Name
Fault
Details
DBInstanceNotFoundFault
client

DBInstanceIdentifier doesn't refer to an existing DB instance.

DBInstanceNotReadyFault
server

An attempt to download or examine log files didn't succeed because an Aurora Serverless v2 instance was paused.

DBLogFileNotFoundFault
client

LogFileName doesn't refer to an existing DB log file.

RDSServiceException
Base exception class for all service exceptions from RDS service.