describeDBLogFiles method

Future<DescribeDBLogFilesResponse> describeDBLogFiles({
  1. required String dBInstanceIdentifier,
  2. int? fileLastWritten,
  3. int? fileSize,
  4. String? filenameContains,
  5. List<Filter>? filters,
  6. String? marker,
  7. int? maxRecords,
})

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

May throw DBInstanceNotFoundFault.

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 fileLastWritten : Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

Parameter fileSize : Filters the available log files for files larger than the specified size.

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

Parameter filters : This parameter isn't currently supported.

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

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

Implementation

Future<DescribeDBLogFilesResponse> describeDBLogFiles({
  required String dBInstanceIdentifier,
  int? fileLastWritten,
  int? fileSize,
  String? filenameContains,
  List<Filter>? filters,
  String? marker,
  int? maxRecords,
}) async {
  ArgumentError.checkNotNull(dBInstanceIdentifier, 'dBInstanceIdentifier');
  final $request = <String, dynamic>{};
  $request['DBInstanceIdentifier'] = dBInstanceIdentifier;
  fileLastWritten?.also((arg) => $request['FileLastWritten'] = arg);
  fileSize?.also((arg) => $request['FileSize'] = arg);
  filenameContains?.also((arg) => $request['FilenameContains'] = arg);
  filters?.also((arg) => $request['Filters'] = arg);
  marker?.also((arg) => $request['Marker'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeDBLogFiles',
    version: '2014-10-31',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeDBLogFilesMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeDBLogFilesResult',
  );
  return DescribeDBLogFilesResponse.fromXml($result);
}