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

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

特定のクラスターについて、配送情報、クラスターステータス、他の重要メタデータといった情報を返します。

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

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

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

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

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

 ** [ClusterId](#API_DescribeCluster_RequestSyntax) **   <a name="Snowball-DescribeCluster-request-ClusterId"></a>
クラスター用に自動生成された ID です。  
型: 文字列  
長さの制限: 固定長は 39 です。  
Pattern: `CID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
必須：はい

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

```
{
   "ClusterMetadata": { 
      "AddressId": "string",
      "ClusterId": "string",
      "ClusterState": "string",
      "CreationDate": number,
      "Description": "string",
      "ForwardingAddressId": "string",
      "JobType": "string",
      "KmsKeyARN": "string",
      "Notification": { 
         "DevicePickupSnsTopicARN": "string",
         "JobStatesToNotify": [ "string" ],
         "NotifyAll": boolean,
         "SnsTopicARN": "string"
      },
      "OnDeviceServiceConfiguration": { 
         "EKSOnDeviceService": { 
            "EKSAnywhereVersion": "string",
            "KubernetesVersion": "string"
         },
         "NFSOnDeviceService": { 
            "StorageLimit": number,
            "StorageUnit": "string"
         },
         "S3OnDeviceService": { 
            "FaultTolerance": number,
            "ServiceSize": number,
            "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"
         }
      }
   }
}
```

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

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

次のデータは、 サービスによって JSON 形式で返されます。

 ** [ClusterMetadata](#API_DescribeCluster_ResponseSyntax) **   <a name="Snowball-DescribeCluster-response-ClusterMetadata"></a>
特定のクラスターについての、配送情報、クラスターステータス、および他の重要メタデータといった情報。  
型: [ClusterMetadata](API_ClusterMetadata.md) オブジェクト

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

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

 ** InvalidResourceException **   
指定されたリソースが見つかりません。前回のリクエストで入力した情報をチェックし、もう一度お試しください。  
HTTP ステータスコード: 400

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

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