- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
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
DownloadDBLogFilePortionCommand Input
Parameter | Type | Description |
---|
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:
|
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.
|
DownloadDBLogFilePortionCommand Output
Parameter | Type | Description |
---|
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 |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
DBInstanceNotFoundFault | client | |
DBInstanceNotReadyFault | server | An attempt to download or examine log files didn't succeed because an Aurora Serverless v2 instance was paused. |
DBLogFileNotFoundFault | client | |
RDSServiceException | Base exception class for all service exceptions from RDS service. |