

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

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

**注意**  
 AWS Snowball Edge 不再向新客户提供。新客户应探索[AWS DataSync](https://aws.amazon.com/datasync/)在线传输、用于安全物理[传输AWS 的数据传输终端](https://aws.amazon.com/data-transfer-terminal/)或 AWS 合作伙伴解决方案。对于边缘计算，请浏览 [AWS Out](https://aws.amazon.com/outposts/) posts。

虽然集群的 `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>

有关所有操作的通用参数的信息，请参阅[常用参数](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 资源名称（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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/snowball-2016-06-30/UpdateCluster) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/snowball-2016-06-30/UpdateCluster) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/snowball-2016-06-30/UpdateCluster) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/snowball-2016-06-30/UpdateCluster) 
+  [AWS Python 软件开发工具包](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) 