

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# DescribeDBClusterSnapshots
<a name="API_DescribeDBClusterSnapshots"></a>

クラスタースナップショットに関する情報を返します。この API 操作はページ分割に対応しています。

## リクエストパラメーター
<a name="API_DescribeDBClusterSnapshots_RequestParameters"></a>

 すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。

 ** DBClusterIdentifier **   
クラスタースナップショットのリストを取得する DB クラスターの ID。このパラメータは、`DBClusterSnapshotIdentifier` パラメータと併用できません。このパラメータは大文字と小文字が区別されません。  
制約:  
+ 指定した場合、既存の `DBCluster` の識別子と一致する必要があります。
タイプ: 文字列  
必須: いいえ

 ** DBClusterSnapshotIdentifier **   
記述する特定のクラスタースナップショット識別子。このパラメータは、`DBClusterIdentifier` パラメータと併用できません。この値は小文字で保存されます。  
制約:  
+ 指定した場合、既存の `DBClusterSnapshot` の識別子と一致する必要があります。
+ この識別子が自動スナップショット用の場合、`SnapshotType` パラメータも指定する必要があります。
タイプ: 文字列  
必須: いいえ

 **Filters.Filter.N**   
このパラメータは、現在サポートされていません。  
タイプ: [Filter](API_Filter.md) オブジェクトの配列  
必須: いいえ

 ** IncludePublic **   
を に設定`true`して、パブリックで、任意の によってコピーまたは復元できる手動クラスタースナップショットを含め AWS アカウント、それ以外の場合は を含めます`false`。デフォルトは `false` です。  
タイプ: ブール値  
必須: いいえ

 ** IncludeShared **   
に設定`true`して、コピーまたは復元するアクセス許可 AWS アカウント が付与 AWS アカウント されている他の からの共有手動クラスタースナップショットを含め、それ以外の場合は を含めます`false`。デフォルトは `false` です。  
タイプ: ブール値  
必須: いいえ

 ** Marker **   
以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。  
タイプ: 文字列  
必須: いいえ

 ** MaxRecords **   
 レスポンスに含めるレコードの最大数。指定された `MaxRecords` の値よりも多くのレコードが存在する場合、ページ割りトークン (マーカー) がレスポンスに含まれるため、残りの結果を取得できます。  
デフォルト: 100  
制約: 最小 20、最大 100。  
タイプ: 整数  
必須: いいえ

 ** SnapshotType **   
返されるクラスタースナップショットのタイプ。次のいずれかの値を指定できます。  
+  `automated` - Amazon DocumentDB が AWS アカウントに対して自動作成したクラスタースナップショットをすべて返します。
+  `manual` - AWS アカウントのために手動作成したクラスタースナップショットをすべて返します。
+  `shared` - AWS アカウントに共有される手動クラスタースナップショットをすべて返します。
+  `public` - 公開とマークされたクラスタースナップショットをすべて返します。
`SnapshotType` の値を指定しない場合、自動と手動の両方のクラスタースナップショットを返します。`IncludeShared` パラメータを `true` に設定すると、これらの結果に公開クラスタースナップショットを含めることができます。`IncludePublic` パラメータを `true` に設定すると、これらの結果に公開クラスタースナップショットを含めることができます。  
`IncludeShared` および `IncludePublic` パラメータは、`manual` または `automated` の `SnapshotType` 値には適用されません。`SnapshotType` が `shared` に設定されている場合、`IncludePublic` パラメータは適用されません。`SnapshotType` が `public` に設定されている場合、`IncludeShared` パラメータは適用されません。  
タイプ: 文字列  
必須: いいえ

## レスポンス要素
<a name="API_DescribeDBClusterSnapshots_ResponseElements"></a>

以下の要素がサービスによって返されます。

 **DBClusterSnapshots.DBClusterSnapshot.N**   
ユーザーのクラスタースナップショットのリストを提供します。  
型: [DBClusterSnapshot](API_DBClusterSnapshot.md) オブジェクトの配列

 ** Marker **   
以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `MaxRecords` で指定された値まで、マーカーを超えるレコードのみが含まれます。  
タイプ: 文字列

## エラー
<a name="API_DescribeDBClusterSnapshots_Errors"></a>

すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。

 ** DBClusterSnapshotNotFoundFault **   
 `DBClusterSnapshotIdentifier` は既存のクラスタースナップショットを参照していません。  
HTTP ステータスコード: 404

## 以下の資料も参照してください。
<a name="API_DescribeDBClusterSnapshots_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterSnapshots) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterSnapshots) 