RDS / Paginator / DescribeDBLogFiles

DescribeDBLogFiles

class RDS.Paginator.DescribeDBLogFiles

paginator = client.get_paginator('describe_db_log_files')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DBInstanceIdentifier='string',
    FilenameContains='string',
    FileLastWritten=123,
    FileSize=123,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                '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.

• FilenameContains (string) – Filters the available log files for log file names that contain the specified string.

• FileLastWritten (integer) – Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

• FileSize (integer) – Filters the available log files for files larger than the specified size.

• Filters (list) –

  This parameter isn’t currently supported.

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

    Note

    Currently, wildcards are not supported in filters.

    The following actions can be filtered:

    • DescribeDBClusterBacktracks

    • DescribeDBClusterEndpoints

    • DescribeDBClusters

    • DescribeDBInstances

    • DescribePendingMaintenanceActions

    • Name (string) – [REQUIRED]

      The name of the filter. Filter names are case-sensitive.

    • Values (list) – [REQUIRED]

      One or more filter values. Filter values are case-sensitive.

      • (string) –

• 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

{
    'DescribeDBLogFiles': [
        {
            'LogFileName': 'string',
            'LastWritten': 123,
            'Size': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  The response from a call to DescribeDBLogFiles.

  • DescribeDBLogFiles (list) –

    The DB log files returned.

    • (dict) –

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

      • LogFileName (string) –

        The name of the log file for the specified DB instance.

      • LastWritten (integer) –

        A POSIX timestamp when the last log entry was written.

      • Size (integer) –

        The size, in bytes, of the log file for the specified DB instance.

  • NextToken (string) –

    A token to resume pagination.