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

# DescribeSnapshots
<a name="API_DescribeSnapshots"></a>

クラスタースナップショットに関する情報を返します。デフォルトでは、DescribeSnapshots にはすべてのスナップショットが一覧表示されます。オプションで単一のスナップショットのみ表示することも、特定のクラスターに関連するスナップショットのみ表示することもできます。

## リクエストの構文
<a name="API_DescribeSnapshots_RequestSyntax"></a>

```
{
   "ClusterName": "string",
   "MaxResults": number,
   "NextToken": "string",
   "ShowDetail": boolean,
   "SnapshotName": "string",
   "Source": "string"
}
```

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

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

リクエストは以下のデータを JSON 形式で受け入れます。

 ** [ClusterName](#API_DescribeSnapshots_RequestSyntax) **   <a name="MemoryDB-DescribeSnapshots-request-ClusterName"></a>
ユーザーが指定したクラスター識別子。このパラメータを指定した場合、その特定のクラスターに関連するスナップショットのみ表示されます。  
タイプ: 文字列  
必須: いいえ

 ** [MaxResults](#API_DescribeSnapshots_RequestSyntax) **   <a name="MemoryDB-DescribeSnapshots-request-MaxResults"></a>
レスポンスに含めるレコードの最大数。指定された MaxResults の値よりも多くのレコードが存在する場合、トークンがレスポンスに含まれるため、残りの結果を取得できます。  
タイプ: 整数  
必須: いいえ

 ** [NextToken](#API_DescribeSnapshots_RequestSyntax) **   <a name="MemoryDB-DescribeSnapshots-request-NextToken"></a>
レコード総数が MaxResults の値を超えた場合に渡すオプションの引数。nextToken が返された場合は、さらに結果があります。nextToken の値は、各ページに固有のページ分割トークンです。後続ページを取得するには、返されたトークンを使用して再度呼び出します。他の引数をすべて維持します。  
タイプ: 文字列  
必須: いいえ

 ** [ShowDetail](#API_DescribeSnapshots_RequestSyntax) **   <a name="MemoryDB-DescribeSnapshots-request-ShowDetail"></a>
ブール値が true の場合、シャード設定はスナップショットの説明に含まれます。  
タイプ: ブール値  
必須: いいえ

 ** [SnapshotName](#API_DescribeSnapshots_RequestSyntax) **   <a name="MemoryDB-DescribeSnapshots-request-SnapshotName"></a>
ユーザーが指定するスナップショットの名前。このパラメータを指定した場合、この名前付きスナップショットのみを表示されます。  
タイプ: 文字列  
必須: いいえ

 ** [Source](#API_DescribeSnapshots_RequestSyntax) **   <a name="MemoryDB-DescribeSnapshots-request-Source"></a>
system に設定すると、出力には MemoryDB によって自動的に作成されたスナップショットが表示されます。user に設定すると、出力には手動で作成されたスナップショットが表示されます。省略すると、出力には、自動生成と手動作成、両方のスナップショットが表示されます。  
タイプ: 文字列  
必須: いいえ

## レスポンスの構文
<a name="API_DescribeSnapshots_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Snapshots": [ 
      { 
         "ARN": "string",
         "ClusterConfiguration": { 
            "Description": "string",
            "Engine": "string",
            "EngineVersion": "string",
            "MaintenanceWindow": "string",
            "MultiRegionClusterName": "string",
            "MultiRegionParameterGroupName": "string",
            "Name": "string",
            "NodeType": "string",
            "NumShards": number,
            "ParameterGroupName": "string",
            "Port": number,
            "Shards": [ 
               { 
                  "Configuration": { 
                     "ReplicaCount": number,
                     "Slots": "string"
                  },
                  "Name": "string",
                  "Size": "string",
                  "SnapshotCreationTime": number
               }
            ],
            "SnapshotRetentionLimit": number,
            "SnapshotWindow": "string",
            "SubnetGroupName": "string",
            "TopicArn": "string",
            "VpcId": "string"
         },
         "DataTiering": "string",
         "KmsKeyId": "string",
         "Name": "string",
         "Source": "string",
         "Status": "string"
      }
   ]
}
```

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

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [NextToken](#API_DescribeSnapshots_ResponseSyntax) **   <a name="MemoryDB-DescribeSnapshots-response-NextToken"></a>
レコード総数が MaxResults の値を超えた場合に渡すオプションの引数。nextToken が返された場合は、さらに結果があります。nextToken の値は、各ページに固有のページ分割トークンです。後続ページを取得するには、返されたトークンを使用して再度呼び出します。他の引数をすべて維持します。  
タイプ: 文字列

 ** [Snapshots](#API_DescribeSnapshots_ResponseSyntax) **   <a name="MemoryDB-DescribeSnapshots-response-Snapshots"></a>
スナップショットのリスト。リストの各項目には、1 つのスナップショットに関する詳細情報が含まれています。  
型: [Snapshot](API_Snapshot.md) オブジェクトの配列

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

すべてのアクションに共通のエラーについては、[一般的なエラータイプ](CommonErrors.md) を参照してください。

 ** InvalidParameterCombinationException **   
  
HTTP ステータスコード: 400

 ** InvalidParameterValueException **   
  
HTTP ステータスコード: 400

 ** ServiceLinkedRoleNotFoundFault **   
  
HTTP ステータスコード: 400

 ** SnapshotNotFoundFault **   
  
HTTP ステータスコード: 400

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

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