RDS / Paginator / DownloadDBLogFilePortion

DownloadDBLogFilePortion

class RDS.Paginator.DownloadDBLogFilePortion

paginator = client.get_paginator('download_db_log_file_portion')

paginate(**kwargs)

Creates an iterator that will paginate through responses from RDS.Client.download_db_log_file_portion().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DBInstanceIdentifier='string',
    LogFileName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

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

  • LogFileData (string) –

    Entries from the specified log file.

  • AdditionalDataPending (boolean) –

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

  • NextToken (string) –

    A token to resume pagination.