Skip to content

describe_db_cluster_snapshot_attributes

describe_db_cluster_snapshot_attributes(
    *,
    config_overrides: Optional[DocDBClientConfig] = None,
    db_cluster_snapshot_identifier: Optional[String] = None,
) -> DescribeDBClusterSnapshotAttributesResult

Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.

When you share snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If all is included in the list of values for the restore attribute, then the manual cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.

Parameters:

  • db_cluster_snapshot_identifier (Optional[String], default: None ) –

    The identifier for the cluster snapshot to describe the attributes for.

Raises:

Source code in docs_src/capo_docdb/_services/doc_db.py
def describe_db_cluster_snapshot_attributes(
    self,
    *,
    config_overrides: Optional[DocDBClientConfig] = None,
    db_cluster_snapshot_identifier: Optional[
        "capo_docdb.types.string.String"
    ] = None,
) -> "capo_docdb.types.describe_db_cluster_snapshot_attributes_result.DescribeDBClusterSnapshotAttributesResult":
    """<p>Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.</p> <p>When you share snapshots with other Amazon Web Services accounts, <code>DescribeDBClusterSnapshotAttributes</code> returns the <code>restore</code> attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If <code>all</code> is included in the list of values for the <code>restore</code> attribute, then the manual cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.</p>

    Args:
        db_cluster_snapshot_identifier: <p>The identifier for the cluster snapshot to describe the attributes for.</p>

    Raises:
        capo_docdb.errors.db_cluster_snapshot_not_found_fault.DBClusterSnapshotNotFoundFault: <p> <code>DBClusterSnapshotIdentifier</code> doesn't refer to an existing cluster snapshot. </p>
        capo_docdb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_docdb.types.describe_db_cluster_snapshot_attributes_message.DescribeDBClusterSnapshotAttributesMessage]",
    ) -> OperationResponse[
        "capo_docdb.types.describe_db_cluster_snapshot_attributes_result.DescribeDBClusterSnapshotAttributesResult"
    ]:
        import capo_docdb._operations.amazon_rd_sv19.describe_db_cluster_snapshot_attributes

        output, http_response = (
            capo_docdb._operations.amazon_rd_sv19.describe_db_cluster_snapshot_attributes.describe_db_cluster_snapshot_attributes(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeDBClusterSnapshotAttributes")
    )
    input_: capo_docdb.types.describe_db_cluster_snapshot_attributes_message.DescribeDBClusterSnapshotAttributesMessage = {}
    if db_cluster_snapshot_identifier is not None:
        input_["db_cluster_snapshot_identifier"] = db_cluster_snapshot_identifier

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