describe_db_cluster_automated_backups ¶

def describe_db_cluster_automated_backups(
    self,
    *,
    config_overrides: Optional[RDSClientConfig] = None,
    db_cluster_resource_id: Optional["capo_rds.types.string.String"] = None,
    db_cluster_identifier: Optional["capo_rds.types.string.String"] = None,
    filters: Optional["capo_rds.types.filter_list.FilterList"] = None,
    max_records: Optional["capo_rds.types.integer_optional.IntegerOptional"] = None,
    marker: Optional["capo_rds.types.string.String"] = None,
) -> "capo_rds.types.db_cluster_automated_backup_message.DBClusterAutomatedBackupMessage":
    """<p>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 <code>DescribeDBClusterAutomatedBackups</code> and <code>DescribeDBClusters</code> operations.</p> <p>All parameters are optional.</p>

    Args:
        db_cluster_resource_id: <p>The resource ID of the DB cluster that is the source of the automated backup. This parameter isn't case-sensitive.</p>
        db_cluster_identifier: <p>(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.</p>
        filters: <p>A filter that specifies which resources to return based on status.</p> <p>Supported filters are the following:</p> <ul> <li> <p> <code>status</code> </p> <ul> <li> <p> <code>retained</code> - Automated backups for deleted clusters and after backup replication is stopped.</p> </li> </ul> </li> <li> <p> <code>db-cluster-id</code> - 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.</p> </li> <li> <p> <code>db-cluster-resource-id</code> - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB cluster resources identified by these ARNs.</p> </li> </ul> <p>Returns all resources by default. The status for each resource is specified in the response.</p>
        max_records: <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.</p>
        marker: <p>The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to <code>MaxRecords</code>.</p>

    Raises:
        capo_rds.errors.db_cluster_automated_backup_not_found_fault.DBClusterAutomatedBackupNotFoundFault: <p>No automated backup for this DB cluster was found.</p>
        capo_rds.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_rds.types.describe_db_cluster_automated_backups_message.DescribeDBClusterAutomatedBackupsMessage]",
    ) -> OperationResponse[
        "capo_rds.types.db_cluster_automated_backup_message.DBClusterAutomatedBackupMessage"
    ]:
        import capo_rds._operations.amazon_rd_sv19.describe_db_cluster_automated_backups

        output, http_response = (
            capo_rds._operations.amazon_rd_sv19.describe_db_cluster_automated_backups.describe_db_cluster_automated_backups(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeDBClusterAutomatedBackups")
    )
    input_: capo_rds.types.describe_db_cluster_automated_backups_message.DescribeDBClusterAutomatedBackupsMessage = {}
    if db_cluster_resource_id is not None:
        input_["db_cluster_resource_id"] = db_cluster_resource_id
    if db_cluster_identifier is not None:
        input_["db_cluster_identifier"] = db_cluster_identifier
    if filters is not None:
        input_["filters"] = filters
    if max_records is not None:
        input_["max_records"] = max_records
    if marker is not None:
        input_["marker"] = marker

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output