

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# UpdateCluster
<a name="API_UpdateCluster"></a>

**注意**  
 AWS Snowball 邊緣 不再提供給新客戶。新客戶應探索[AWS DataSync](https://aws.amazon.com/datasync/)線上傳輸、用於安全實體傳輸的[AWS 資料傳輸終端機](https://aws.amazon.com/data-transfer-terminal/)，或 AWS 合作夥伴解決方案。針對邊緣運算，探索 [AWS Outposts](https://aws.amazon.com/outposts/)。

當叢集`ClusterState`的值處於 `AwaitingQuorum` 狀態時，您可以更新與叢集相關聯的一些資訊。一旦叢集變更為不同的任務狀態，通常在建立叢集後 60 分鐘，此動作就不再可用。

## 請求語法
<a name="API_UpdateCluster_RequestSyntax"></a>

```
{
   "AddressId": "string",
   "ClusterId": "string",
   "Description": "string",
   "ForwardingAddressId": "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"
}
```

## 請求參數
<a name="API_UpdateCluster_RequestParameters"></a>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

請求接受採用 JSON 格式的下列資料。

 ** [AddressId](#API_UpdateCluster_RequestSyntax) **   <a name="Snowball-UpdateCluster-request-AddressId"></a>
已更新[Address](API_Address.md)物件的 ID。  
類型：字串  
長度限制：固定長度為 40。  
模式：`ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`  
必要：否

 ** [ClusterId](#API_UpdateCluster_RequestSyntax) **   <a name="Snowball-UpdateCluster-request-ClusterId"></a>
您要更新的叢集的叢集 ID，例如 `CID123e4567-e89b-12d3-a456-426655440000`。  
類型：字串  
長度限制：固定長度為 39。  
模式：`CID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`  
必要：是

 ** [Description](#API_UpdateCluster_RequestSyntax) **   <a name="Snowball-UpdateCluster-request-Description"></a>
此叢集的更新描述。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`.*`  
必要：否

 ** [ForwardingAddressId](#API_UpdateCluster_RequestSyntax) **   <a name="Snowball-UpdateCluster-request-ForwardingAddressId"></a>
您的區域不支援此欄位。  
類型：字串  
長度限制：固定長度為 40。  
模式：`ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`  
必要：否

 ** [Notification](#API_UpdateCluster_RequestSyntax) **   <a name="Snowball-UpdateCluster-request-Notification"></a>
新的或更新的[Notification](API_Notification.md)物件。  
類型：[Notification](API_Notification.md) 物件  
必要：否

 ** [OnDeviceServiceConfiguration](#API_UpdateCluster_RequestSyntax) **   <a name="Snowball-UpdateCluster-request-OnDeviceServiceConfiguration"></a>
指定 Snowball Edge 裝置上的 服務或 服務，您傳輸的資料將從其中匯出或匯入至其中。 AWS Snowball Edge 裝置叢集支援 Amazon S3 和 NFS （網路檔案系統）。  
類型：[OnDeviceServiceConfiguration](API_OnDeviceServiceConfiguration.md) 物件  
必要：否

 ** [Resources](#API_UpdateCluster_RequestSyntax) **   <a name="Snowball-UpdateCluster-request-Resources"></a>
更新的[JobResource](API_JobResource.md)物件陣列，可包含更新的[S3Resource](API_S3Resource.md)物件或[LambdaResource](API_LambdaResource.md)物件。  
類型：[JobResource](API_JobResource.md) 物件  
必要：否

 ** [RoleARN](#API_UpdateCluster_RequestSyntax) **   <a name="Snowball-UpdateCluster-request-RoleARN"></a>
您要與此叢集建立關聯的新角色 Amazon Resource Name (ARN)。若要建立角色 ARN，請在 AWS Identity and Access Management (IAM) 中使用 [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) API 動作。  
類型：字串  
長度限制：長度上限為 255。  
模式：`arn:aws.*:iam::[0-9]{12}:role/.*`  
必要：否

 ** [ShippingOption](#API_UpdateCluster_RequestSyntax) **   <a name="Snowball-UpdateCluster-request-ShippingOption"></a>
此叢集[ShippingDetails](API_ShippingDetails.md)物件的已更新運送選項值。  
類型：字串  
有效值:`SECOND_DAY | NEXT_DAY | EXPRESS | STANDARD`   
必要：否

## 回應元素
<a name="API_UpdateCluster_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_UpdateCluster_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** Ec2RequestFailedException **   
您的使用者缺少執行嘗試動作所需的 Amazon EC2 許可。  
HTTP 狀態碼：400

 ** InvalidInputCombinationException **   
任務或叢集建立失敗。一或多個輸入無效。確認 [CreateCluster：SnowballType](API_CreateCluster.md#Snowball-CreateCluster-request-SnowballType) 值支援您的 [CreateJob：JobType](API_CreateJob.md#Snowball-CreateJob-request-JobType)，然後再試一次。  
HTTP 狀態碼：400

 ** InvalidJobStateException **   
無法執行動作，因為任務的目前狀態不允許執行該動作。  
HTTP 狀態碼：400

 ** InvalidResourceException **   
找不到指定的資源。請檢查您在上次請求中提供的資訊，然後再試一次。    
 ** ResourceType **   
提供的資源值無效。
HTTP 狀態碼：400

 ** KMSRequestFailedException **   
提供的 AWS Key Management Service 金鑰缺少執行指定 [CreateJob](API_CreateJob.md)或 [UpdateJob](API_UpdateJob.md)動作的許可。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_UpdateCluster_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/snowball-2016-06-30/UpdateCluster) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/snowball-2016-06-30/UpdateCluster) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/snowball-2016-06-30/UpdateCluster) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/snowball-2016-06-30/UpdateCluster) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/snowball-2016-06-30/UpdateCluster) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/snowball-2016-06-30/UpdateCluster) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/snowball-2016-06-30/UpdateCluster) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/snowball-2016-06-30/UpdateCluster) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/snowball-2016-06-30/UpdateCluster) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/snowball-2016-06-30/UpdateCluster) 