describe_db_cluster_automated_backups¶
Operation¶
describe_db_cluster_automated_backups
¶
describe_db_cluster_automated_backups(request: DescribeDBClusterAutomatedBackupsInput | DescribeDBClusterAutomatedBackupsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBClusterAutomatedBackupsInputDict]) -> DescribeDBClusterAutomatedBackupsOutput
Displays backups for both current and deleted DB clusters. For example,
use this operation to find details about automated backups for
previously deleted clusters. Current clusters are returned for both the
DescribeDBClusterAutomatedBackups and DescribeDBClusters operations.
All parameters are optional.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeDBClusterAutomatedBackupsInput | DescribeDBClusterAutomatedBackupsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DescribeDBClusterAutomatedBackupsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeDBClusterAutomatedBackupsOutput
|
An instance of |
describe_db_cluster_automated_backups
async
¶
describe_db_cluster_automated_backups(request: DescribeDBClusterAutomatedBackupsInput | DescribeDBClusterAutomatedBackupsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBClusterAutomatedBackupsInputDict]) -> DescribeDBClusterAutomatedBackupsOutput
Displays backups for both current and deleted DB clusters. For example,
use this operation to find details about automated backups for
previously deleted clusters. Current clusters are returned for both the
DescribeDBClusterAutomatedBackups and DescribeDBClusters operations.
All parameters are optional.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeDBClusterAutomatedBackupsInput | DescribeDBClusterAutomatedBackupsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DescribeDBClusterAutomatedBackupsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeDBClusterAutomatedBackupsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DescribeDBClusterAutomatedBackupsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeDBClusterAutomatedBackupsInput.
Attributes¶
db_cluster_identifier
instance-attribute
¶
db_cluster_identifier: str | None
(Optional) The user-supplied DB cluster identifier. If this parameter is specified, it must match the identifier of an existing DB cluster. It returns information from the specific DB cluster's automated backup. This parameter isn't case-sensitive.
db_cluster_resource_id
instance-attribute
¶
db_cluster_resource_id: str | None
The resource ID of the DB cluster that is the source of the automated backup. This parameter isn't case-sensitive.
filters
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
A filter that specifies which resources to return based on status.
Supported filters are the following:
-
status -
retained- Automated backups for deleted clusters and after backup replication is stopped. -
db-cluster-id- Accepts DB cluster identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB cluster automated backups identified by these ARNs. -
db-cluster-resource-id- Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB cluster resources identified by these ARNs.
Returns all resources by default. The status for each resource is specified in the response.
DescribeDBClusterAutomatedBackupsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeDBClusterAutomatedBackupsInput structure.
Attributes¶
db_cluster_identifier
class-attribute
instance-attribute
¶
db_cluster_identifier: str | None = ...
(Optional) The user-supplied DB cluster identifier. If this parameter is specified, it must match the identifier of an existing DB cluster. It returns information from the specific DB cluster's automated backup. This parameter isn't case-sensitive.
db_cluster_resource_id
class-attribute
instance-attribute
¶
db_cluster_resource_id: str | None = ...
The resource ID of the DB cluster that is the source of the automated backup. This parameter isn't case-sensitive.
filters
class-attribute
instance-attribute
¶
A filter that specifies which resources to return based on status.
Supported filters are the following:
-
status -
retained- Automated backups for deleted clusters and after backup replication is stopped. -
db-cluster-id- Accepts DB cluster identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB cluster automated backups identified by these ARNs. -
db-cluster-resource-id- Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB cluster resources identified by these ARNs.
Returns all resources by default. The status for each resource is specified in the response.
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 that you can retrieve the
remaining results.
Output¶
DescribeDBClusterAutomatedBackupsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeDBClusterAutomatedBackupsOutput structure.
Attributes¶
db_cluster_automated_backups
class-attribute
instance-attribute
¶
db_cluster_automated_backups: list[DBClusterAutomatedBackup] | None = ...
A list of DBClusterAutomatedBackup backups.
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.
response_metadata
class-attribute
instance-attribute
¶
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.