

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

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

Retorna informações sobre captura de tela do cluster. Por padrão, DescribeSnapshots lista todos os seus instantâneos; opcionalmente, ele pode descrever um único instantâneo ou apenas os instantâneos associados a um determinado cluster.

## Sintaxe da solicitação
<a name="API_DescribeSnapshots_RequestSyntax"></a>

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

## Parâmetros da solicitação
<a name="API_DescribeSnapshots_RequestParameters"></a>

Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).

A solicitação aceita os dados a seguir no formato JSON.

 ** [ClusterName](#API_DescribeSnapshots_RequestSyntax) **   <a name="MemoryDB-DescribeSnapshots-request-ClusterName"></a>
Um identificador de cluster fornecido pelo usuário. Se esse parâmetro for especificado, somente os snapshots associados a esse cluster específico serão descritos.  
Tipo: string  
Obrigatório: Não

 ** [MaxResults](#API_DescribeSnapshots_RequestSyntax) **   <a name="MemoryDB-DescribeSnapshots-request-MaxResults"></a>
O número máximo de registros a serem incluídos na resposta. Se existirem mais registros do que o MaxResults valor especificado, um token será incluído na resposta para que os resultados restantes possam ser recuperados.  
Tipo: inteiro  
Obrigatório: não

 ** [NextToken](#API_DescribeSnapshots_RequestSyntax) **   <a name="MemoryDB-DescribeSnapshots-request-NextToken"></a>
Um argumento opcional a ser passado caso o número total de registros exceda o valor de MaxResults. Se o NextToken for retornado, haverá mais resultados disponíveis. O valor de nextToken é um token de paginação exclusivo para cada página. Faça a chamada novamente usando o token retornado para recuperar a próxima página. Mantenha todos os outros argumentos inalterados.   
Tipo: string  
Obrigatório: não

 ** [ShowDetail](#API_DescribeSnapshots_RequestSyntax) **   <a name="MemoryDB-DescribeSnapshots-request-ShowDetail"></a>
Um valor booliano que, se verdadeiro, a configuração do fragmento é incluída na descrição do snapshot.  
Tipo: booliano  
Obrigatório: não

 ** [SnapshotName](#API_DescribeSnapshots_RequestSyntax) **   <a name="MemoryDB-DescribeSnapshots-request-SnapshotName"></a>
O nome fornecido pelo usuário de um snapshot. Se esse parâmetro for especificado, somente esse snapshot nomeado será descrito.  
Tipo: string  
Obrigatório: não

 ** [Source](#API_DescribeSnapshots_RequestSyntax) **   <a name="MemoryDB-DescribeSnapshots-request-Source"></a>
Se definido como sistema, a saída mostra snapshots que foram criados automaticamente pelo MemoryDB. Se definido como usuário, a saída mostra snapshots que foram criados manualmente. Se omitida, a saída mostra os snapshots criados automática e manualmente.  
Tipo: string  
Obrigatório: não

## Sintaxe da resposta
<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"
      }
   ]
}
```

## Elementos de resposta
<a name="API_DescribeSnapshots_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [NextToken](#API_DescribeSnapshots_ResponseSyntax) **   <a name="MemoryDB-DescribeSnapshots-response-NextToken"></a>
Um argumento opcional a ser passado caso o número total de registros exceda o valor de MaxResults. Se o NextToken for retornado, haverá mais resultados disponíveis. O valor de nextToken é um token de paginação exclusivo para cada página. Faça a chamada novamente usando o token retornado para recuperar a próxima página. Mantenha todos os outros argumentos inalterados.   
Tipo: string

 ** [Snapshots](#API_DescribeSnapshots_ResponseSyntax) **   <a name="MemoryDB-DescribeSnapshots-response-Snapshots"></a>
Uma lista de snapshots. Cada item na lista contém informações detalhadas sobre um snapshot.  
Tipo: matriz de objetos [Snapshot](API_Snapshot.md)

## Erros
<a name="API_DescribeSnapshots_Errors"></a>

Para obter informações sobre os erros comuns que são comuns em todas ações, consulte [Tipos de erro comuns](CommonErrors.md).

 ** InvalidParameterCombinationException **   
  
Código de status HTTP: 400

 ** InvalidParameterValueException **   
  
Código de status HTTP: 400

 ** ServiceLinkedRoleNotFoundFault **   
  
Código de status HTTP: 400

 ** SnapshotNotFoundFault **   
  
Código de Status HTTP: 400

## Consulte também
<a name="API_DescribeSnapshots_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/DescribeSnapshots) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/DescribeSnapshots) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/DescribeSnapshots) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/DescribeSnapshots) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/DescribeSnapshots) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/DescribeSnapshots) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/DescribeSnapshots) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/DescribeSnapshots) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/DescribeSnapshots) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/DescribeSnapshots) 