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

# UpdateRecoveryPointIndexSettings
<a name="API_UpdateRecoveryPointIndexSettings"></a>

此操作會更新復原點索引的設定。

必要： BackupVaultName、RecoveryPointArn 和 IAMRoleArn

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

```
POST /backup-vaults/backupVaultName/recovery-points/recoveryPointArn/index HTTP/1.1
Content-type: application/json

{
   "IamRoleArn": "string",
   "Index": "string"
}
```

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

請求會使用下列 URI 參數。

 ** [backupVaultName](#API_UpdateRecoveryPointIndexSettings_RequestSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-request-uri-BackupVaultName"></a>
存放備份的邏輯容器名稱。備份文件庫依名稱識別，這些名稱對用於建立文件庫的帳戶和區域來說是唯一的。  
接受的字元包括小寫字母、數字和連字號。  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必要：是

 ** [recoveryPointArn](#API_UpdateRecoveryPointIndexSettings_RequestSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-request-uri-RecoveryPointArn"></a>
唯一識別復原點的 ARN；例如，`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`。  
必要：是

## 請求主體
<a name="API_UpdateRecoveryPointIndexSettings_RequestBody"></a>

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

 ** [IamRoleArn](#API_UpdateRecoveryPointIndexSettings_RequestSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-request-IamRoleArn"></a>
這會指定用於此操作的 IAM 角色 ARN。  
例如，arn：aws：iam：：123456789012：role/S3Access  
類型：字串  
必要：否

 ** [Index](#API_UpdateRecoveryPointIndexSettings_RequestSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-request-Index"></a>
索引可以有 2 個可能值中的 1 個，可以是 `ENABLED`或 `DISABLED`。  
若要為尚未擁有備份索引的合格`ACTIVE`復原點建立備份索引，請將值設定為 `ENABLED`。  
若要刪除備份索引，請將值設定為 `DISABLED`。  
類型：字串  
有效值:`ENABLED | DISABLED`   
必要：是

## 回應語法
<a name="API_UpdateRecoveryPointIndexSettings_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "BackupVaultName": "string",
   "Index": "string",
   "IndexStatus": "string",
   "RecoveryPointArn": "string"
}
```

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

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [BackupVaultName](#API_UpdateRecoveryPointIndexSettings_ResponseSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-response-BackupVaultName"></a>
存放備份的邏輯容器名稱。備份文件庫依名稱識別，這些名稱對用於建立文件庫的帳戶和區域來說是唯一的。  
類型：字串  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`

 ** [Index](#API_UpdateRecoveryPointIndexSettings_ResponseSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-response-Index"></a>
索引可以有 2 個可能值中的 1 個，可以是 `ENABLED`或 `DISABLED`。  
值 `ENABLED`表示已建立合格`ACTIVE`復原點的備份索引。  
的值`DISABLED`表示備份索引已刪除。  
類型：字串  
有效值:`ENABLED | DISABLED` 

 ** [IndexStatus](#API_UpdateRecoveryPointIndexSettings_ResponseSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-response-IndexStatus"></a>
這是與指定復原點相關聯之備份索引的目前狀態。  
狀態為： `PENDING` \$1 `ACTIVE` \$1 `FAILED` \$1 `DELETING`   
索引狀態為 的復原點`ACTIVE`可以包含在搜尋中。  
類型：字串  
有效值:`PENDING | ACTIVE | FAILED | DELETING` 

 ** [RecoveryPointArn](#API_UpdateRecoveryPointIndexSettings_ResponseSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-response-RecoveryPointArn"></a>
可唯一識別復原點的 ARN；例如 `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`。  
類型：字串

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

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

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** InvalidRequestException **   
表示請求的輸入出現問題。例如，參數的類型錯誤。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

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

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