Skip to content

RDS  >  Operations  >  describe_db_cluster_backtracks

describe_db_cluster_backtracks

Operation

describe_db_cluster_backtracks async

describe_db_cluster_backtracks(request: DescribeDBClusterBacktracksInput | DescribeDBClusterBacktracksInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeDBClusterBacktracksOutput
describe_db_cluster_backtracks(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBClusterBacktracksInputDict]) -> DescribeDBClusterBacktracksOutput

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.

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
DescribeDBClusterBacktracksOutput

An instance of DescribeDBClusterBacktracksOutput.

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

DescribeDBClusterBacktracksInput dataclass

Bases: _SerdeShape

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

If specified, this value is the backtrack identifier of the backtrack to be described.

Constraints:

Example: 123e4567-e89b-12d3-a456-426655440000

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

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

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

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.

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

An optional pagination token provided by a previous DescribeDBClusterBacktracks request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by 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.

Default: 100

Constraints: Minimum 20, maximum 100.

Dictionaries

DescribeDBClusterBacktracksInputDict

Bases: TypedDict

Dictionary form of DescribeDBClusterBacktracksInput.

Attributes
backtrack_identifier instance-attribute
backtrack_identifier: str | None

If specified, this value is the backtrack identifier of the backtrack to be described.

Constraints:

Example: 123e4567-e89b-12d3-a456-426655440000

db_cluster_identifier instance-attribute
db_cluster_identifier: Required[str]

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

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

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.

marker instance-attribute
marker: str | None

An optional pagination token provided by a previous DescribeDBClusterBacktracks request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by 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.

Default: 100

Constraints: Minimum 20, maximum 100.

Output

DescribeDBClusterBacktracksOutput dataclass

Bases: _SerdeShape

Contains the result of a successful invocation of the DescribeDBClusterBacktracks action.

Attributes

db_cluster_backtracks class-attribute instance-attribute
db_cluster_backtracks: list[DBClusterBacktrack] | None = ...

Contains a list of backtracks for the user.

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

A pagination token that can be used in a later DescribeDBClusterBacktracks 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.