downloadDBLogFilePortion method

Future<DownloadDBLogFilePortionDetails> downloadDBLogFilePortion({ required String dBInstanceIdentifier, required String logFileName, String? marker, int? numberOfLines, })

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

May throw DBInstanceNotFoundFault. May throw DBLogFileNotFoundFault.

Parameter dBInstanceIdentifier : 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.

Parameter logFileName : The name of the log file to be downloaded.

Parameter marker : 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.

Parameter numberOfLines : 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.

Implementation

Future<DownloadDBLogFilePortionDetails> downloadDBLogFilePortion({
  required String dBInstanceIdentifier,
  required String logFileName,
  String? marker,
  int? numberOfLines,
}) async {
  ArgumentError.checkNotNull(dBInstanceIdentifier, 'dBInstanceIdentifier');
  ArgumentError.checkNotNull(logFileName, 'logFileName');
  final $request = <String, dynamic>{};
  $request['DBInstanceIdentifier'] = dBInstanceIdentifier;
  $request['LogFileName'] = logFileName;
  marker?.also((arg) => $request['Marker'] = arg);
  numberOfLines?.also((arg) => $request['NumberOfLines'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DownloadDBLogFilePortion',
    version: '2014-10-31',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DownloadDBLogFilePortionMessage'],
    shapes: shapes,
    resultWrapper: 'DownloadDBLogFilePortionResult',
  );
  return DownloadDBLogFilePortionDetails.fromXml($result);
}