RDS / Client / download_db_log_file_portion

download_db_log_file_portion#

RDS.Client.download_db_log_file_portion(**kwargs)#

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

This command doesn’t apply to RDS Custom.

See also: AWS API Documentation

Request Syntax

response = client.download_db_log_file_portion(
    DBInstanceIdentifier='string',
    LogFileName='string',
    Marker='string',
    NumberOfLines=123
)
Parameters:

  • DBInstanceIdentifier (string) –

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

  • LogFileName (string) –

    [REQUIRED]

    The name of the log file to be downloaded.

  • Marker (string) – 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 (integer) –

    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.

Return type:

dict

Returns:

Response Syntax

{
    'LogFileData': 'string',
    'Marker': 'string',
    'AdditionalDataPending': True|False
}

Response Structure

  • (dict) –

    This data type is used as a response element to DownloadDBLogFilePortion.

    • LogFileData (string) –

      Entries from the specified log file.

    • Marker (string) –

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

    • AdditionalDataPending (boolean) –

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

Exceptions

  • RDS.Client.exceptions.DBInstanceNotFoundFault

  • RDS.Client.exceptions.DBLogFileNotFoundFault

Examples

This example lists information for the specified log file for the specified DB instance.

response = client.download_db_log_file_portion(
    DBInstanceIdentifier='mymysqlinstance',
    LogFileName='mysqlUpgrade',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}