Returns information about backtracks for a DB cluster.
For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
Note
This action only applies to Aurora MySQL DB clusters.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
describe-db-cluster-backtracks
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: DBClusterBacktracks
describe-db-cluster-backtracks
--db-cluster-identifier <value>
[--backtrack-identifier <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
--db-cluster-identifier
(string)
The DB cluster identifier of the DB cluster to be described. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Can’t end with a hyphen or contain two consecutive hyphens.
Example:
my-cluster1
--backtrack-identifier
(string)
If specified, this value is the backtrack identifier of the backtrack to be described.
Constraints:
Must contain a valid universally unique identifier (UUID). For more information about UUIDs, see A Universally Unique Identifier (UUID) URN Namespace .
Example:
123e4567-e89b-12d3-a456-426655440000
--filters
(list)
A filter that specifies one or more DB clusters to describe. Supported filters include the following:
db-cluster-backtrack-id
- Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers.
db-cluster-backtrack-status
- Accepts any of the following backtrack status values:
applying
completed
failed
pending
The results list includes information about only the backtracks identified by these values.
(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 backtracks for a DB cluster
The following describe-db-cluster-backtracks
example retrieves details about the specified DB cluster.
aws rds describe-db-cluster-backtracks \
--db-cluster-identifier mydbcluster
Output:
{
"DBClusterBacktracks": [
{
"DBClusterIdentifier": "mydbcluster",
"BacktrackIdentifier": "2f5f5294-0dd2-44c9-9f50-EXAMPLE",
"BacktrackTo": "2021-02-12T04:59:22Z",
"BacktrackedFrom": "2021-02-12T14:37:31.640Z",
"BacktrackRequestCreationTime": "2021-02-12T14:36:18.819Z",
"Status": "COMPLETED"
},
{
"DBClusterIdentifier": "mydbcluster",
"BacktrackIdentifier": "3c7a6421-af2a-4ea3-ae95-EXAMPLE",
"BacktrackTo": "2021-02-11T22:53:46Z",
"BacktrackedFrom": "2021-02-12T00:09:27.006Z",
"BacktrackRequestCreationTime": "2021-02-12T00:07:53.487Z",
"Status": "COMPLETED"
}
]
}
For more information, see Backtracking an Aurora DB cluster in the Amazon Aurora User Guide.
Marker -> (string)
A pagination token that can be used in a later
DescribeDBClusterBacktracks
request.
DBClusterBacktracks -> (list)
Contains a list of backtracks for the user.
(structure)
This data type is used as a response element in the
DescribeDBClusterBacktracks
action.DBClusterIdentifier -> (string)
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
BacktrackIdentifier -> (string)
Contains the backtrack identifier.
BacktrackTo -> (timestamp)
The timestamp of the time to which the DB cluster was backtracked.
BacktrackedFrom -> (timestamp)
The timestamp of the time from which the DB cluster was backtracked.
BacktrackRequestCreationTime -> (timestamp)
The timestamp of the time at which the backtrack was requested.
Status -> (string)
The status of the backtrack. This property returns one of the following values:
applying
- The backtrack is currently being applied to or rolled back from the DB cluster.
completed
- The backtrack has successfully been applied to or rolled back from the DB cluster.
failed
- An error occurred while the backtrack was applied to or rolled back from the DB cluster.
pending
- The backtrack is currently pending application to or rollback from the DB cluster.