Skip to content

RDS  >  Operations  >  describe_db_log_files

describe_db_log_files

Operation

describe_db_log_files async

describe_db_log_files(request: DescribeDBLogFilesInput | DescribeDBLogFilesInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeDBLogFilesOutput
describe_db_log_files(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBLogFilesInputDict]) -> DescribeDBLogFilesOutput

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

This command doesn't apply to RDS Custom.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeDBLogFilesOutput

An instance of DescribeDBLogFilesOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribeDBLogFilesInput dataclass

Bases: _SerdeShape

Attributes
db_instance_identifier class-attribute instance-attribute
db_instance_identifier: str | None = ...

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.
file_last_written class-attribute instance-attribute
file_last_written: int | None = ...

Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

file_size class-attribute instance-attribute
file_size: int | None = ...

Filters the available log files for files larger than the specified size.

filename_contains class-attribute instance-attribute
filename_contains: str | None = ...

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

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

This parameter isn't currently supported.

marker class-attribute instance-attribute
marker: str | None = ...

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

max_records class-attribute instance-attribute
max_records: int | None = ...

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.

Dictionaries

DescribeDBLogFilesInputDict

Bases: TypedDict

Dictionary form of DescribeDBLogFilesInput.

Attributes
db_instance_identifier instance-attribute
db_instance_identifier: Required[str]

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.
file_last_written instance-attribute
file_last_written: int | None

Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

file_size instance-attribute
file_size: int | None

Filters the available log files for files larger than the specified size.

filename_contains instance-attribute
filename_contains: str | None

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

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

This parameter isn't currently supported.

marker instance-attribute
marker: str | None

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

max_records instance-attribute
max_records: int | None

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.

Output

DescribeDBLogFilesOutput dataclass

Bases: _SerdeShape

The response from a call to DescribeDBLogFiles.

Attributes

describe_db_log_files class-attribute instance-attribute
describe_db_log_files: list[DescribeDBLogFilesDetails] | None = ...

The DB log files returned.

marker class-attribute instance-attribute
marker: str | None = ...

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

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.