Returns a list of DB log files for the DB instance.
This command doesn’t apply to RDS Custom.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
describe-db-log-files
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: DescribeDBLogFiles
describe-db-log-files
--db-instance-identifier <value>
[--filename-contains <value>]
[--file-last-written <value>]
[--file-size <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
--db-instance-identifier
(string)
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.
--filename-contains
(string)
Filters the available log files for log file names that contain the specified string.
--file-last-written
(long)
Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.
--file-size
(long)
Filters the available log files for files larger than the specified size.
--filters
(list)
This parameter isn’t currently supported.
(structure)
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)
The name of the filter. Filter names are case-sensitive.
Values -> (list)
One or more filter values. Filter values are case-sensitive.
(string)
Shorthand Syntax:
Name=string,Values=string,string ...
JSON Syntax:
[
{
"Name": "string",
"Values": ["string", ...]
}
...
]
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size
(integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command’s output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To describe the log files for a DB instance
The following describe-db-log-files
example retrieves details about the log files for the specified DB instance.
aws rds describe-db-log-files -\
-db-instance-identifier test-instance
Output:
{
"DescribeDBLogFiles": [
{
"Size": 0,
"LastWritten": 1533060000000,
"LogFileName": "error/mysql-error-running.log"
},
{
"Size": 2683,
"LastWritten": 1532994300000,
"LogFileName": "error/mysql-error-running.log.0"
},
{
"Size": 107,
"LastWritten": 1533057300000,
"LogFileName": "error/mysql-error-running.log.18"
},
{
"Size": 13105,
"LastWritten": 1532991000000,
"LogFileName": "error/mysql-error-running.log.23"
},
{
"Size": 0,
"LastWritten": 1533061200000,
"LogFileName": "error/mysql-error.log"
},
{
"Size": 3519,
"LastWritten": 1532989252000,
"LogFileName": "mysqlUpgrade"
}
]
}
DescribeDBLogFiles -> (list)
The DB log files returned.
(structure)
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 -> (long)
A POSIX timestamp when the last log entry was written.
Size -> (long)
The size, in bytes, of the log file for the specified DB instance.
Marker -> (string)
A pagination token that can be used in a later DescribeDBLogFiles request.