Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

# DescribeCluster
<a name="API_DescribeCluster"></a>

Renvoie des informations sur un cluster spécifique, y compris les informations d'expédition, le statut du cluster et d'autres métadonnées importantes.

## Syntaxe de la requête
<a name="API_DescribeCluster_RequestSyntax"></a>

```
{
   "ClusterId": "string"
}
```

## Paramètres de demande
<a name="API_DescribeCluster_RequestParameters"></a>

Pour plus d'informations sur les paramètres communs à toutes les actions, consultez la section [Paramètres communs](CommonParameters.md).

Cette demande accepte les données suivantes au format JSON.

 ** [ClusterId](#API_DescribeCluster_RequestSyntax) **   <a name="Snowball-DescribeCluster-request-ClusterId"></a>
L'ID généré automatiquement pour un cluster.  
Type : String  
Contraintes de longueur : 39.  
Modèle : `CID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Obligatoire : oui

## Syntaxe de la réponse
<a name="API_DescribeCluster_ResponseSyntax"></a>

```
{
   "ClusterMetadata": { 
      "AddressId": "string",
      "ClusterId": "string",
      "ClusterState": "string",
      "CreationDate": number,
      "Description": "string",
      "ForwardingAddressId": "string",
      "JobType": "string",
      "KmsKeyARN": "string",
      "Notification": { 
         "JobStatesToNotify": [ "string" ],
         "NotifyAll": boolean,
         "SnsTopicARN": "string"
      },
      "OnDeviceServiceConfiguration": { 
         "EKSOnDeviceService": { 
            "EKSAnywhereVersion": "string",
            "KubernetesVersion": "string"
         },
         "NFSOnDeviceService": { 
            "StorageLimit": number,
            "StorageUnit": "string"
         },
         "TGWOnDeviceService": { 
            "StorageLimit": number,
            "StorageUnit": "string"
         }
      },
      "Resources": { 
         "Ec2AmiResources": [ 
            { 
               "AmiId": "string",
               "SnowballAmiId": "string"
            }
         ],
         "LambdaResources": [ 
            { 
               "EventTriggers": [ 
                  { 
                     "EventResourceARN": "string"
                  }
               ],
               "LambdaArn": "string"
            }
         ],
         "S3Resources": [ 
            { 
               "BucketArn": "string",
               "KeyRange": { 
                  "BeginMarker": "string",
                  "EndMarker": "string"
               },
               "TargetOnDeviceServices": [ 
                  { 
                     "ServiceName": "string",
                     "TransferOption": "string"
                  }
               ]
            }
         ]
      },
      "RoleARN": "string",
      "ShippingOption": "string",
      "SnowballType": "string",
      "TaxDocuments": { 
         "IND": { 
            "GSTIN": "string"
         }
      }
   }
}
```

## Eléments de réponse
<a name="API_DescribeCluster_ResponseElements"></a>

Si l'action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

 ** [ClusterMetadata](#API_DescribeCluster_ResponseSyntax) **   <a name="Snowball-DescribeCluster-response-ClusterMetadata"></a>
Informations sur un cluster spécifique, y compris les informations d'expédition, le statut du cluster et d'autres métadonnées importantes.  
Type : objet [ClusterMetadata](API_ClusterMetadata.md)

## Erreurs
<a name="API_DescribeCluster_Errors"></a>

Pour plus d'informations sur les erreurs communes à toutes les actions, consultez[Erreurs courantes](CommonErrors.md).

 ** InvalidResourceException **   
La ressource spécifiée est introuvable. Vérifiez les informations,.  
Code d'état HTTP : 400

## Voir aussi
<a name="API_DescribeCluster_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des kits SDK AWS spécifiques au langage, consultez les ressources suivantes :
+  [Interface de ligne de commande AWS](https://docs.aws.amazon.com/goto/aws-cli/snowball-2016-06-30/DescribeCluster) 
+  [AWS SDK pour .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/snowball-2016-06-30/DescribeCluster) 
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/snowball-2016-06-30/DescribeCluster) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/snowball-2016-06-30/DescribeCluster) 
+  [Kit SDK AWS pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/snowball-2016-06-30/DescribeCluster) 
+  [AWSSDK pour JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/snowball-2016-06-30/DescribeCluster) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/snowball-2016-06-30/DescribeCluster) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/snowball-2016-06-30/DescribeCluster) 
+  [Kit SDK AWS pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/snowball-2016-06-30/DescribeCluster)