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

# AWS Backup
<a name="API_Operations_AWS_Backup"></a>

支援下列動作 AWS Backup：
+  [AssociateBackupVaultMpaApprovalTeam](API_AssociateBackupVaultMpaApprovalTeam.md) 
+  [CancelLegalHold](API_CancelLegalHold.md) 
+  [CreateBackupPlan](API_CreateBackupPlan.md) 
+  [CreateBackupSelection](API_CreateBackupSelection.md) 
+  [CreateBackupVault](API_CreateBackupVault.md) 
+  [CreateFramework](API_CreateFramework.md) 
+  [CreateLegalHold](API_CreateLegalHold.md) 
+  [CreateLogicallyAirGappedBackupVault](API_CreateLogicallyAirGappedBackupVault.md) 
+  [CreateReportPlan](API_CreateReportPlan.md) 
+  [CreateRestoreAccessBackupVault](API_CreateRestoreAccessBackupVault.md) 
+  [CreateRestoreTestingPlan](API_CreateRestoreTestingPlan.md) 
+  [CreateRestoreTestingSelection](API_CreateRestoreTestingSelection.md) 
+  [CreateTieringConfiguration](API_CreateTieringConfiguration.md) 
+  [DeleteBackupPlan](API_DeleteBackupPlan.md) 
+  [DeleteBackupSelection](API_DeleteBackupSelection.md) 
+  [DeleteBackupVault](API_DeleteBackupVault.md) 
+  [DeleteBackupVaultAccessPolicy](API_DeleteBackupVaultAccessPolicy.md) 
+  [DeleteBackupVaultLockConfiguration](API_DeleteBackupVaultLockConfiguration.md) 
+  [DeleteBackupVaultNotifications](API_DeleteBackupVaultNotifications.md) 
+  [DeleteFramework](API_DeleteFramework.md) 
+  [DeleteRecoveryPoint](API_DeleteRecoveryPoint.md) 
+  [DeleteReportPlan](API_DeleteReportPlan.md) 
+  [DeleteRestoreTestingPlan](API_DeleteRestoreTestingPlan.md) 
+  [DeleteRestoreTestingSelection](API_DeleteRestoreTestingSelection.md) 
+  [DeleteTieringConfiguration](API_DeleteTieringConfiguration.md) 
+  [DescribeBackupJob](API_DescribeBackupJob.md) 
+  [DescribeBackupVault](API_DescribeBackupVault.md) 
+  [DescribeCopyJob](API_DescribeCopyJob.md) 
+  [DescribeFramework](API_DescribeFramework.md) 
+  [DescribeGlobalSettings](API_DescribeGlobalSettings.md) 
+  [DescribeProtectedResource](API_DescribeProtectedResource.md) 
+  [DescribeRecoveryPoint](API_DescribeRecoveryPoint.md) 
+  [DescribeRegionSettings](API_DescribeRegionSettings.md) 
+  [DescribeReportJob](API_DescribeReportJob.md) 
+  [DescribeReportPlan](API_DescribeReportPlan.md) 
+  [DescribeRestoreJob](API_DescribeRestoreJob.md) 
+  [DescribeScanJob](API_DescribeScanJob.md) 
+  [DisassociateBackupVaultMpaApprovalTeam](API_DisassociateBackupVaultMpaApprovalTeam.md) 
+  [DisassociateRecoveryPoint](API_DisassociateRecoveryPoint.md) 
+  [DisassociateRecoveryPointFromParent](API_DisassociateRecoveryPointFromParent.md) 
+  [ExportBackupPlanTemplate](API_ExportBackupPlanTemplate.md) 
+  [GetBackupPlan](API_GetBackupPlan.md) 
+  [GetBackupPlanFromJSON](API_GetBackupPlanFromJSON.md) 
+  [GetBackupPlanFromTemplate](API_GetBackupPlanFromTemplate.md) 
+  [GetBackupSelection](API_GetBackupSelection.md) 
+  [GetBackupVaultAccessPolicy](API_GetBackupVaultAccessPolicy.md) 
+  [GetBackupVaultNotifications](API_GetBackupVaultNotifications.md) 
+  [GetLegalHold](API_GetLegalHold.md) 
+  [GetRecoveryPointIndexDetails](API_GetRecoveryPointIndexDetails.md) 
+  [GetRecoveryPointRestoreMetadata](API_GetRecoveryPointRestoreMetadata.md) 
+  [GetRestoreJobMetadata](API_GetRestoreJobMetadata.md) 
+  [GetRestoreTestingInferredMetadata](API_GetRestoreTestingInferredMetadata.md) 
+  [GetRestoreTestingPlan](API_GetRestoreTestingPlan.md) 
+  [GetRestoreTestingSelection](API_GetRestoreTestingSelection.md) 
+  [GetSupportedResourceTypes](API_GetSupportedResourceTypes.md) 
+  [GetTieringConfiguration](API_GetTieringConfiguration.md) 
+  [ListBackupJobs](API_ListBackupJobs.md) 
+  [ListBackupJobSummaries](API_ListBackupJobSummaries.md) 
+  [ListBackupPlans](API_ListBackupPlans.md) 
+  [ListBackupPlanTemplates](API_ListBackupPlanTemplates.md) 
+  [ListBackupPlanVersions](API_ListBackupPlanVersions.md) 
+  [ListBackupSelections](API_ListBackupSelections.md) 
+  [ListBackupVaults](API_ListBackupVaults.md) 
+  [ListCopyJobs](API_ListCopyJobs.md) 
+  [ListCopyJobSummaries](API_ListCopyJobSummaries.md) 
+  [ListFrameworks](API_ListFrameworks.md) 
+  [ListIndexedRecoveryPoints](API_ListIndexedRecoveryPoints.md) 
+  [ListLegalHolds](API_ListLegalHolds.md) 
+  [ListProtectedResources](API_ListProtectedResources.md) 
+  [ListProtectedResourcesByBackupVault](API_ListProtectedResourcesByBackupVault.md) 
+  [ListRecoveryPointsByBackupVault](API_ListRecoveryPointsByBackupVault.md) 
+  [ListRecoveryPointsByLegalHold](API_ListRecoveryPointsByLegalHold.md) 
+  [ListRecoveryPointsByResource](API_ListRecoveryPointsByResource.md) 
+  [ListReportJobs](API_ListReportJobs.md) 
+  [ListReportPlans](API_ListReportPlans.md) 
+  [ListRestoreAccessBackupVaults](API_ListRestoreAccessBackupVaults.md) 
+  [ListRestoreJobs](API_ListRestoreJobs.md) 
+  [ListRestoreJobsByProtectedResource](API_ListRestoreJobsByProtectedResource.md) 
+  [ListRestoreJobSummaries](API_ListRestoreJobSummaries.md) 
+  [ListRestoreTestingPlans](API_ListRestoreTestingPlans.md) 
+  [ListRestoreTestingSelections](API_ListRestoreTestingSelections.md) 
+  [ListScanJobs](API_ListScanJobs.md) 
+  [ListScanJobSummaries](API_ListScanJobSummaries.md) 
+  [ListTags](API_ListTags.md) 
+  [ListTieringConfigurations](API_ListTieringConfigurations.md) 
+  [PutBackupVaultAccessPolicy](API_PutBackupVaultAccessPolicy.md) 
+  [PutBackupVaultLockConfiguration](API_PutBackupVaultLockConfiguration.md) 
+  [PutBackupVaultNotifications](API_PutBackupVaultNotifications.md) 
+  [PutRestoreValidationResult](API_PutRestoreValidationResult.md) 
+  [RevokeRestoreAccessBackupVault](API_RevokeRestoreAccessBackupVault.md) 
+  [StartBackupJob](API_StartBackupJob.md) 
+  [StartCopyJob](API_StartCopyJob.md) 
+  [StartReportJob](API_StartReportJob.md) 
+  [StartRestoreJob](API_StartRestoreJob.md) 
+  [StartScanJob](API_StartScanJob.md) 
+  [StopBackupJob](API_StopBackupJob.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateBackupPlan](API_UpdateBackupPlan.md) 
+  [UpdateFramework](API_UpdateFramework.md) 
+  [UpdateGlobalSettings](API_UpdateGlobalSettings.md) 
+  [UpdateRecoveryPointIndexSettings](API_UpdateRecoveryPointIndexSettings.md) 
+  [UpdateRecoveryPointLifecycle](API_UpdateRecoveryPointLifecycle.md) 
+  [UpdateRegionSettings](API_UpdateRegionSettings.md) 
+  [UpdateReportPlan](API_UpdateReportPlan.md) 
+  [UpdateRestoreTestingPlan](API_UpdateRestoreTestingPlan.md) 
+  [UpdateRestoreTestingSelection](API_UpdateRestoreTestingSelection.md) 
+  [UpdateTieringConfiguration](API_UpdateTieringConfiguration.md) 

# AssociateBackupVaultMpaApprovalTeam
<a name="API_AssociateBackupVaultMpaApprovalTeam"></a>

將 MPA 核准團隊與備份保存庫建立關聯。

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

```
PUT /backup-vaults/backupVaultName/mpaApprovalTeam HTTP/1.1
Content-type: application/json

{
   "MpaApprovalTeamArn": "string",
   "RequesterComment": "string"
}
```

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

請求會使用下列 URI 參數。

 ** [backupVaultName](#API_AssociateBackupVaultMpaApprovalTeam_RequestSyntax) **   <a name="Backup-AssociateBackupVaultMpaApprovalTeam-request-uri-BackupVaultName"></a>
要與 MPA 核准團隊建立關聯的備份文件庫名稱。  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必要：是

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

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

 ** [MpaApprovalTeamArn](#API_AssociateBackupVaultMpaApprovalTeam_RequestSyntax) **   <a name="Backup-AssociateBackupVaultMpaApprovalTeam-request-MpaApprovalTeamArn"></a>
要與備份保存庫建立關聯的 MPA 核准團隊的 Amazon Resource Name (ARN)。  
類型：字串  
必要：是

 ** [RequesterComment](#API_AssociateBackupVaultMpaApprovalTeam_RequestSyntax) **   <a name="Backup-AssociateBackupVaultMpaApprovalTeam-request-RequesterComment"></a>
由請求者提供的註解，解釋關聯請求。  
類型：字串  
必要：否

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

```
HTTP/1.1 204
```

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

如果動作成功，則服務會送回具有空 HTTP 主體的 HTTP 204 回應。

## 錯誤
<a name="API_AssociateBackupVaultMpaApprovalTeam_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_AssociateBackupVaultMpaApprovalTeam_SeeAlso"></a>

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

# CancelLegalHold
<a name="API_CancelLegalHold"></a>

移除復原點上指定的法務保存。這個動作只能由擁有足夠許可的使用者執行。

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

```
DELETE /legal-holds/legalHoldId?cancelDescription=CancelDescription&retainRecordInDays=RetainRecordInDays HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [CancelDescription](#API_CancelLegalHold_RequestSyntax) **   <a name="Backup-CancelLegalHold-request-uri-CancelDescription"></a>
描述移除法務保存原因的字串。  
必要：是

 ** [legalHoldId](#API_CancelLegalHold_RequestSyntax) **   <a name="Backup-CancelLegalHold-request-uri-LegalHoldId"></a>
法務保存的 ID。  
必要：是

 ** [RetainRecordInDays](#API_CancelLegalHold_RequestSyntax) **   <a name="Backup-CancelLegalHold-request-uri-RetainRecordInDays"></a>
整數數量，以天為單位，之後會移除法務保存。

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

請求沒有請求主體。

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

```
HTTP/1.1 201
```

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

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

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

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

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

HTTP 狀態碼：400

 ** InvalidResourceStateException **   
 AWS Backup 正在對此復原點執行動作。在第一個動作完成之前，其無法執行您要求的動作。請稍後再試。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# CreateBackupPlan
<a name="API_CreateBackupPlan"></a>

使用備份計畫名稱和備份規則建立備份計畫。備份計畫是一種文件，其中包含 AWS Backup 使用 來排程為 資源建立復原點之任務的資訊。

如果呼叫 `CreateBackupPlan` 已經存在的計畫，您會收到 `AlreadyExistsException` 例外。

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

```
PUT /backup/plans/ HTTP/1.1
Content-type: application/json

{
   "BackupPlan": { 
      "AdvancedBackupSettings": [ 
         { 
            "BackupOptions": { 
               "string" : "string" 
            },
            "ResourceType": "string"
         }
      ],
      "BackupPlanName": "string",
      "Rules": [ 
         { 
            "CompletionWindowMinutes": number,
            "CopyActions": [ 
               { 
                  "DestinationBackupVaultArn": "string",
                  "Lifecycle": { 
                     "DeleteAfterDays": number,
                     "DeleteAfterEvent": "string",
                     "MoveToColdStorageAfterDays": number,
                     "OptInToArchiveForSupportedResources": boolean
                  }
               }
            ],
            "EnableContinuousBackup": boolean,
            "IndexActions": [ 
               { 
                  "ResourceTypes": [ "string" ]
               }
            ],
            "Lifecycle": { 
               "DeleteAfterDays": number,
               "DeleteAfterEvent": "string",
               "MoveToColdStorageAfterDays": number,
               "OptInToArchiveForSupportedResources": boolean
            },
            "RecoveryPointTags": { 
               "string" : "string" 
            },
            "RuleName": "string",
            "ScanActions": [ 
               { 
                  "MalwareScanner": "string",
                  "ScanMode": "string"
               }
            ],
            "ScheduleExpression": "string",
            "ScheduleExpressionTimezone": "string",
            "StartWindowMinutes": number,
            "TargetBackupVaultName": "string",
            "TargetLogicallyAirGappedBackupVaultArn": "string"
         }
      ],
      "ScanSettings": [ 
         { 
            "MalwareScanner": "string",
            "ResourceTypes": [ "string" ],
            "ScannerRoleArn": "string"
         }
      ]
   },
   "BackupPlanTags": { 
      "string" : "string" 
   },
   "CreatorRequestId": "string"
}
```

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

請求不會使用任何 URI 參數。

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

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

 ** [BackupPlan](#API_CreateBackupPlan_RequestSyntax) **   <a name="Backup-CreateBackupPlan-request-BackupPlan"></a>
備份計畫的內文。包括一個 `BackupPlanName` 和一或多組 `Rules`。  
類型：[BackupPlanInput](API_BackupPlanInput.md) 物件  
必要：是

 ** [BackupPlanTags](#API_CreateBackupPlan_RequestSyntax) **   <a name="Backup-CreateBackupPlan-request-BackupPlanTags"></a>
要指派給備份計畫的標籤。  
類型：字串到字串映射  
必要：否

 ** [CreatorRequestId](#API_CreateBackupPlan_RequestSyntax) **   <a name="Backup-CreateBackupPlan-request-CreatorRequestId"></a>
可識別請求且允許重試失敗的請求，而不會有兩次執行操作的風險。如果請求包含符合現有備份計畫的 `CreatorRequestId`，則會傳回該計畫。此為選用參數。  
如果使用，此參數必須包含 1 至 50 個英數字元或 '-\$1'。字元。  
類型：字串  
必要：否

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

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

{
   "AdvancedBackupSettings": [ 
      { 
         "BackupOptions": { 
            "string" : "string" 
         },
         "ResourceType": "string"
      }
   ],
   "BackupPlanArn": "string",
   "BackupPlanId": "string",
   "CreationDate": number,
   "VersionId": "string"
}
```

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

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

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

 ** [AdvancedBackupSettings](#API_CreateBackupPlan_ResponseSyntax) **   <a name="Backup-CreateBackupPlan-response-AdvancedBackupSettings"></a>
資源類型的設定。此選項僅適用於 Windows 磁碟區陰影複製服務 (VSS) 備份任務。  
類型：[AdvancedBackupSetting](API_AdvancedBackupSetting.md) 物件陣列

 ** [BackupPlanArn](#API_CreateBackupPlan_ResponseSyntax) **   <a name="Backup-CreateBackupPlan-response-BackupPlanArn"></a>
可唯一識別備份計畫的 Amazon Resource Name (ARN)，例如 `arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50`。  
類型：字串

 ** [BackupPlanId](#API_CreateBackupPlan_ResponseSyntax) **   <a name="Backup-CreateBackupPlan-response-BackupPlanId"></a>
備份計畫的 ID。  
類型：字串

 ** [CreationDate](#API_CreateBackupPlan_ResponseSyntax) **   <a name="Backup-CreateBackupPlan-response-CreationDate"></a>
建立備份計畫時的日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。`CreationDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [VersionId](#API_CreateBackupPlan_ResponseSyntax) **   <a name="Backup-CreateBackupPlan-response-VersionId"></a>
唯一隨機產生的 Unicode、UTF-8 編碼字串，最長 1,024 個位元組。您無法對其進行編輯。  
類型：字串

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

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

 ** AlreadyExistsException **   
所需資源已存在。    
 ** Arn **   
  
 ** Context **   
  
 ** CreatorRequestId **   
  
 ** Type **   

HTTP 狀態碼：400

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

HTTP 狀態碼：400

 ** LimitExceededException **   
請求已超過限制；例如，請求中允許的最大項目數量。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# CreateBackupSelection
<a name="API_CreateBackupSelection"></a>

建立 JSON 文件，可指定要指派給備份計畫的一組資源。如需範例，請參閱《[Assigning resources programmatically](https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-json)》。

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

```
PUT /backup/plans/backupPlanId/selections/ HTTP/1.1
Content-type: application/json

{
   "BackupSelection": { 
      "Conditions": { 
         "StringEquals": [ 
            { 
               "ConditionKey": "string",
               "ConditionValue": "string"
            }
         ],
         "StringLike": [ 
            { 
               "ConditionKey": "string",
               "ConditionValue": "string"
            }
         ],
         "StringNotEquals": [ 
            { 
               "ConditionKey": "string",
               "ConditionValue": "string"
            }
         ],
         "StringNotLike": [ 
            { 
               "ConditionKey": "string",
               "ConditionValue": "string"
            }
         ]
      },
      "IamRoleArn": "string",
      "ListOfTags": [ 
         { 
            "ConditionKey": "string",
            "ConditionType": "string",
            "ConditionValue": "string"
         }
      ],
      "NotResources": [ "string" ],
      "Resources": [ "string" ],
      "SelectionName": "string"
   },
   "CreatorRequestId": "string"
}
```

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

請求會使用下列 URI 參數。

 ** [backupPlanId](#API_CreateBackupSelection_RequestSyntax) **   <a name="Backup-CreateBackupSelection-request-uri-BackupPlanId"></a>
備份計畫的 ID。  
必要：是

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

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

 ** [BackupSelection](#API_CreateBackupSelection_RequestSyntax) **   <a name="Backup-CreateBackupSelection-request-BackupSelection"></a>
將一組資源指派給備份計劃的請求內文。  
類型：[BackupSelection](API_BackupSelection.md) 物件  
必要：是

 ** [CreatorRequestId](#API_CreateBackupSelection_RequestSyntax) **   <a name="Backup-CreateBackupSelection-request-CreatorRequestId"></a>
可識別請求的唯一字串，且允許重試失敗的請求，而不會有兩次執行操作的風險。此為選用參數。  
如果使用，此參數必須包含 1 至 50 個英數字元或 '-\$1'。字元。  
類型：字串  
必要：否

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

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

{
   "BackupPlanId": "string",
   "CreationDate": number,
   "SelectionId": "string"
}
```

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

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

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

 ** [BackupPlanId](#API_CreateBackupSelection_ResponseSyntax) **   <a name="Backup-CreateBackupSelection-response-BackupPlanId"></a>
備份計畫的 ID。  
類型：字串

 ** [CreationDate](#API_CreateBackupSelection_ResponseSyntax) **   <a name="Backup-CreateBackupSelection-response-CreationDate"></a>
建立備份選擇時的日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。`CreationDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [SelectionId](#API_CreateBackupSelection_ResponseSyntax) **   <a name="Backup-CreateBackupSelection-response-SelectionId"></a>
可唯一識別請求本文，將一組資源指派給備份計畫。  
類型：字串

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

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

 ** AlreadyExistsException **   
所需資源已存在。    
 ** Arn **   
  
 ** Context **   
  
 ** CreatorRequestId **   
  
 ** Type **   

HTTP 狀態碼：400

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

HTTP 狀態碼：400

 ** LimitExceededException **   
請求已超過限制；例如，請求中允許的最大項目數量。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# CreateBackupVault
<a name="API_CreateBackupVault"></a>

建立用來存放備份的邏輯容器。`CreateBackupVault` 請求包含名稱、選用的一或多個資源標籤、加密金鑰以及請求 ID。

**注意**  
不得在備份文件庫名稱中包含敏感資料，例如護照號碼。

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

```
PUT /backup-vaults/backupVaultName HTTP/1.1
Content-type: application/json

{
   "BackupVaultTags": { 
      "string" : "string" 
   },
   "CreatorRequestId": "string",
   "EncryptionKeyArn": "string"
}
```

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

請求會使用下列 URI 參數。

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

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

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

 ** [BackupVaultTags](#API_CreateBackupVault_RequestSyntax) **   <a name="Backup-CreateBackupVault-request-BackupVaultTags"></a>
要指派給備份保存庫的標籤。  
類型：字串到字串映射  
必要：否

 ** [CreatorRequestId](#API_CreateBackupVault_RequestSyntax) **   <a name="Backup-CreateBackupVault-request-CreatorRequestId"></a>
可識別請求的唯一字串，且允許重試失敗的請求，而不會有兩次執行操作的風險。此為選用參數。  
如果使用，此參數必須包含 1 至 50 個英數字元或 '-\$1'。字元。  
類型：字串  
必要：否

 ** [EncryptionKeyArn](#API_CreateBackupVault_RequestSyntax) **   <a name="Backup-CreateBackupVault-request-EncryptionKeyArn"></a>
用來保護備份的伺服器端加密金鑰，例如 `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`。  
類型：字串  
必要：否

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

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

{
   "BackupVaultArn": "string",
   "BackupVaultName": "string",
   "CreationDate": number
}
```

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

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

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

 ** [BackupVaultArn](#API_CreateBackupVault_ResponseSyntax) **   <a name="Backup-CreateBackupVault-response-BackupVaultArn"></a>
可唯一識別備份文件庫的 Amazon Resource Name (ARN)，例如 `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`。  
類型：字串

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

 ** [CreationDate](#API_CreateBackupVault_ResponseSyntax) **   <a name="Backup-CreateBackupVault-response-CreationDate"></a>
建立備份保存庫時的日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。`CreationDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

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

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

 ** AlreadyExistsException **   
所需資源已存在。    
 ** Arn **   
  
 ** Context **   
  
 ** CreatorRequestId **   
  
 ** Type **   

HTTP 狀態碼：400

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

HTTP 狀態碼：400

 ** LimitExceededException **   
請求已超過限制；例如，請求中允許的最大項目數量。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# CreateFramework
<a name="API_CreateFramework"></a>

建立具有一或多個控制項的架構。架構是可用於評估備份實際做法的控制項集合。透過使用預先建立的可自訂控制項來定義政策，您即可評估備份實際做法是否符合您的政策，以及哪些資源尚未合規。

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

```
POST /audit/frameworks HTTP/1.1
Content-type: application/json

{
   "FrameworkControls": [ 
      { 
         "ControlInputParameters": [ 
            { 
               "ParameterName": "string",
               "ParameterValue": "string"
            }
         ],
         "ControlName": "string",
         "ControlScope": { 
            "ComplianceResourceIds": [ "string" ],
            "ComplianceResourceTypes": [ "string" ],
            "Tags": { 
               "string" : "string" 
            }
         }
      }
   ],
   "FrameworkDescription": "string",
   "FrameworkName": "string",
   "FrameworkTags": { 
      "string" : "string" 
   },
   "IdempotencyToken": "string"
}
```

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

請求不會使用任何 URI 參數。

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

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

 ** [FrameworkControls](#API_CreateFramework_RequestSyntax) **   <a name="Backup-CreateFramework-request-FrameworkControls"></a>
構成架構的控制項。清單中的每個控制項都具有名稱、輸入參數和範圍。  
類型：[FrameworkControl](API_FrameworkControl.md) 物件陣列  
必要：是

 ** [FrameworkDescription](#API_CreateFramework_RequestSyntax) **   <a name="Backup-CreateFramework-request-FrameworkDescription"></a>
架構的選用描述，最多包含 1,024 個字元。  
類型：字串  
長度限制：長度下限為 0。長度上限為 1024。  
模式：`.*\S.*`  
必要：否

 ** [FrameworkName](#API_CreateFramework_RequestSyntax) **   <a name="Backup-CreateFramework-request-FrameworkName"></a>
架構的唯一名稱。此名稱的長度必須介於 1 到 256 個字元，以英文字母開頭，由英文字母 (a-z、A-Z)、數字 (0-9) 和底線 (\$1) 組成。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z][_a-zA-Z0-9]*`  
必要：是

 ** [FrameworkTags](#API_CreateFramework_RequestSyntax) **   <a name="Backup-CreateFramework-request-FrameworkTags"></a>
要指派給架構的標籤。  
類型：字串到字串映射  
必要：否

 ** [IdempotencyToken](#API_CreateFramework_RequestSyntax) **   <a name="Backup-CreateFramework-request-IdempotencyToken"></a>
客戶所選擇的字串，可用來區分在其他方面相同的 `CreateFrameworkInput` 呼叫。重試具有相同等冪性字符的成功請求會導致出現成功消息，但未執行任何動作。  
類型：字串  
必要：否

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

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

{
   "FrameworkArn": "string",
   "FrameworkName": "string"
}
```

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

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

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

 ** [FrameworkArn](#API_CreateFramework_ResponseSyntax) **   <a name="Backup-CreateFramework-response-FrameworkArn"></a>
可唯一識別資源的 Amazon Resource Name (ARN)。ARN 的格式取決於資源類型。  
類型：字串

 ** [FrameworkName](#API_CreateFramework_ResponseSyntax) **   <a name="Backup-CreateFramework-response-FrameworkName"></a>
架構的唯一名稱。此名稱的長度必須介於 1 到 256 個字元，以英文字母開頭，由英文字母 (a-z、A-Z)、數字 (0-9) 和底線 (\$1) 組成。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z][_a-zA-Z0-9]*`

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

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

 ** AlreadyExistsException **   
所需資源已存在。    
 ** Arn **   
  
 ** Context **   
  
 ** CreatorRequestId **   
  
 ** Type **   

HTTP 狀態碼：400

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

HTTP 狀態碼：400

 ** LimitExceededException **   
請求已超過限制；例如，請求中允許的最大項目數量。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# CreateLegalHold
<a name="API_CreateLegalHold"></a>

在復原點 （備份） 上建立法務保存。法務保存是在授權使用者取消法務保存之前，針對變更或刪除備份所進行的限制。如果復原點上有一或多個有效的法務保存，則刪除或取消關聯復原點的任何動作都會失敗，並顯示錯誤。

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

```
POST /legal-holds/ HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "IdempotencyToken": "string",
   "RecoveryPointSelection": { 
      "DateRange": { 
         "FromDate": number,
         "ToDate": number
      },
      "ResourceIdentifiers": [ "string" ],
      "VaultNames": [ "string" ]
   },
   "Tags": { 
      "string" : "string" 
   },
   "Title": "string"
}
```

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

請求不會使用任何 URI 參數。

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

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

 ** [Description](#API_CreateLegalHold_RequestSyntax) **   <a name="Backup-CreateLegalHold-request-Description"></a>
法務保存的說明。  
類型：字串  
必要：是

 ** [IdempotencyToken](#API_CreateLegalHold_RequestSyntax) **   <a name="Backup-CreateLegalHold-request-IdempotencyToken"></a>
這是使用者選擇的字符，可用於區分在其他方面相同的呼叫。重試具有相同等冪性字符的成功請求會導致出現成功消息，但未執行任何動作。  
類型：字串  
必要：否

 ** [RecoveryPointSelection](#API_CreateLegalHold_RequestSyntax) **   <a name="Backup-CreateLegalHold-request-RecoveryPointSelection"></a>
指派一組資源的條件，例如資源類型或備份文件庫。  
類型：[RecoveryPointSelection](API_RecoveryPointSelection.md) 物件  
必要：否

 ** [Tags](#API_CreateLegalHold_RequestSyntax) **   <a name="Backup-CreateLegalHold-request-Tags"></a>
要包含的選用標籤。標籤是可用於管理、篩選和搜尋資源的鍵值對。允許使用的字元包括 UTF-8 字母、數字、空格，以及下列字元：\$1 - = . \$1 : /。  
類型：字串到字串映射  
必要：否

 ** [Title](#API_CreateLegalHold_RequestSyntax) **   <a name="Backup-CreateLegalHold-request-Title"></a>
法務保存的標題。  
類型：字串  
必要：是

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

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

{
   "CreationDate": number,
   "Description": "string",
   "LegalHoldArn": "string",
   "LegalHoldId": "string",
   "RecoveryPointSelection": { 
      "DateRange": { 
         "FromDate": number,
         "ToDate": number
      },
      "ResourceIdentifiers": [ "string" ],
      "VaultNames": [ "string" ]
   },
   "Status": "string",
   "Title": "string"
}
```

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

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

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

 ** [CreationDate](#API_CreateLegalHold_ResponseSyntax) **   <a name="Backup-CreateLegalHold-response-CreationDate"></a>
建立法務保存的時間。  
類型：Timestamp

 ** [Description](#API_CreateLegalHold_ResponseSyntax) **   <a name="Backup-CreateLegalHold-response-Description"></a>
法務保存的說明。  
類型：字串

 ** [LegalHoldArn](#API_CreateLegalHold_ResponseSyntax) **   <a name="Backup-CreateLegalHold-response-LegalHoldArn"></a>
法務保存的 Amazon Resource Name (ARN)。  
類型：字串

 ** [LegalHoldId](#API_CreateLegalHold_ResponseSyntax) **   <a name="Backup-CreateLegalHold-response-LegalHoldId"></a>
法務保存的 ID。  
類型：字串

 ** [RecoveryPointSelection](#API_CreateLegalHold_ResponseSyntax) **   <a name="Backup-CreateLegalHold-response-RecoveryPointSelection"></a>
指派給一組資源的條件，例如資源類型或備份文件庫。  
類型：[RecoveryPointSelection](API_RecoveryPointSelection.md) 物件

 ** [Status](#API_CreateLegalHold_ResponseSyntax) **   <a name="Backup-CreateLegalHold-response-Status"></a>
法務保存的狀態。  
類型：字串  
有效值:`CREATING | ACTIVE | CANCELING | CANCELED` 

 ** [Title](#API_CreateLegalHold_ResponseSyntax) **   <a name="Backup-CreateLegalHold-response-Title"></a>
法務保存的標題。  
類型：字串

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

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

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

HTTP 狀態碼：400

 ** LimitExceededException **   
請求已超過限制；例如，請求中允許的最大項目數量。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# CreateLogicallyAirGappedBackupVault
<a name="API_CreateLogicallyAirGappedBackupVault"></a>

建立可複製備份的邏輯容器。

這項請求包括名稱、區域、保留天數上限、保留天數下限，並可選擇性地包含標籤和建立者請求 ID。

**注意**  
不得在備份文件庫名稱中包含敏感資料，例如護照號碼。

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

```
PUT /logically-air-gapped-backup-vaults/backupVaultName HTTP/1.1
Content-type: application/json

{
   "BackupVaultTags": { 
      "string" : "string" 
   },
   "CreatorRequestId": "string",
   "EncryptionKeyArn": "string",
   "MaxRetentionDays": number,
   "MinRetentionDays": number
}
```

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

請求會使用下列 URI 參數。

 ** [backupVaultName](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **   <a name="Backup-CreateLogicallyAirGappedBackupVault-request-uri-BackupVaultName"></a>
存放備份的邏輯容器名稱。邏輯氣隙隔離備份保存庫依名稱識別，這些名稱對用於建立保存庫的帳戶和區域來說是唯一的。  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必要：是

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

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

 ** [BackupVaultTags](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **   <a name="Backup-CreateLogicallyAirGappedBackupVault-request-BackupVaultTags"></a>
要指派給保存庫的標籤。  
類型：字串到字串映射  
必要：否

 ** [CreatorRequestId](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **   <a name="Backup-CreateLogicallyAirGappedBackupVault-request-CreatorRequestId"></a>
建立請求的 ID。  
此為選用參數。如果使用，此參數必須包含 1 至 50 個英數字元或 '-\$1'。字元。  
類型：字串  
必要：否

 ** [EncryptionKeyArn](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **   <a name="Backup-CreateLogicallyAirGappedBackupVault-request-EncryptionKeyArn"></a>
客戶受管 KMS 金鑰的 ARN，用於加密邏輯氣隙隔離備份文件庫。如果未指定，則會使用由 AWS Backup 管理的 AWS擁有金鑰來加密保存庫。  
類型：字串  
必要：否

 ** [MaxRetentionDays](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **   <a name="Backup-CreateLogicallyAirGappedBackupVault-request-MaxRetentionDays"></a>
保存庫保留其復原點的最大保留期間。  
類型：Long  
必要：是

 ** [MinRetentionDays](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **   <a name="Backup-CreateLogicallyAirGappedBackupVault-request-MinRetentionDays"></a>
這項設定可指定保存庫保留復原點的最短保留期間。  
接受的最小值為 7 天。  
類型：Long  
必要：是

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

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

{
   "BackupVaultArn": "string",
   "BackupVaultName": "string",
   "CreationDate": number,
   "VaultState": "string"
}
```

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

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

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

 ** [BackupVaultArn](#API_CreateLogicallyAirGappedBackupVault_ResponseSyntax) **   <a name="Backup-CreateLogicallyAirGappedBackupVault-response-BackupVaultArn"></a>
保存庫的 ARN (Amazon Resource Name)。  
類型：字串

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

 ** [CreationDate](#API_CreateLogicallyAirGappedBackupVault_ResponseSyntax) **   <a name="Backup-CreateLogicallyAirGappedBackupVault-response-CreationDate"></a>
建立保存庫的日期和時間。  
此值採用 Unix 格式、國際標準時間 (UTC)，且精確至毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [VaultState](#API_CreateLogicallyAirGappedBackupVault_ResponseSyntax) **   <a name="Backup-CreateLogicallyAirGappedBackupVault-response-VaultState"></a>
保存庫的目前狀態。  
類型：字串  
有效值:`CREATING | AVAILABLE | FAILED` 

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

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

 ** AlreadyExistsException **   
所需資源已存在。    
 ** Arn **   
  
 ** Context **   
  
 ** CreatorRequestId **   
  
 ** Type **   

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

 ** LimitExceededException **   
請求已超過限制；例如，請求中允許的最大項目數量。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# CreateReportPlan
<a name="API_CreateReportPlan"></a>

建立報告計畫。報告計畫是一種文件，其中包含報告內容以及 AWS Backup 報告交付位置的相關資訊。

如果呼叫 `CreateReportPlan` 已經存在的計畫，您會收到 `AlreadyExistsException` 例外。

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

```
POST /audit/report-plans HTTP/1.1
Content-type: application/json

{
   "IdempotencyToken": "string",
   "ReportDeliveryChannel": { 
      "Formats": [ "string" ],
      "S3BucketName": "string",
      "S3KeyPrefix": "string"
   },
   "ReportPlanDescription": "string",
   "ReportPlanName": "string",
   "ReportPlanTags": { 
      "string" : "string" 
   },
   "ReportSetting": { 
      "Accounts": [ "string" ],
      "FrameworkArns": [ "string" ],
      "NumberOfFrameworks": number,
      "OrganizationUnits": [ "string" ],
      "Regions": [ "string" ],
      "ReportTemplate": "string"
   }
}
```

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

請求不會使用任何 URI 參數。

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

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

 ** [IdempotencyToken](#API_CreateReportPlan_RequestSyntax) **   <a name="Backup-CreateReportPlan-request-IdempotencyToken"></a>
客戶所選擇的字串，可用來區分在其他方面相同的 `CreateReportPlanInput` 呼叫。重試具有相同等冪性字符的成功請求會導致出現成功消息，但未執行任何動作。  
類型：字串  
必要：否

 ** [ReportDeliveryChannel](#API_CreateReportPlan_RequestSyntax) **   <a name="Backup-CreateReportPlan-request-ReportDeliveryChannel"></a>
包含有關在何處和如何交付報告的架構，特別是 Amazon S3 儲存貯體名稱、S3 金鑰字首以及報告格式。  
類型：[ReportDeliveryChannel](API_ReportDeliveryChannel.md) 物件  
必要：是

 ** [ReportPlanDescription](#API_CreateReportPlan_RequestSyntax) **   <a name="Backup-CreateReportPlan-request-ReportPlanDescription"></a>
報告計畫的選用描述，最多可包含 1,024 個字元。  
類型：字串  
長度限制：長度下限為 0。長度上限為 1024。  
模式：`.*\S.*`  
必要：否

 ** [ReportPlanName](#API_CreateReportPlan_RequestSyntax) **   <a name="Backup-CreateReportPlan-request-ReportPlanName"></a>
報告計畫的唯一名稱。此名稱的長度必須介於 1 到 256 個字元，以英文字母開頭，由英文字母 (a-z、A-Z)、數字 (0-9) 和底線 (\$1) 組成。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z][_a-zA-Z0-9]*`  
必要：是

 ** [ReportPlanTags](#API_CreateReportPlan_RequestSyntax) **   <a name="Backup-CreateReportPlan-request-ReportPlanTags"></a>
要指派給報告計畫的標籤。  
類型：字串到字串映射  
必要：否

 ** [ReportSetting](#API_CreateReportPlan_RequestSyntax) **   <a name="Backup-CreateReportPlan-request-ReportSetting"></a>
識別報告的報告範本。使用報告範本建立的報告。報告範本包括：  
 `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT | SCAN_JOB_REPORT `   
如果報告範本是 `RESOURCE_COMPLIANCE_REPORT`或 `CONTROL_COMPLIANCE_REPORT`，此 API 資源也會描述 AWS 區域 和 架構的報告涵蓋範圍。  
類型：[ReportSetting](API_ReportSetting.md) 物件  
必要：是

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

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

{
   "CreationTime": number,
   "ReportPlanArn": "string",
   "ReportPlanName": "string"
}
```

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

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

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

 ** [CreationTime](#API_CreateReportPlan_ResponseSyntax) **   <a name="Backup-CreateReportPlan-response-CreationTime"></a>
建立備份保存庫時的日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。`CreationTime` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [ReportPlanArn](#API_CreateReportPlan_ResponseSyntax) **   <a name="Backup-CreateReportPlan-response-ReportPlanArn"></a>
可唯一識別資源的 Amazon Resource Name (ARN)。ARN 的格式取決於資源類型。  
類型：字串

 ** [ReportPlanName](#API_CreateReportPlan_ResponseSyntax) **   <a name="Backup-CreateReportPlan-response-ReportPlanName"></a>
報告計畫的唯一名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z][_a-zA-Z0-9]*`

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

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

 ** AlreadyExistsException **   
所需資源已存在。    
 ** Arn **   
  
 ** Context **   
  
 ** CreatorRequestId **   
  
 ** Type **   

HTTP 狀態碼：400

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

HTTP 狀態碼：400

 ** LimitExceededException **   
請求已超過限制；例如，請求中允許的最大項目數量。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# CreateRestoreAccessBackupVault
<a name="API_CreateRestoreAccessBackupVault"></a>

建立還原存取備份文件庫，以便在邏輯氣隙隔離備份文件庫中暫時存取復原點，但需經過 MPA 核准。

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

```
PUT /restore-access-backup-vaults HTTP/1.1
Content-type: application/json

{
   "BackupVaultName": "string",
   "BackupVaultTags": { 
      "string" : "string" 
   },
   "CreatorRequestId": "string",
   "RequesterComment": "string",
   "SourceBackupVaultArn": "string"
}
```

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

請求不會使用任何 URI 參數。

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

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

 ** [BackupVaultName](#API_CreateRestoreAccessBackupVault_RequestSyntax) **   <a name="Backup-CreateRestoreAccessBackupVault-request-BackupVaultName"></a>
要與 MPA 核准團隊建立關聯的備份文件庫名稱。  
類型：字串  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必要：否

 ** [BackupVaultTags](#API_CreateRestoreAccessBackupVault_RequestSyntax) **   <a name="Backup-CreateRestoreAccessBackupVault-request-BackupVaultTags"></a>
要指派給還原存取備份文件庫的選用標籤。  
類型：字串到字串映射  
必要：否

 ** [CreatorRequestId](#API_CreateRestoreAccessBackupVault_RequestSyntax) **   <a name="Backup-CreateRestoreAccessBackupVault-request-CreatorRequestId"></a>
唯一字串，可識別請求並允許重試失敗的請求，而不會有兩次執行操作的風險。  
類型：字串  
必要：否

 ** [RequesterComment](#API_CreateRestoreAccessBackupVault_RequestSyntax) **   <a name="Backup-CreateRestoreAccessBackupVault-request-RequesterComment"></a>
註解，說明請求還原備份文件庫存取權的原因。  
類型：字串  
必要：否

 ** [SourceBackupVaultArn](#API_CreateRestoreAccessBackupVault_RequestSyntax) **   <a name="Backup-CreateRestoreAccessBackupVault-request-SourceBackupVaultArn"></a>
來源備份文件庫的 ARN，其中包含請求暫時存取的復原點。  
類型：字串  
必要：是

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

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

{
   "CreationDate": number,
   "RestoreAccessBackupVaultArn": "string",
   "RestoreAccessBackupVaultName": "string",
   "VaultState": "string"
}
```

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

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

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

 ** [CreationDate](#API_CreateRestoreAccessBackupVault_ResponseSyntax) **   <a name="Backup-CreateRestoreAccessBackupVault-response-CreationDate"></a>
> 以 Unix 格式和國際標準時間建立還原存取備份文件庫的日期和時間   
類型：Timestamp

 ** [RestoreAccessBackupVaultArn](#API_CreateRestoreAccessBackupVault_ResponseSyntax) **   <a name="Backup-CreateRestoreAccessBackupVault-response-RestoreAccessBackupVaultArn"></a>
唯一識別建立的還原存取備份文件庫的 ARN。  
類型：字串

 ** [RestoreAccessBackupVaultName](#API_CreateRestoreAccessBackupVault_ResponseSyntax) **   <a name="Backup-CreateRestoreAccessBackupVault-response-RestoreAccessBackupVaultName"></a>
建立的還原存取備份文件庫名稱。  
類型：字串  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`

 ** [VaultState](#API_CreateRestoreAccessBackupVault_ResponseSyntax) **   <a name="Backup-CreateRestoreAccessBackupVault-response-VaultState"></a>
還原存取備份保存庫的目前狀態。  
類型：字串  
有效值:`CREATING | AVAILABLE | FAILED` 

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

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

 ** AlreadyExistsException **   
所需資源已存在。    
 ** Arn **   
  
 ** Context **   
  
 ** CreatorRequestId **   
  
 ** Type **   

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

 ** LimitExceededException **   
請求已超過限制；例如，請求中允許的最大項目數量。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# CreateRestoreTestingPlan
<a name="API_CreateRestoreTestingPlan"></a>

建立還原測試計畫。

建立還原測試計畫之兩個步驟的第一步。此請求成功後，請使用 CreateRestoreTestingSelection 完成程序。

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

```
PUT /restore-testing/plans HTTP/1.1
Content-type: application/json

{
   "CreatorRequestId": "string",
   "RestoreTestingPlan": { 
      "RecoveryPointSelection": { 
         "Algorithm": "string",
         "ExcludeVaults": [ "string" ],
         "IncludeVaults": [ "string" ],
         "RecoveryPointTypes": [ "string" ],
         "SelectionWindowDays": number
      },
      "RestoreTestingPlanName": "string",
      "ScheduleExpression": "string",
      "ScheduleExpressionTimezone": "string",
      "StartWindowHours": number
   },
   "Tags": { 
      "string" : "string" 
   }
}
```

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

請求不會使用任何 URI 參數。

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

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

 ** [CreatorRequestId](#API_CreateRestoreTestingPlan_RequestSyntax) **   <a name="Backup-CreateRestoreTestingPlan-request-CreatorRequestId"></a>
此為可識別請求的不重複字串，且允許重試失敗的請求，而不會有兩次執行作業的風險。此為選用參數。如果使用，此參數必須包含 1 至 50 個英數字元或 '-\$1'。字元。  
類型：字串  
必要：否

 ** [RestoreTestingPlan](#API_CreateRestoreTestingPlan_RequestSyntax) **   <a name="Backup-CreateRestoreTestingPlan-request-RestoreTestingPlan"></a>
還原測試計畫必須包含您建立的不重複 `RestoreTestingPlanName` 字串，並且必須包含 `ScheduleExpression` cron。您可以選擇性包含 `StartWindowHours` 整數和 `CreatorRequestId` 字串。  
`RestoreTestingPlanName` 是不重複的字串，也是還原測試計畫的名稱。您無法在建立後變更此名稱，其必須只包含英數字元和底線。  
類型：[RestoreTestingPlanForCreate](API_RestoreTestingPlanForCreate.md) 物件  
必要：是

 ** [Tags](#API_CreateRestoreTestingPlan_RequestSyntax) **   <a name="Backup-CreateRestoreTestingPlan-request-Tags"></a>
要指派給還原測試計畫的標籤。  
類型：字串到字串映射  
必要：否

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

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

{
   "CreationTime": number,
   "RestoreTestingPlanArn": "string",
   "RestoreTestingPlanName": "string"
}
```

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

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

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

 ** [CreationTime](#API_CreateRestoreTestingPlan_ResponseSyntax) **   <a name="Backup-CreateRestoreTestingPlan-response-CreationTime"></a>
建立還原測試計畫的日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。`CreationTime` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [RestoreTestingPlanArn](#API_CreateRestoreTestingPlan_ResponseSyntax) **   <a name="Backup-CreateRestoreTestingPlan-response-RestoreTestingPlanArn"></a>
唯一識別所建立還原測試計畫的 Amazon Resource Name (ARN)。  
類型：字串

 ** [RestoreTestingPlanName](#API_CreateRestoreTestingPlan_ResponseSyntax) **   <a name="Backup-CreateRestoreTestingPlan-response-RestoreTestingPlanName"></a>
此不重複字串是還原測試計畫的名稱。  
此名稱建立後就不可變更。此名稱僅包含英數字元和底線。長度上限為 50。  
類型：字串

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

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

 ** AlreadyExistsException **   
所需資源已存在。    
 ** Arn **   
  
 ** Context **   
  
 ** CreatorRequestId **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ConflictException **   
 AWS Backup 在完成執行先前的動作之前， 無法執行您請求的動作。請稍後再試。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

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

HTTP 狀態碼：400

 ** LimitExceededException **   
請求已超過限制；例如，請求中允許的最大項目數量。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# CreateRestoreTestingSelection
<a name="API_CreateRestoreTestingSelection"></a>

CreateRestoreTestingPlan 請求成功傳回後，即可傳送此請求。這是建立資源測試計畫的第二部分，必須按順序完成。

其中包括 `RestoreTestingSelectionName`、`ProtectedResourceType` 以及下列其中一項：
+  `ProtectedResourceArns` 
+  `ProtectedResourceConditions` 

每個受保護的資源類型可以有一個單一值。

還原測試選擇可以包含 `ProtectedResourceArns` 和 `ProtectedResourceConditions` 的萬用字元值 (「\$1」)。或者，您可以在 `ProtectedResourceArns` 中包含最多 30 個特定受保護的資源 ARN。

無法同時依照受保護的資源類型和特定 ARN 進行選取。如果兩者都包含，則請求將失敗。

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

```
PUT /restore-testing/plans/RestoreTestingPlanName/selections HTTP/1.1
Content-type: application/json

{
   "CreatorRequestId": "string",
   "RestoreTestingSelection": { 
      "IamRoleArn": "string",
      "ProtectedResourceArns": [ "string" ],
      "ProtectedResourceConditions": { 
         "StringEquals": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "StringNotEquals": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ]
      },
      "ProtectedResourceType": "string",
      "RestoreMetadataOverrides": { 
         "string" : "string" 
      },
      "RestoreTestingSelectionName": "string",
      "ValidationWindowHours": number
   }
}
```

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

請求會使用下列 URI 參數。

 ** [RestoreTestingPlanName](#API_CreateRestoreTestingSelection_RequestSyntax) **   <a name="Backup-CreateRestoreTestingSelection-request-uri-RestoreTestingPlanName"></a>
輸入從相關 CreateRestoreTestingPlan 請求傳回的還原測試計畫名稱。  
必要：是

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

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

 ** [CreatorRequestId](#API_CreateRestoreTestingSelection_RequestSyntax) **   <a name="Backup-CreateRestoreTestingSelection-request-CreatorRequestId"></a>
此為可識別請求的選用不重複字串，且允許重試失敗的請求，而不會有兩次執行作業的風險。如果使用，此參數必須包含 1 至 50 個英數字元或 '-\$1'。字元。  
類型：字串  
必要：否

 ** [RestoreTestingSelection](#API_CreateRestoreTestingSelection_RequestSyntax) **   <a name="Backup-CreateRestoreTestingSelection-request-RestoreTestingSelection"></a>
其中包括 `RestoreTestingSelectionName`、`ProtectedResourceType` 以及下列其中一項：  
+  `ProtectedResourceArns` 
+  `ProtectedResourceConditions` 
每個受保護的資源類型可以有一個單一值。  
還原測試選擇可以包含 `ProtectedResourceArns` 和 `ProtectedResourceConditions` 的萬用字元值 (「\$1」)。或者，您可以在 `ProtectedResourceArns` 中包含最多 30 個特定受保護的資源 ARN。  
類型：[RestoreTestingSelectionForCreate](API_RestoreTestingSelectionForCreate.md) 物件  
必要：是

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

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

{
   "CreationTime": number,
   "RestoreTestingPlanArn": "string",
   "RestoreTestingPlanName": "string",
   "RestoreTestingSelectionName": "string"
}
```

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

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

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

 ** [CreationTime](#API_CreateRestoreTestingSelection_ResponseSyntax) **   <a name="Backup-CreateRestoreTestingSelection-response-CreationTime"></a>
建立資源測試選擇的時間。  
類型：Timestamp

 ** [RestoreTestingPlanArn](#API_CreateRestoreTestingSelection_ResponseSyntax) **   <a name="Backup-CreateRestoreTestingSelection-response-RestoreTestingPlanArn"></a>
還原測試計劃的 ARN，與還原測試選擇相關聯。  
類型：字串

 ** [RestoreTestingPlanName](#API_CreateRestoreTestingSelection_ResponseSyntax) **   <a name="Backup-CreateRestoreTestingSelection-response-RestoreTestingPlanName"></a>
還原測試計劃的名稱。  
此名稱建立後就不可變更。此名稱僅包含英數字元和底線。長度上限為 50。  
類型：字串

 ** [RestoreTestingSelectionName](#API_CreateRestoreTestingSelection_ResponseSyntax) **   <a name="Backup-CreateRestoreTestingSelection-response-RestoreTestingSelectionName"></a>
相關還原測試計畫的還原測試選擇名稱。  
此名稱建立後就不可變更。此名稱僅包含英數字元和底線。長度上限為 50。  
類型：字串

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

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

 ** AlreadyExistsException **   
所需資源已存在。    
 ** Arn **   
  
 ** Context **   
  
 ** CreatorRequestId **   
  
 ** Type **   

HTTP 狀態碼：400

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

HTTP 狀態碼：400

 ** LimitExceededException **   
請求已超過限制；例如，請求中允許的最大項目數量。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# CreateTieringConfiguration
<a name="API_CreateTieringConfiguration"></a>

建立分層組態。

分層組態可根據備份文件庫中備份物件的存留期，自動將備份資料移至成本較低的儲存層。

除了套用至所有保存庫的任何全域組態之外，每個保存庫只能有一個保存庫特定的分層組態。

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

```
PUT /tiering-configurations HTTP/1.1
Content-type: application/json

{
   "CreatorRequestId": "string",
   "TieringConfiguration": { 
      "BackupVaultName": "string",
      "ResourceSelection": [ 
         { 
            "Resources": [ "string" ],
            "ResourceType": "string",
            "TieringDownSettingsInDays": number
         }
      ],
      "TieringConfigurationName": "string"
   },
   "TieringConfigurationTags": { 
      "string" : "string" 
   }
}
```

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

請求不會使用任何 URI 參數。

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

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

 ** [CreatorRequestId](#API_CreateTieringConfiguration_RequestSyntax) **   <a name="Backup-CreateTieringConfiguration-request-CreatorRequestId"></a>
這是可識別請求的唯一字串，並允許重試失敗的請求，而不會有執行操作兩次的風險。此為選用參數。如果使用，此參數必須包含 1 至 50 個英數字元或 '-\$1'。字元。  
類型：字串  
必要：否

 ** [TieringConfiguration](#API_CreateTieringConfiguration_RequestSyntax) **   <a name="Backup-CreateTieringConfiguration-request-TieringConfiguration"></a>
分層組態必須包含您建立的唯一`TieringConfigurationName`字串，且必須包含 `BackupVaultName`和 `ResourceSelection`。您可以選擇性地包含`CreatorRequestId`字串。  
`TieringConfigurationName` 是分層組態名稱的唯一字串。您無法在建立後變更此名稱，其必須只包含英數字元和底線。  
類型：[TieringConfigurationInputForCreate](API_TieringConfigurationInputForCreate.md) 物件  
必要：是

 ** [TieringConfigurationTags](#API_CreateTieringConfiguration_RequestSyntax) **   <a name="Backup-CreateTieringConfiguration-request-TieringConfigurationTags"></a>
要指派給分層組態的標籤。  
類型：字串到字串映射  
必要：否

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

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

{
   "CreationTime": number,
   "TieringConfigurationArn": "string",
   "TieringConfigurationName": "string"
}
```

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

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

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

 ** [CreationTime](#API_CreateTieringConfiguration_ResponseSyntax) **   <a name="Backup-CreateTieringConfiguration-response-CreationTime"></a>
建立分層組態的日期和時間，採用 Unix 格式和國際標準時間 (UTC)。`CreationTime` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [TieringConfigurationArn](#API_CreateTieringConfiguration_ResponseSyntax) **   <a name="Backup-CreateTieringConfiguration-response-TieringConfigurationArn"></a>
唯一識別所建立分層組態的 Amazon Resource Name (ARN)。  
類型：字串

 ** [TieringConfigurationName](#API_CreateTieringConfiguration_ResponseSyntax) **   <a name="Backup-CreateTieringConfiguration-response-TieringConfigurationName"></a>
此唯一字串是分層組態的名稱。  
此名稱建立後就不可變更。此名稱僅包含英數字元和底線。長度上限為 200。  
類型：字串

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

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

 ** AlreadyExistsException **   
所需資源已存在。    
 ** Arn **   
  
 ** Context **   
  
 ** CreatorRequestId **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ConflictException **   
 AWS Backup 在完成執行先前的動作之前， 無法執行您請求的動作。請稍後再試。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

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

HTTP 狀態碼：400

 ** LimitExceededException **   
請求已超過限制；例如，請求中允許的最大項目數量。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# DeleteBackupPlan
<a name="API_DeleteBackupPlan"></a>

刪除備份計劃。只有在刪除所有相關聯的選取資源之後，才能刪除備份計劃。刪除備份計劃將會刪除該備份計劃的目前版本。先前的版本 (若有) 將依然存在。

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

```
DELETE /backup/plans/backupPlanId HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [backupPlanId](#API_DeleteBackupPlan_RequestSyntax) **   <a name="Backup-DeleteBackupPlan-request-uri-BackupPlanId"></a>
唯一識別備份計畫。  
必要：是

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

請求沒有請求主體。

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

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

{
   "BackupPlanArn": "string",
   "BackupPlanId": "string",
   "DeletionDate": number,
   "VersionId": "string"
}
```

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

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

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

 ** [BackupPlanArn](#API_DeleteBackupPlan_ResponseSyntax) **   <a name="Backup-DeleteBackupPlan-response-BackupPlanArn"></a>
可唯一識別備份計畫的 Amazon Resource Name (ARN)，例如 `arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50`。  
類型：字串

 ** [BackupPlanId](#API_DeleteBackupPlan_ResponseSyntax) **   <a name="Backup-DeleteBackupPlan-response-BackupPlanId"></a>
唯一識別備份計畫。  
類型：字串

 ** [DeletionDate](#API_DeleteBackupPlan_ResponseSyntax) **   <a name="Backup-DeleteBackupPlan-response-DeletionDate"></a>
刪除備份計劃時的日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。`DeletionDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [VersionId](#API_DeleteBackupPlan_ResponseSyntax) **   <a name="Backup-DeleteBackupPlan-response-VersionId"></a>
唯一隨機產生的 Unicode、UTF-8 編碼字串，最長 1,024 個位元組。版本 ID 不能編輯。  
類型：字串

## 錯誤
<a name="API_DeleteBackupPlan_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_DeleteBackupPlan_SeeAlso"></a>

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

# DeleteBackupSelection
<a name="API_DeleteBackupSelection"></a>

刪除與備份計劃 (由 `SelectionId` 指定) 相關聯的資源選取項目。

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

```
DELETE /backup/plans/backupPlanId/selections/selectionId HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [backupPlanId](#API_DeleteBackupSelection_RequestSyntax) **   <a name="Backup-DeleteBackupSelection-request-uri-BackupPlanId"></a>
唯一識別備份計畫。  
必要：是

 ** [selectionId](#API_DeleteBackupSelection_RequestSyntax) **   <a name="Backup-DeleteBackupSelection-request-uri-SelectionId"></a>
可唯一識別請求本文，將一組資源指派給備份計劃。  
必要：是

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

請求沒有請求主體。

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

```
HTTP/1.1 200
```

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

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

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# DeleteBackupVault
<a name="API_DeleteBackupVault"></a>

刪除以其名稱識別的備份保存庫。只有在保存庫為空時才能刪除。

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

```
DELETE /backup-vaults/backupVaultName HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [backupVaultName](#API_DeleteBackupVault_RequestSyntax) **   <a name="Backup-DeleteBackupVault-request-uri-BackupVaultName"></a>
存放備份的邏輯容器名稱。備份文件庫依名稱識別，這些名稱對建立文件庫的帳戶和 AWS 區域來說是唯一的。  
必要：是

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

請求沒有請求主體。

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

```
HTTP/1.1 200
```

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

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

## 錯誤
<a name="API_DeleteBackupVault_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_DeleteBackupVault_SeeAlso"></a>

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

# DeleteBackupVaultAccessPolicy
<a name="API_DeleteBackupVaultAccessPolicy"></a>

刪除管理備份保存庫許可的政策文件。

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

```
DELETE /backup-vaults/backupVaultName/access-policy HTTP/1.1
```

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

請求會使用下列 URI 參數。

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

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

請求沒有請求主體。

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

```
HTTP/1.1 200
```

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

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

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# DeleteBackupVaultLockConfiguration
<a name="API_DeleteBackupVaultLockConfiguration"></a>

從備份保存庫名稱指定的備份保存庫中刪除保存庫 AWS Backup 鎖定。

如果Vault Lock 組態不可變，則您無法使用 API 操作刪除 Vault Lock ，如果您嘗試這項動作，您將收到一個 `InvalidRequestException`。如需詳細資訊，請參閱《 * AWS Backup 開發人員指南*》中的[保存庫鎖定](https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html)。

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

```
DELETE /backup-vaults/backupVaultName/vault-lock HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [backupVaultName](#API_DeleteBackupVaultLockConfiguration_RequestSyntax) **   <a name="Backup-DeleteBackupVaultLockConfiguration-request-uri-BackupVaultName"></a>
要從中刪除保存庫鎖定的備份 AWS Backup 保存庫名稱。  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必要：是

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

請求沒有請求主體。

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

```
HTTP/1.1 200
```

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

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

## 錯誤
<a name="API_DeleteBackupVaultLockConfiguration_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_DeleteBackupVaultLockConfiguration_SeeAlso"></a>

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

# DeleteBackupVaultNotifications
<a name="API_DeleteBackupVaultNotifications"></a>

刪除指定備份文件庫的事件通知。

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

```
DELETE /backup-vaults/backupVaultName/notification-configuration HTTP/1.1
```

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

請求會使用下列 URI 參數。

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

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

請求沒有請求主體。

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

```
HTTP/1.1 200
```

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

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

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# DeleteFramework
<a name="API_DeleteFramework"></a>

刪除由架構名稱指定的架構。

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

```
DELETE /audit/frameworks/frameworkName HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [frameworkName](#API_DeleteFramework_RequestSyntax) **   <a name="Backup-DeleteFramework-request-uri-FrameworkName"></a>
架構的唯一名稱。  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z][_a-zA-Z0-9]*`  
必要：是

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

請求沒有請求主體。

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

```
HTTP/1.1 200
```

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

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

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

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

 ** ConflictException **   
 AWS Backup 在完成執行先前的動作之前， 無法執行您請求的動作。請稍後再試。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# DeleteRecoveryPoint
<a name="API_DeleteRecoveryPoint"></a>

可刪除復原點 ID 所指定的復原點。

如果復原點 ID 屬於連續備份，則呼叫此端點會刪除現有的持續備份，並停止未來的持續備份。

當 IAM 角色的許可不足以呼叫此 API 時，服務會傳回含有空白 HTTP 內文的 HTTP 200 回應，但不會刪除復原點。相反的，其會進入 `EXPIRED` 狀態。

 一旦 IAM 角色執行 `iam:CreateServiceLinkedRole` 動作，就可以使用此 API 刪除 `EXPIRED` 復原點。若要深入了解如何新增此角色，請參閱[疑難排解手動刪除](https://docs.aws.amazon.com/aws-backup/latest/devguide/deleting-backups.html#deleting-backups-troubleshooting)。

如果刪除使用者或角色，或移除角色內的許可，則刪除將不會成功，並將進入 `EXPIRED` 狀態。

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

```
DELETE /backup-vaults/backupVaultName/recovery-points/recoveryPointArn HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [backupVaultName](#API_DeleteRecoveryPoint_RequestSyntax) **   <a name="Backup-DeleteRecoveryPoint-request-uri-BackupVaultName"></a>
存放備份的邏輯容器名稱。備份文件庫依名稱識別，這些名稱對建立文件庫的帳戶和 AWS 區域來說是唯一的。  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必要：是

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

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

請求沒有請求主體。

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

```
HTTP/1.1 200
```

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

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

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

 ** InvalidResourceStateException **   
 AWS Backup 正在對此復原點執行動作。在第一個動作完成之前，其無法執行您要求的動作。請稍後再試。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# DeleteReportPlan
<a name="API_DeleteReportPlan"></a>

刪除由報告計劃名稱所指定的報告計劃。

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

```
DELETE /audit/report-plans/reportPlanName HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [reportPlanName](#API_DeleteReportPlan_RequestSyntax) **   <a name="Backup-DeleteReportPlan-request-uri-ReportPlanName"></a>
報告計畫的唯一名稱。  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z][_a-zA-Z0-9]*`  
必要：是

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

請求沒有請求主體。

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

```
HTTP/1.1 200
```

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

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

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

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

 ** ConflictException **   
 AWS Backup 在完成執行先前的動作之前， 無法執行您請求的動作。請稍後再試。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# DeleteRestoreTestingPlan
<a name="API_DeleteRestoreTestingPlan"></a>

此請求會刪除指定的還原測試計畫。

只有先刪除所有關聯的還原測試選擇後，才能成功刪除。

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

```
DELETE /restore-testing/plans/RestoreTestingPlanName HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [RestoreTestingPlanName](#API_DeleteRestoreTestingPlan_RequestSyntax) **   <a name="Backup-DeleteRestoreTestingPlan-request-uri-RestoreTestingPlanName"></a>
要刪除的還原測試計畫的必要不重複名稱。  
必要：是

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

請求沒有請求主體。

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

```
HTTP/1.1 204
```

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

如果動作成功，則服務會送回具有空 HTTP 主體的 HTTP 204 回應。

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# DeleteRestoreTestingSelection
<a name="API_DeleteRestoreTestingSelection"></a>

輸入還原測試計畫名稱和還原測試選擇名稱。

必須刪除與還原測試計畫相關聯的所有測試選擇，然後才能刪除還原測試計畫。

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

```
DELETE /restore-testing/plans/RestoreTestingPlanName/selections/RestoreTestingSelectionName HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [RestoreTestingPlanName](#API_DeleteRestoreTestingSelection_RequestSyntax) **   <a name="Backup-DeleteRestoreTestingSelection-request-uri-RestoreTestingPlanName"></a>
還原測試計畫的必要不重複名稱，此還原測試計畫中包含您要刪除的還原測試選擇。  
必要：是

 ** [RestoreTestingSelectionName](#API_DeleteRestoreTestingSelection_RequestSyntax) **   <a name="Backup-DeleteRestoreTestingSelection-request-uri-RestoreTestingSelectionName"></a>
您要刪除之還原測試選擇的必要不重複名稱。  
必要：是

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

請求沒有請求主體。

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

```
HTTP/1.1 204
```

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

如果動作成功，則服務會送回具有空 HTTP 主體的 HTTP 204 回應。

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# DeleteTieringConfiguration
<a name="API_DeleteTieringConfiguration"></a>

刪除分層組態名稱指定的分層組態。

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

```
DELETE /tiering-configurations/tieringConfigurationName HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [tieringConfigurationName](#API_DeleteTieringConfiguration_RequestSyntax) **   <a name="Backup-DeleteTieringConfiguration-request-uri-TieringConfigurationName"></a>
分層組態的唯一名稱。  
模式：`^[a-zA-Z0-9_]{1,200}$`  
必要：是

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

請求沒有請求主體。

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

```
HTTP/1.1 200
```

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

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

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# DescribeBackupJob
<a name="API_DescribeBackupJob"></a>

傳回指定之 `BackupJobId` 的備份詳細資訊。

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

```
GET /backup-jobs/backupJobId HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [backupJobId](#API_DescribeBackupJob_RequestSyntax) **   <a name="Backup-DescribeBackupJob-request-uri-BackupJobId"></a>
唯一識別 AWS Backup 對 備份資源的請求。  
必要：是

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

請求沒有請求主體。

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

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

{
   "AccountId": "string",
   "BackupJobId": "string",
   "BackupOptions": { 
      "string" : "string" 
   },
   "BackupSizeInBytes": number,
   "BackupType": "string",
   "BackupVaultArn": "string",
   "BackupVaultName": "string",
   "BytesTransferred": number,
   "ChildJobsInState": { 
      "string" : number 
   },
   "CompletionDate": number,
   "CreatedBy": { 
      "BackupPlanArn": "string",
      "BackupPlanId": "string",
      "BackupPlanName": "string",
      "BackupPlanVersion": "string",
      "BackupRuleCron": "string",
      "BackupRuleId": "string",
      "BackupRuleName": "string",
      "BackupRuleTimezone": "string"
   },
   "CreationDate": number,
   "EncryptionKeyArn": "string",
   "ExpectedCompletionDate": number,
   "IamRoleArn": "string",
   "InitiationDate": number,
   "IsEncrypted": boolean,
   "IsParent": boolean,
   "MessageCategory": "string",
   "NumberOfChildJobs": number,
   "ParentJobId": "string",
   "PercentDone": "string",
   "RecoveryPointArn": "string",
   "RecoveryPointLifecycle": { 
      "DeleteAfterDays": number,
      "DeleteAfterEvent": "string",
      "MoveToColdStorageAfterDays": number,
      "OptInToArchiveForSupportedResources": boolean
   },
   "ResourceArn": "string",
   "ResourceName": "string",
   "ResourceType": "string",
   "StartBy": number,
   "State": "string",
   "StatusMessage": "string",
   "VaultLockState": "string",
   "VaultType": "string"
}
```

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

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

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

 ** [AccountId](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-AccountId"></a>
傳回擁有備份任務的帳戶 ID。  
類型：字串  
模式：`^[0-9]{12}$`

 ** [BackupJobId](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-BackupJobId"></a>
唯一識別 AWS Backup 對 備份資源的請求。  
類型：字串

 ** [BackupOptions](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-BackupOptions"></a>
代表指定為備份計畫或隨需備份任務之一部分的選項。  
類型：字串到字串映射  
金鑰模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
值模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`

 ** [BackupSizeInBytes](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-BackupSizeInBytes"></a>
備份的大小，以位元組為單位 （復原點）。  
根據資源類型，此值的轉譯方式可能不同，因為 會從其他 AWS 服務 AWS Backup 提取資料資訊。例如，傳回的值可能顯示 的值`0`，這可能與預期值不同。  
依資源類型列出的值預期行為如下所述：  
+ Amazon Aurora、Amazon DocumentDB 和 Amazon Neptune 不會從操作 填入此值`GetBackupJobStatus`。
+ 對於具有進階功能的 Amazon DynamoDB，此值是指復原點 （備份） 的大小。
+ Amazon EC2 和 Amazon EBS 會顯示在此值中傳回的磁碟區大小 （佈建儲存）。Amazon EBS 不會傳回備份大小資訊；快照大小的值將與已備份的原始資源相同。
+ 對於 Amazon EFS，此值是指備份期間傳輸的差異位元組。
+ 對於 Amazon EKS，此值是指巢狀 EKS 復原點的大小。
+ Amazon FSx 不會從 FSx 檔案系統的 `GetBackupJobStatus` 操作填入此值。
+ Amazon RDS 執行個體會顯示為 `0`。
+ 對於執行 VMware 的虛擬機器，此值會透過非同步工作流程傳遞至 AWS Backup ，這表示此顯示值可能表示實際備份大小不足。
類型：Long

 ** [BackupType](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-BackupType"></a>
代表針對備份任務所選取的實際備份類型。例如，如果成功取得 Windows 磁碟區陰影複製服務 (VSS) 備份，`BackupType` 會傳回 `"WindowsVSS"`。如果 `BackupType` 為空，則備份類型為定期備份。  
類型：字串

 ** [BackupVaultArn](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-BackupVaultArn"></a>
可唯一識別備份文件庫的 Amazon Resource Name (ARN)，例如 `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`。  
類型：字串

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

 ** [BytesTransferred](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-BytesTransferred"></a>
查詢任務狀態時傳輸至備份文件庫的大小 (以位元組為單位)。  
類型：Long

 ** [ChildJobsInState](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-ChildJobsInState"></a>
這會傳回所包含之子 (巢狀) 複製任務的統計資訊。  
類型：字串到長映射  
有效金鑰：`CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL`

 ** [CompletionDate](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-CompletionDate"></a>
某任務建立備份任務的完成日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。`CompletionDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [CreatedBy](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-CreatedBy"></a>
含有建立備份任務的相關識別資訊，包括用以建立備份任務之備份計畫的 `BackupPlanArn`、`BackupPlanId`、`BackupPlanVersion` 和 `BackupRuleId`。  
類型：[RecoveryPointCreator](API_RecoveryPointCreator.md) 物件

 ** [CreationDate](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-CreationDate"></a>
建立備份任務時的日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。`CreationDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [EncryptionKeyArn](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-EncryptionKeyArn"></a>
用來加密備份之 KMS 金鑰的 Amazon Resource Name (ARN)。這可以是客戶受管金鑰或 AWS 受管金鑰，取決於保存庫組態。  
類型：字串

 ** [ExpectedCompletionDate](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-ExpectedCompletionDate"></a>
某任務備份資源預期完成的日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。`ExpectedCompletionDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [IamRoleArn](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-IamRoleArn"></a>
指定用來建立目標復原點的 IAM 角色 ARN；例如 `arn:aws:iam::123456789012:role/S3Access`。  
類型：字串

 ** [InitiationDate](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-InitiationDate"></a>
備份任務啟動的日期。  
類型：Timestamp

 ** [IsEncrypted](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-IsEncrypted"></a>
指出備份是否已加密的布林值。中的所有備份 AWS Backup 都會加密，但此欄位會指出加密狀態以確保透明度。  
類型：布林值

 ** [IsParent](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-IsParent"></a>
這會傳回備份任務為父項 (複合) 任務的布林值。  
類型：布林值

 ** [MessageCategory](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-MessageCategory"></a>
指定訊息類別的任務計數。  
範例字串可能包括 `AccessDenied`、`SUCCESS`、`AGGREGATE_ALL` 和 `INVALIDPARAMETERS`。查看[監控](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html)以取得接受的 MessageCategory 字串清單。  
類型：字串

 ** [NumberOfChildJobs](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-NumberOfChildJobs"></a>
這會傳回子 (巢狀) 備份任務的數目。  
類型：Long

 ** [ParentJobId](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-ParentJobId"></a>
這會傳回父項 (複合) 資源備份任務 ID。  
類型：字串

 ** [PercentDone](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-PercentDone"></a>
包含查詢任務狀態時，任務的預估完成百分比。  
類型：字串

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

 ** [RecoveryPointLifecycle](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-RecoveryPointLifecycle"></a>
指定復原點轉換為冷儲存或刪除之前的期間，以天為單位。  
轉移至冷儲存的備份必須在冷儲存中存放至少 90 天之久。因此，在 主控台上，保留設定必須比轉換至冷的超過 90 天。備份轉換為冷後，就無法變更轉換為冷。  
可轉換為冷儲存的資源類型會列在[資源資料表的功能可用性](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource)中。 會 AWS Backup 忽略其他資源類型的此表達式。  
若要移除現有的生命週期和保留期間並無限期保留復原點，請為 `MoveToColdStorageAfterDays`和 指定 -1`DeleteAfterDays`。  
類型：[Lifecycle](API_Lifecycle.md) 物件

 ** [ResourceArn](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-ResourceArn"></a>
可唯一識別已儲存資源的 ARN。ARN 的格式取決於資源類型。  
類型：字串

 ** [ResourceName](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-ResourceName"></a>
屬於指定備份之資源的非唯一名稱。  
類型：字串

 ** [ResourceType](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-ResourceType"></a>
要備份 AWS 的資源類型；例如，Amazon Elastic Block Store (Amazon EBS) 磁碟區或 Amazon Relational Database Service (Amazon RDS) 資料庫。  
類型：字串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`

 ** [StartBy](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-StartBy"></a>
指定在備份任務取消之前必須開始的時間，以 Unix 格式和國際標準時間 (UTC) 顯示。該值是透過將開始時段加至排定時間來計算。因此，如果排定的時間為下午 6 點，而開始時段為 2 小時，則 `StartBy` 時間將是指定日期的下午 8 點。`StartBy` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [State](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-State"></a>
備份任務目前的狀態。  
類型：字串  
有效值:`CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL` 

 ** [StatusMessage](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-StatusMessage"></a>
說明備份資源任務狀態的詳細訊息。  
類型：字串

 ** [VaultLockState](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-VaultLockState"></a>
備份保存庫的鎖定狀態。對於邏輯氣隙隔離保存庫，這表示保存庫是否在合規模式下鎖定。有效值包括 `LOCKED` 與 `UNLOCKED`。  
類型：字串

 ** [VaultType](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-VaultType"></a>
存放復原點的備份保存庫類型。有效值`BACKUP_VAULT`適用於標準備份保存庫，`LOGICALLY_AIR_GAPPED_BACKUP_VAULT`而適用於邏輯氣隙隔離保存庫。  
類型：字串

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

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

 ** DependencyFailureException **   
相依 AWS 服務或資源傳回錯誤給 AWS Backup 服務，且無法完成動作。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# DescribeBackupVault
<a name="API_DescribeBackupVault"></a>

傳回備份保存庫 (由其名稱所指定) 的相關中繼資料。

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

```
GET /backup-vaults/backupVaultName?backupVaultAccountId=BackupVaultAccountId HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [BackupVaultAccountId](#API_DescribeBackupVault_RequestSyntax) **   <a name="Backup-DescribeBackupVault-request-uri-BackupVaultAccountId"></a>
指定備份保存庫的帳戶 ID。

 ** [backupVaultName](#API_DescribeBackupVault_RequestSyntax) **   <a name="Backup-DescribeBackupVault-request-uri-BackupVaultName"></a>
存放備份的邏輯容器名稱。備份文件庫依名稱識別，這些名稱對建立文件庫的帳戶和 AWS 區域來說是唯一的。  
必要：是

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

請求沒有請求主體。

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

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

{
   "BackupVaultArn": "string",
   "BackupVaultName": "string",
   "CreationDate": number,
   "CreatorRequestId": "string",
   "EncryptionKeyArn": "string",
   "EncryptionKeyType": "string",
   "LatestMpaApprovalTeamUpdate": { 
      "ExpiryDate": number,
      "InitiationDate": number,
      "MpaSessionArn": "string",
      "Status": "string",
      "StatusMessage": "string"
   },
   "LockDate": number,
   "Locked": boolean,
   "MaxRetentionDays": number,
   "MinRetentionDays": number,
   "MpaApprovalTeamArn": "string",
   "MpaSessionArn": "string",
   "NumberOfRecoveryPoints": number,
   "SourceBackupVaultArn": "string",
   "VaultState": "string",
   "VaultType": "string"
}
```

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

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

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

 ** [BackupVaultArn](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-BackupVaultArn"></a>
可唯一識別備份文件庫的 Amazon Resource Name (ARN)，例如 `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`。  
類型：字串

 ** [BackupVaultName](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-BackupVaultName"></a>
存放備份的邏輯容器名稱。備份文件庫依名稱識別，這些名稱對用於建立文件庫的帳戶和區域來說是唯一的。  
類型：字串

 ** [CreationDate](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-CreationDate"></a>
建立備份保存庫時的日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。`CreationDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [CreatorRequestId](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-CreatorRequestId"></a>
可識別請求的唯一字串，且允許重試失敗的請求，而不會有兩次執行操作的風險。此為選用參數。如果使用，此參數必須包含 1 至 50 個英數字元或 '-\$1'。字元。  
類型：字串

 ** [EncryptionKeyArn](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-EncryptionKeyArn"></a>
用來保護備份的伺服器端加密金鑰，例如 `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`。  
類型：字串

 ** [EncryptionKeyType](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-EncryptionKeyType"></a>
用於備份保存庫的加密金鑰類型。有效值為客戶受管金鑰的 CUSTOMER\$1MANAGED\$1KMS\$1KEY 或 AWS擁有金鑰的 AWS\$1OWNED\$1KMS\$1KEY。  
類型：字串  
有效值:`AWS_OWNED_KMS_KEY | CUSTOMER_MANAGED_KMS_KEY` 

 ** [LatestMpaApprovalTeamUpdate](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-LatestMpaApprovalTeamUpdate"></a>
此備份文件庫 MPA 核准團隊關聯的最新更新相關資訊。  
類型：[LatestMpaApprovalTeamUpdate](API_LatestMpaApprovalTeamUpdate.md) 物件

 ** [LockDate](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-LockDate"></a>
無法變更或刪除 AWS Backup 保存庫鎖定組態的日期和時間。  
如果在未指定鎖定日期的情況下，將「Vault Lock 」套用至保存庫，則可隨時變更任何「Vault Lock 」設定，或從保存庫中完全刪除「Vault Lock 」。  
此值採用 Unix 格式、國際標準時間 (UTC)，且精確至毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [Locked](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-Locked"></a>
布林值，指出 AWS Backup 保存庫鎖定目前是否正在保護備份保存庫。 `True`表示保存庫鎖定會導致保存庫中存放之復原點的刪除或更新操作失敗。  
類型：布林值

 ** [MaxRetentionDays](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-MaxRetentionDays"></a>
保存 AWS Backup 庫鎖定設定，指定保存庫保留其復原點的最長保留期間。若未指定此參數，Vault Lock 不會對保存庫中的復原點強制執行最長保留期間 (允許無限期儲存)。  
若經過指定，則保存庫的所有備份或複製任務皆必須具有生命週期政策，其保留期間等於或短於最長保留期間。若任務的保留期間超過該最長保留期間，則文件庫的備份或複製任務會失敗，您應修改生命週期設定或使用不同的文件庫。在執行Vault Lock 之前已儲存於保存庫的復原點不會受到影響。  
類型：Long

 ** [MinRetentionDays](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-MinRetentionDays"></a>
保存 AWS Backup 庫鎖定設定，指定保存庫保留其復原點的最短保留期間。若未指定此參數，Vault Lock 將不會強制執行最短保留期間。  
若經過指定，則保存庫的所有備份或複製任務皆必須具有生命週期政策，其保留期間等於或超過最短保留期間。若任務的保留期間未達最短保留期間，則保存庫的備份或複製任務會失敗，您應修改生命週期設定或使用不同的保存庫。在執行Vault Lock 之前已儲存於保存庫的復原點不會受到影響。  
類型：Long

 ** [MpaApprovalTeamArn](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-MpaApprovalTeamArn"></a>
與此備份保存庫相關聯的 MPA 核准團隊的 ARN。  
類型：字串

 ** [MpaSessionArn](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-MpaSessionArn"></a>
與此備份保存庫相關聯的 MPA 工作階段 ARN。  
類型：字串

 ** [NumberOfRecoveryPoints](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-NumberOfRecoveryPoints"></a>
儲存在備份保存庫中的復原點數目。  
主控台顯示的復原點計數值可能是近似值。使用 [https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListRecoveryPointsByBackupVault.html](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListRecoveryPointsByBackupVault.html) API 取得確切計數。  
類型：Long

 ** [SourceBackupVaultArn](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-SourceBackupVaultArn"></a>
建立此還原存取備份文件庫的來源備份文件庫 ARN。  
類型：字串

 ** [VaultState](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-VaultState"></a>
保存庫的目前狀態。->  
類型：字串  
有效值:`CREATING | AVAILABLE | FAILED` 

 ** [VaultType](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-VaultType"></a>
所述的保存庫類型。  
類型：字串  
有效值:`BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT | RESTORE_ACCESS_BACKUP_VAULT` 

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# DescribeCopyJob
<a name="API_DescribeCopyJob"></a>

傳回與建立資源複本相關聯的中繼資料。

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

```
GET /copy-jobs/copyJobId HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [copyJobId](#API_DescribeCopyJob_RequestSyntax) **   <a name="Backup-DescribeCopyJob-request-uri-CopyJobId"></a>
可唯一識別複製作業。  
必要：是

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

請求沒有請求主體。

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

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

{
   "CopyJob": { 
      "AccountId": "string",
      "BackupSizeInBytes": number,
      "ChildJobsInState": { 
         "string" : number 
      },
      "CompletionDate": number,
      "CompositeMemberIdentifier": "string",
      "CopyJobId": "string",
      "CreatedBy": { 
         "BackupPlanArn": "string",
         "BackupPlanId": "string",
         "BackupPlanName": "string",
         "BackupPlanVersion": "string",
         "BackupRuleCron": "string",
         "BackupRuleId": "string",
         "BackupRuleName": "string",
         "BackupRuleTimezone": "string"
      },
      "CreatedByBackupJobId": "string",
      "CreationDate": number,
      "DestinationBackupVaultArn": "string",
      "DestinationEncryptionKeyArn": "string",
      "DestinationRecoveryPointArn": "string",
      "DestinationRecoveryPointLifecycle": { 
         "DeleteAfterDays": number,
         "DeleteAfterEvent": "string",
         "MoveToColdStorageAfterDays": number,
         "OptInToArchiveForSupportedResources": boolean
      },
      "DestinationVaultLockState": "string",
      "DestinationVaultType": "string",
      "IamRoleArn": "string",
      "IsParent": boolean,
      "MessageCategory": "string",
      "NumberOfChildJobs": number,
      "ParentJobId": "string",
      "ResourceArn": "string",
      "ResourceName": "string",
      "ResourceType": "string",
      "SourceBackupVaultArn": "string",
      "SourceRecoveryPointArn": "string",
      "State": "string",
      "StatusMessage": "string"
   }
}
```

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

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

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

 ** [CopyJob](#API_DescribeCopyJob_ResponseSyntax) **   <a name="Backup-DescribeCopyJob-response-CopyJob"></a>
包含複製作業的相關詳細資訊。  
類型：[CopyJob](API_CopyJob.md) 物件

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# DescribeFramework
<a name="API_DescribeFramework"></a>

傳回指定 `FrameworkName` 的架構詳細資訊。

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

```
GET /audit/frameworks/frameworkName HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [frameworkName](#API_DescribeFramework_RequestSyntax) **   <a name="Backup-DescribeFramework-request-uri-FrameworkName"></a>
架構的唯一名稱。  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z][_a-zA-Z0-9]*`  
必要：是

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

請求沒有請求主體。

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

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

{
   "CreationTime": number,
   "DeploymentStatus": "string",
   "FrameworkArn": "string",
   "FrameworkControls": [ 
      { 
         "ControlInputParameters": [ 
            { 
               "ParameterName": "string",
               "ParameterValue": "string"
            }
         ],
         "ControlName": "string",
         "ControlScope": { 
            "ComplianceResourceIds": [ "string" ],
            "ComplianceResourceTypes": [ "string" ],
            "Tags": { 
               "string" : "string" 
            }
         }
      }
   ],
   "FrameworkDescription": "string",
   "FrameworkName": "string",
   "FrameworkStatus": "string",
   "IdempotencyToken": "string"
}
```

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

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

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

 ** [CreationTime](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-CreationTime"></a>
架構建立時的日期和時間，採用 ISO 8601 表示法。`CreationTime` 的值精確到毫秒。舉例來說，2020-07-10T15:00:00.000-08:00 代表 2020 年 7 月 10 日下午 3 點，比國際標準時間晚 8 小時。  
類型：Timestamp

 ** [DeploymentStatus](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-DeploymentStatus"></a>
架構的部署狀態。狀態如下：  
 `CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED`   
類型：字串

 ** [FrameworkArn](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkArn"></a>
可唯一識別資源的 Amazon Resource Name (ARN)。ARN 的格式取決於資源類型。  
類型：字串

 ** [FrameworkControls](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkControls"></a>
構成架構的控制項。清單中的每個控制項都具有名稱、輸入參數和範圍。  
類型：[FrameworkControl](API_FrameworkControl.md) 物件陣列

 ** [FrameworkDescription](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkDescription"></a>
架構的選擇性說明。  
類型：字串  
長度限制：長度下限為 0。長度上限為 1024。  
模式：`.*\S.*`

 ** [FrameworkName](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkName"></a>
架構的唯一名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z][_a-zA-Z0-9]*`

 ** [FrameworkStatus](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkStatus"></a>
架構包含一或多個控制項。每個控制項皆控管一項資源，例如備份計畫、備份選擇、備份保存庫或復原點。您也可以開啟或關閉每個資源的 AWS Config 記錄功能。狀態如下：  
+  當架構控管的所有資源皆開啟記錄時為 `ACTIVE`。
+  當架構控管的資源中至少一項關閉記錄時為 `PARTIALLY_ACTIVE`。
+  當架構控管的所有資源皆關閉記錄時為 `INACTIVE`。
+  `UNAVAILABLE` 當 目前無法 AWS Backup 驗證錄製狀態。
類型：字串

 ** [IdempotencyToken](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-IdempotencyToken"></a>
客戶所選擇的字串，可用來區分在其他方面相同的 `DescribeFrameworkOutput` 呼叫。重試具有相同等冪性字符的成功請求會導致出現成功消息，但未執行任何動作。  
類型：字串

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# DescribeGlobalSettings
<a name="API_DescribeGlobalSettings"></a>

描述 AWS 帳戶是否已啟用不同的跨帳戶管理選項，包括跨帳戶備份、多方核准和委派管理員。如果帳戶不是 Organizations 組織的成員，則會傳回錯誤。範例：`describe-global-settings --region us-west-2`

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

```
GET /global-settings HTTP/1.1
```

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

請求不會使用任何 URI 參數。

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

請求沒有請求主體。

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

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

{
   "GlobalSettings": { 
      "string" : "string" 
   },
   "LastUpdateTime": number
}
```

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

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

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

 ** [GlobalSettings](#API_DescribeGlobalSettings_ResponseSyntax) **   <a name="Backup-DescribeGlobalSettings-response-GlobalSettings"></a>
旗標 `isCrossAccountBackupEnabled`、 `isMpaEnabled`('Mpa' 是指多方核准） 和 的狀態`isDelegatedAdministratorEnabled`。  
+  `isCrossAccountBackupEnabled`：允許組織中的帳戶將備份複製到其他帳戶。
+  `isMpaEnabled`：使用將多方核准團隊指派給邏輯氣隙隔離保存庫的選項，為您的組織新增跨帳戶存取權。
+  `isDelegatedAdministratorEnabled`：允許 Backup 自動同步委派管理員許可與 Organizations。
類型：字串到字串映射

 ** [LastUpdateTime](#API_DescribeGlobalSettings_ResponseSyntax) **   <a name="Backup-DescribeGlobalSettings-response-LastUpdateTime"></a>
上次更新支援旗標的日期和時間。此更新以 Unix 格式和國際標準時間 (UTC) 顯示。`LastUpdateTime` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# DescribeProtectedResource
<a name="API_DescribeProtectedResource"></a>

傳回已儲存資源的相關資訊，包括其上次備份的時間、其 Amazon Resource Name (ARN)，以及已儲存資源 AWS 的服務類型。

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

```
GET /resources/resourceArn HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [resourceArn](#API_DescribeProtectedResource_RequestSyntax) **   <a name="Backup-DescribeProtectedResource-request-uri-ResourceArn"></a>
可唯一識別資源的 Amazon Resource Name (ARN)。ARN 的格式取決於資源類型。  
必要：是

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

請求沒有請求主體。

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

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

{
   "LastBackupTime": number,
   "LastBackupVaultArn": "string",
   "LastRecoveryPointArn": "string",
   "LatestRestoreExecutionTimeMinutes": number,
   "LatestRestoreJobCreationDate": number,
   "LatestRestoreRecoveryPointCreationDate": number,
   "ResourceArn": "string",
   "ResourceName": "string",
   "ResourceType": "string"
}
```

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

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

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

 ** [LastBackupTime](#API_DescribeProtectedResource_ResponseSyntax) **   <a name="Backup-DescribeProtectedResource-response-LastBackupTime"></a>
上次備份資源時的日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。`LastBackupTime` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [LastBackupVaultArn](#API_DescribeProtectedResource_ResponseSyntax) **   <a name="Backup-DescribeProtectedResource-response-LastBackupVaultArn"></a>
包含最新備份復原點的備份保存庫 ARN (Amazon Resource Name)。  
類型：字串

 ** [LastRecoveryPointArn](#API_DescribeProtectedResource_ResponseSyntax) **   <a name="Backup-DescribeProtectedResource-response-LastRecoveryPointArn"></a>
最近復原點的 ARN (Amazon Resource Name)。  
類型：字串

 ** [LatestRestoreExecutionTimeMinutes](#API_DescribeProtectedResource_ResponseSyntax) **   <a name="Backup-DescribeProtectedResource-response-LatestRestoreExecutionTimeMinutes"></a>
最近完成還原任務所花費的時間，以分鐘為單位。  
類型：Long

 ** [LatestRestoreJobCreationDate](#API_DescribeProtectedResource_ResponseSyntax) **   <a name="Backup-DescribeProtectedResource-response-LatestRestoreJobCreationDate"></a>
最近還原任務的建立日期。  
類型：Timestamp

 ** [LatestRestoreRecoveryPointCreationDate](#API_DescribeProtectedResource_ResponseSyntax) **   <a name="Backup-DescribeProtectedResource-response-LatestRestoreRecoveryPointCreationDate"></a>
建立最近復原點的日期。  
類型：Timestamp

 ** [ResourceArn](#API_DescribeProtectedResource_ResponseSyntax) **   <a name="Backup-DescribeProtectedResource-response-ResourceArn"></a>
可唯一識別資源的 ARN。ARN 的格式取決於資源類型。  
類型：字串

 ** [ResourceName](#API_DescribeProtectedResource_ResponseSyntax) **   <a name="Backup-DescribeProtectedResource-response-ResourceName"></a>
屬於指定備份的資源名稱。  
類型：字串

 ** [ResourceType](#API_DescribeProtectedResource_ResponseSyntax) **   <a name="Backup-DescribeProtectedResource-response-ResourceType"></a>
儲存為復原點 AWS 的資源類型；例如 Amazon EBS 磁碟區或 Amazon RDS 資料庫。  
類型：字串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# DescribeRecoveryPoint
<a name="API_DescribeRecoveryPoint"></a>

傳回與復原點相關聯的中繼資料，包括 ID、狀態、加密和生命週期。

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

```
GET /backup-vaults/backupVaultName/recovery-points/recoveryPointArn?backupVaultAccountId=BackupVaultAccountId HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [BackupVaultAccountId](#API_DescribeRecoveryPoint_RequestSyntax) **   <a name="Backup-DescribeRecoveryPoint-request-uri-BackupVaultAccountId"></a>
指定備份保存庫的帳戶 ID。  
模式：`^[0-9]{12}$`

 ** [backupVaultName](#API_DescribeRecoveryPoint_RequestSyntax) **   <a name="Backup-DescribeRecoveryPoint-request-uri-BackupVaultName"></a>
存放備份的邏輯容器名稱。備份文件庫依名稱識別，這些名稱對建立文件庫的帳戶和 AWS 區域來說是唯一的。  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必要：是

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

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

請求沒有請求主體。

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

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

{
   "BackupSizeInBytes": number,
   "BackupVaultArn": "string",
   "BackupVaultName": "string",
   "CalculatedLifecycle": { 
      "DeleteAt": number,
      "MoveToColdStorageAt": number
   },
   "CompletionDate": number,
   "CompositeMemberIdentifier": "string",
   "CreatedBy": { 
      "BackupPlanArn": "string",
      "BackupPlanId": "string",
      "BackupPlanName": "string",
      "BackupPlanVersion": "string",
      "BackupRuleCron": "string",
      "BackupRuleId": "string",
      "BackupRuleName": "string",
      "BackupRuleTimezone": "string"
   },
   "CreationDate": number,
   "EncryptionKeyArn": "string",
   "EncryptionKeyType": "string",
   "IamRoleArn": "string",
   "IndexStatus": "string",
   "IndexStatusMessage": "string",
   "InitiationDate": number,
   "IsEncrypted": boolean,
   "IsParent": boolean,
   "LastRestoreTime": number,
   "Lifecycle": { 
      "DeleteAfterDays": number,
      "DeleteAfterEvent": "string",
      "MoveToColdStorageAfterDays": number,
      "OptInToArchiveForSupportedResources": boolean
   },
   "ParentRecoveryPointArn": "string",
   "RecoveryPointArn": "string",
   "ResourceArn": "string",
   "ResourceName": "string",
   "ResourceType": "string",
   "ScanResults": [ 
      { 
         "Findings": [ "string" ],
         "LastScanTimestamp": number,
         "MalwareScanner": "string",
         "ScanJobState": "string"
      }
   ],
   "SourceBackupVaultArn": "string",
   "Status": "string",
   "StatusMessage": "string",
   "StorageClass": "string",
   "VaultType": "string"
}
```

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

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

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

 ** [BackupSizeInBytes](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-BackupSizeInBytes"></a>
備份的大小，以位元組為單位。  
類型：Long

 ** [BackupVaultArn](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-BackupVaultArn"></a>
可唯一識別備份文件庫的 ARN，例如 `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`。  
類型：字串

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

 ** [CalculatedLifecycle](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-CalculatedLifecycle"></a>
包含 `DeleteAt` 和 `MoveToColdStorageAt` 時間戳記的 `CalculatedLifecycle` 物件。  
類型：[CalculatedLifecycle](API_CalculatedLifecycle.md) 物件

 ** [CompletionDate](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-CompletionDate"></a>
建立復原點任務的完成日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。`CompletionDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [CompositeMemberIdentifier](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-CompositeMemberIdentifier"></a>
複合群組中資源的識別符，例如屬於複合 （父） 堆疊的巢狀 （子） 復原點。ID 會從堆疊中的[邏輯 ID](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax) 傳輸。  
類型：字串

 ** [CreatedBy](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-CreatedBy"></a>
含有建立復原點的相關識別資訊，包括用於建立復原點之備份計畫的 `BackupPlanArn`、`BackupPlanId`、`BackupPlanVersion` 和 `BackupRuleId`。  
類型：[RecoveryPointCreator](API_RecoveryPointCreator.md) 物件

 ** [CreationDate](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-CreationDate"></a>
建立復原點的日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。`CreationDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [EncryptionKeyArn](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-EncryptionKeyArn"></a>
用來保護備份的伺服器端加密金鑰，例如 `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`。  
類型：字串

 ** [EncryptionKeyType](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-EncryptionKeyType"></a>
用於復原點的加密金鑰類型。有效值為客戶受管金鑰的 CUSTOMER\$1MANAGED\$1KMS\$1KEY 或 AWS擁有金鑰的 AWS\$1OWNED\$1KMS\$1KEY。  
類型：字串  
有效值:`AWS_OWNED_KMS_KEY | CUSTOMER_MANAGED_KMS_KEY` 

 ** [IamRoleArn](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-IamRoleArn"></a>
指定用來建立目標復原點的 IAM 角色 ARN；例如 `arn:aws:iam::123456789012:role/S3Access`。  
類型：字串

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

 ** [IndexStatusMessage](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-IndexStatusMessage"></a>
詳細的訊息形式的字串，說明與復原點相關聯的備份索引狀態。  
類型：字串

 ** [InitiationDate](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-InitiationDate"></a>
建立此復原點的備份任務啟動的日期和時間，採用 Unix 格式和國際標準時間 (UTC)。  
類型：Timestamp

 ** [IsEncrypted](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-IsEncrypted"></a>
傳回的布林值，若指定的復原點已加密，則為 `TRUE`，若復原點未加密，則為 `FALSE`。  
類型：布林值

 ** [IsParent](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-IsParent"></a>
這會傳回復原點為父項 (複合) 任務的布林值。  
類型：布林值

 ** [LastRestoreTime](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-LastRestoreTime"></a>
最後還原復原點的日期和時間，以 Unix 格式和國際標準時間 (UTC) 格式顯示。`LastRestoreTime` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [Lifecycle](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-Lifecycle"></a>
生命週期會定義受保護資源何時轉換為冷儲存，以及何時過期。 會根據您定義的生命週期自動 AWS Backup 轉換和過期備份。  
轉移至冷儲存的備份必須在冷儲存中存放至少 90 天。因此，「保留期」設定必須比「轉移至冷儲存前所需天數」設定長 90 天。備份已轉換至冷儲存後，就無法變更「經過此天數後轉換為冷儲存」設定。  
可轉換為冷儲存的資源類型會列在[資源資料表的功能可用性](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource)中。 會 AWS Backup 忽略其他資源類型的此表達式。  
類型：[Lifecycle](API_Lifecycle.md) 物件

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

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

 ** [ResourceArn](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-ResourceArn"></a>
可唯一識別已儲存資源的 ARN。ARN 的格式取決於資源類型。  
類型：字串

 ** [ResourceName](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-ResourceName"></a>
屬於指定備份的資源名稱。  
類型：字串

 ** [ResourceType](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-ResourceType"></a>
儲存為復原點 AWS 的資源類型；例如，Amazon Elastic Block Store (Amazon EBS) 磁碟區或 Amazon Relational Database Service (Amazon RDS) 資料庫。  
類型：字串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`

 ** [ScanResults](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-ScanResults"></a>
包含針對復原點的最新掃描結果，目前包括 `MalwareScanner`、`Findings`、 `ScanJobState`和 `LastScanTimestamp`   
類型：[ScanResult](API_ScanResult.md) 物件陣列  
陣列成員：項目數下限為 0。項目數上限為 5。

 ** [SourceBackupVaultArn](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-SourceBackupVaultArn"></a>
可唯一識別原始備份資源之來源保存庫的 Amazon Resource Name (ARN)，例如 `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`。如果復原還原至相同的 AWS 帳戶或區域，則此值將為 `null`。  
類型：字串

 ** [Status](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-Status"></a>
指定復原點狀態的狀態碼。如需詳細資訊，請參閱《 * AWS Backup 開發人員指南*》中的[復原點狀態](https://docs.aws.amazon.com/aws-backup/latest/devguide/applicationstackbackups.html#cfnrecoverypointstatus)。  
+  `CREATING` 狀態表示已為資源啟動 AWS Backup 任務。備份程序已啟動，並正在積極處理相關聯復原點的備份任務。
+  `AVAILABLE` 狀態表示已成功為復原點建立備份。備份程序已完成，沒有任何問題，且復原點現在已準備好可供使用。
+  `PARTIAL` 狀態表示複合復原點具有一或多個不在備份中的巢狀復原點。
+  `EXPIRED` 狀態表示復原點已超過其保留期間，但 AWS Backup 缺少許可或無法刪除它。若要手動刪除這些復原點，請參閱《入門》**的《清理資源》**一節中的《[步驟 3：刪除復原點](https://docs.aws.amazon.com/aws-backup/latest/devguide/gs-cleanup-resources.html#cleanup-backups)》。
+  `STOPPED` 狀態會出現在連續備份，其中使用者已採取某些動作，導致連續備份停用。這可能是因為移除許可、關閉版本控制、關閉傳送至 EventBridge 的事件，或停用 AWS Backup設定的 EventBridge 規則所造成。對於 Amazon S3、Amazon RDS 和 Amazon Aurora 資源的復原點，此狀態會在連續備份規則的保留期間變更時發生。

  若要解決 `STOPPED` 狀態，請確定已具備所有必要許可，並且已在 S3 儲存貯體上啟用版本控制。一旦符合這些條件，下次執行備份規則就會建立新的連續復原點。不需要刪除狀態為「已停止」的復原點。

  至於 Amazon EC2 上的 SAP HANA，`STOPPED`會因為使用者動作、應用程式設定錯誤或備份失敗而發生。為確保未來的連續備份成功，請查看復原點狀態並檢查 SAP HANA 以取得詳細資訊。
類型：字串  
有效值:`COMPLETED | PARTIAL | DELETING | EXPIRED | AVAILABLE | STOPPED | CREATING` 

 ** [StatusMessage](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-StatusMessage"></a>
說明還原復原點狀態的狀態訊息。  
類型：字串

 ** [StorageClass](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-StorageClass"></a>
指定復原點的儲存體方案。有效值為 `WARM` 或 `COLD`。  
類型：字串  
有效值:`WARM | COLD | DELETED` 

 ** [VaultType](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-VaultType"></a>
存放所述復原點的保存庫類型。  
類型：字串  
有效值:`BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT | RESTORE_ACCESS_BACKUP_VAULT` 

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# DescribeRegionSettings
<a name="API_DescribeRegionSettings"></a>

傳回「區域」的目前服務選擇加入設定。如果服務已啟用服務選擇加入，當資源包含在隨需備份或排程備份計劃中時， 會 AWS Backup 嘗試保護該服務在此區域中的資源。否則， AWS Backup 不會嘗試保護此「區域」中該服務的資源。

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

```
GET /account-settings HTTP/1.1
```

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

請求不會使用任何 URI 參數。

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

請求沒有請求主體。

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

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

{
   "ResourceTypeManagementPreference": { 
      "string" : boolean 
   },
   "ResourceTypeOptInPreference": { 
      "string" : boolean 
   }
}
```

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

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

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

 ** [ResourceTypeManagementPreference](#API_DescribeRegionSettings_ResponseSyntax) **   <a name="Backup-DescribeRegionSettings-response-ResourceTypeManagementPreference"></a>
傳回 是否 AWS Backup 完全管理資源類型的備份。  
如需完整 AWS Backup 管理的優點，請參閱[完整 AWS Backup 管理](https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#full-management)。  
如需資源類型清單，以及每個類型是否支援完整 AWS Backup 管理，請參閱[依資源區分的功能可用性](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource)資料表。  
如果為 `"DynamoDB":false`，您可以透過啟用 的進階 DynamoDB 備份功能來啟用 DynamoDB 備份的完整 AWS Backup 管理。 [AWS Backup DynamoDB ](https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html#advanced-ddb-backup-enable-cli)  
類型：字串到布林值映射  
金鑰模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`

 ** [ResourceTypeOptInPreference](#API_DescribeRegionSettings_ResponseSyntax) **   <a name="Backup-DescribeRegionSettings-response-ResourceTypeOptInPreference"></a>
服務以及 區域中的選擇加入偏好設定。  
類型：字串到布林值映射  
金鑰模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`

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

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

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

HTTP 狀態碼：500

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

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

# DescribeReportJob
<a name="API_DescribeReportJob"></a>

傳回與建立報表 (由其 `ReportJobId` 指定) 相關聯的詳細資訊。

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

```
GET /audit/report-jobs/reportJobId HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [reportJobId](#API_DescribeReportJob_RequestSyntax) **   <a name="Backup-DescribeReportJob-request-uri-ReportJobId"></a>
報告任務的識別碼。唯一隨機產生的 Unicode、UTF-8 編碼字串，最長 1,024 個位元組。無法編輯報告任務 ID。  
必要：是

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

請求沒有請求主體。

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

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

{
   "ReportJob": { 
      "CompletionTime": number,
      "CreationTime": number,
      "ReportDestination": { 
         "S3BucketName": "string",
         "S3Keys": [ "string" ]
      },
      "ReportJobId": "string",
      "ReportPlanArn": "string",
      "ReportTemplate": "string",
      "Status": "string",
      "StatusMessage": "string"
   }
}
```

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

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

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

 ** [ReportJob](#API_DescribeReportJob_ResponseSyntax) **   <a name="Backup-DescribeReportJob-response-ReportJob"></a>
報告任務的相關資訊，包括其完成和建立時間、報告目的地、唯一報告任務 ID、Amazon Resource Name (ARN)、報告範本、狀態和狀態訊息。  
類型：[ReportJob](API_ReportJob.md) 物件

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# DescribeReportPlan
<a name="API_DescribeReportPlan"></a>

傳回 AWS 帳戶 和 的所有報告計劃清單 AWS 區域。

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

```
GET /audit/report-plans/reportPlanName HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [reportPlanName](#API_DescribeReportPlan_RequestSyntax) **   <a name="Backup-DescribeReportPlan-request-uri-ReportPlanName"></a>
報告計畫的唯一名稱。  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z][_a-zA-Z0-9]*`  
必要：是

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

請求沒有請求主體。

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

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

{
   "ReportPlan": { 
      "CreationTime": number,
      "DeploymentStatus": "string",
      "LastAttemptedExecutionTime": number,
      "LastSuccessfulExecutionTime": number,
      "ReportDeliveryChannel": { 
         "Formats": [ "string" ],
         "S3BucketName": "string",
         "S3KeyPrefix": "string"
      },
      "ReportPlanArn": "string",
      "ReportPlanDescription": "string",
      "ReportPlanName": "string",
      "ReportSetting": { 
         "Accounts": [ "string" ],
         "FrameworkArns": [ "string" ],
         "NumberOfFrameworks": number,
         "OrganizationUnits": [ "string" ],
         "Regions": [ "string" ],
         "ReportTemplate": "string"
      }
   }
}
```

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

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

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

 ** [ReportPlan](#API_DescribeReportPlan_ResponseSyntax) **   <a name="Backup-DescribeReportPlan-response-ReportPlan"></a>
傳回由名稱所指定報表計畫的詳細資訊。這些詳細資訊包括報告計畫的 Amazon Resource Name (ARN)、描述、設定、交付管道、部署狀態、建立時間，以及上一次嘗試並成功執行的時間。  
類型：[ReportPlan](API_ReportPlan.md) 物件

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# DescribeRestoreJob
<a name="API_DescribeRestoreJob"></a>

傳回與任務 ID 所指定還原任務相關聯的中繼資料。

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

```
GET /restore-jobs/restoreJobId HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [restoreJobId](#API_DescribeRestoreJob_RequestSyntax) **   <a name="Backup-DescribeRestoreJob-request-uri-RestoreJobId"></a>
可唯一識別還原復原點的任務。  
必要：是

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

請求沒有請求主體。

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

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

{
   "AccountId": "string",
   "BackupSizeInBytes": number,
   "BackupVaultArn": "string",
   "CompletionDate": number,
   "CreatedBy": { 
      "RestoreTestingPlanArn": "string"
   },
   "CreatedResourceArn": "string",
   "CreationDate": number,
   "DeletionStatus": "string",
   "DeletionStatusMessage": "string",
   "ExpectedCompletionTimeMinutes": number,
   "IamRoleArn": "string",
   "IsParent": boolean,
   "ParentJobId": "string",
   "PercentDone": "string",
   "RecoveryPointArn": "string",
   "RecoveryPointCreationDate": number,
   "ResourceType": "string",
   "RestoreJobId": "string",
   "SourceResourceArn": "string",
   "Status": "string",
   "StatusMessage": "string",
   "ValidationStatus": "string",
   "ValidationStatusMessage": "string"
}
```

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

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

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

 ** [AccountId](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-AccountId"></a>
傳回擁有還原任務的帳戶 ID。  
類型：字串  
模式：`^[0-9]{12}$`

 ** [BackupSizeInBytes](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-BackupSizeInBytes"></a>
所還原資源的大小，以位元組為單位。  
類型：Long

 ** [BackupVaultArn](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-BackupVaultArn"></a>
備份文件庫的 Amazon Resource Name (ARN)，其中包含要還原的復原點。這有助於識別保存庫存取政策和許可。  
類型：字串

 ** [CompletionDate](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-CompletionDate"></a>
還原復原點任務的完成日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。`CompletionDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [CreatedBy](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-CreatedBy"></a>
包含有關建立還原任務的識別資訊。  
類型：[RestoreJobCreator](API_RestoreJobCreator.md) 物件

 ** [CreatedResourceArn](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-CreatedResourceArn"></a>
還原任務所建立資源的 Amazon Resource Name (ARN)。  
ARN 的格式取決於備份資源的資源類型。  
類型：字串

 ** [CreationDate](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-CreationDate"></a>
建立還原任務時的日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。`CreationDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [DeletionStatus](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-DeletionStatus"></a>
還原測試產生的資料狀態。  
類型：字串  
有效值:`DELETING | FAILED | SUCCESSFUL` 

 ** [DeletionStatusMessage](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-DeletionStatusMessage"></a>
此會說明還原任務刪除狀態。  
類型：字串

 ** [ExpectedCompletionTimeMinutes](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-ExpectedCompletionTimeMinutes"></a>
還原復原點之任務預計所需的時間 (分鐘)。  
類型：Long

 ** [IamRoleArn](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-IamRoleArn"></a>
指定用來建立目標復原點的 IAM 角色 ARN；例如 `arn:aws:iam::123456789012:role/S3Access`。  
類型：字串

 ** [IsParent](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-IsParent"></a>
這是布林值，指出還原任務是否為父系 （複合） 還原任務。  
類型：布林值

 ** [ParentJobId](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-ParentJobId"></a>
這是所選還原任務之父系還原任務的唯一識別符。  
類型：字串

 ** [PercentDone](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-PercentDone"></a>
包含查詢任務狀態時，任務的預估完成百分比。  
類型：字串

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

 ** [RecoveryPointCreationDate](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-RecoveryPointCreationDate"></a>
指定還原任務建立復原點的日期。  
類型：Timestamp

 ** [ResourceType](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-ResourceType"></a>
傳回與依資源類型列出之還原任務相關聯的中繼資料。  
類型：字串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`

 ** [RestoreJobId](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-RestoreJobId"></a>
可唯一識別還原復原點的任務。  
類型：字串

 ** [SourceResourceArn](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-SourceResourceArn"></a>
備份之原始資源的 Amazon Resource Name (ARN)。這會提供有關正在還原之資源的內容。  
類型：字串

 ** [Status](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-Status"></a>
指定由 啟動 AWS Backup 以還原復原點之任務狀態的狀態碼。  
類型：字串  
有效值:`PENDING | RUNNING | COMPLETED | ABORTED | FAILED` 

 ** [StatusMessage](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-StatusMessage"></a>
顯示還原復原點任務狀態的訊息。  
類型：字串

 ** [ValidationStatus](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-ValidationStatus"></a>
指定還原任務上執行的驗證狀態。  
類型：字串  
有效值:`FAILED | SUCCESSFUL | TIMED_OUT | VALIDATING` 

 ** [ValidationStatusMessage](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-ValidationStatusMessage"></a>
狀態訊息。  
類型：字串

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

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

 ** DependencyFailureException **   
相依 AWS 服務或資源傳回錯誤給 AWS Backup 服務，且無法完成動作。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# DescribeScanJob
<a name="API_DescribeScanJob"></a>

傳回指定 ScanJobID 的掃描任務詳細資訊。

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

```
GET /scan/jobs/ScanJobId HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [ScanJobId](#API_DescribeScanJob_RequestSyntax) **   <a name="Backup-DescribeScanJob-request-uri-ScanJobId"></a>
唯一識別 AWS Backup 對 掃描資源的請求。  
必要：是

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

請求沒有請求主體。

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

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

{
   "AccountId": "string",
   "BackupVaultArn": "string",
   "BackupVaultName": "string",
   "CompletionDate": number,
   "CreatedBy": { 
      "BackupPlanArn": "string",
      "BackupPlanId": "string",
      "BackupPlanVersion": "string",
      "BackupRuleId": "string"
   },
   "CreationDate": number,
   "IamRoleArn": "string",
   "MalwareScanner": "string",
   "RecoveryPointArn": "string",
   "ResourceArn": "string",
   "ResourceName": "string",
   "ResourceType": "string",
   "ScanBaseRecoveryPointArn": "string",
   "ScanId": "string",
   "ScanJobId": "string",
   "ScanMode": "string",
   "ScannerRoleArn": "string",
   "ScanResult": { 
      "ScanResultStatus": "string"
   },
   "State": "string",
   "StatusMessage": "string"
}
```

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

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

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

 ** [AccountId](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-AccountId"></a>
傳回擁有掃描任務的帳戶 ID。  
模式：`^[0-9]{12}$`  
類型：字串

 ** [BackupVaultArn](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-BackupVaultArn"></a>
可唯一識別備份保存庫的 Amazon Resource Name (ARN)；例如， `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`  
類型：字串

 ** [BackupVaultName](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-BackupVaultName"></a>
存放備份的邏輯容器名稱。備份保存庫是由用於建立它們的帳戶及其建立 AWS 區域的唯一名稱所識別。  
模式：`^[a-zA-Z0-9\-\_\.]{2,50}$`  
類型：字串

 ** [CompletionDate](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-CompletionDate"></a>
備份索引完成建立的日期和時間，採用 Unix 格式和國際標準時間 (UTC)。`CompletionDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [CreatedBy](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-CreatedBy"></a>
包含有關建立掃描任務的識別資訊，包括啟動掃描的備份計畫和規則。  
類型：[ScanJobCreator](API_ScanJobCreator.md) 物件

 ** [CreationDate](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-CreationDate"></a>
備份索引完成建立的日期和時間，採用 Unix 格式和國際標準時間 (UTC)。`CreationDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [IamRoleArn](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-IamRoleArn"></a>
可唯一識別備份文件庫的 Amazon Resource Name (ARN)，例如 `arn:aws:iam::123456789012:role/S3Access`。  
類型：字串

 ** [MalwareScanner](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-MalwareScanner"></a>
用於對應掃描任務的掃描引擎。目前僅支援 `GUARDUTY`。  
類型：字串  
有效值:`GUARDDUTY` 

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

 ** [ResourceArn](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ResourceArn"></a>
唯一識別對應復原點 ARN 來源資源的 ARN。  
類型：字串

 ** [ResourceName](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ResourceName"></a>
屬於指定備份之資源的非唯一名稱。  
類型：字串

 ** [ResourceType](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ResourceType"></a>
要備份 AWS 的資源類型；例如，Amazon Elastic Block Store (Amazon EBS) 磁碟區。  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
類型：字串  
有效值:`EBS | EC2 | S3` 

 ** [ScanBaseRecoveryPointArn](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ScanBaseRecoveryPointArn"></a>
唯一識別基本復原點以進行掃描的 ARN。只有在進行增量掃描任務時，才會填入此欄位。  
類型：字串

 ** [ScanId](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ScanId"></a>
Amazon GuardDuty 為對應的掃描任務 ID 請求產生的掃描 ID AWS Backup。  
類型：字串

 ** [ScanJobId](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ScanJobId"></a>
唯一識別請求的掃描任務 ID AWS Backup。  
類型：字串

 ** [ScanMode](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ScanMode"></a>
指定用於掃描任務的掃描類型。  
類型：字串  
有效值:`FULL_SCAN | INCREMENTAL_SCAN` 

 ** [ScannerRoleArn](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ScannerRoleArn"></a>
指定掃描任務用於 的掃描器 IAM 角色 ARN。  
類型：字串

 ** [ScanResult](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ScanResult"></a>
 包含掃描任務`ScanResultsStatus`的 ，以及傳回已完成任務`NO_THREATS_FOUND`的 `THREATS_FOUND`或 。  
類型：[ScanResultInfo](API_ScanResultInfo.md) 物件

 ** [State](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-State"></a>
掃描任務的目前狀態。  
類型：字串  
有效值:`CANCELED | COMPLETED | COMPLETED_WITH_ISSUES | CREATED | FAILED | RUNNING` 

 ** [StatusMessage](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-StatusMessage"></a>
說明備份資源任務狀態的詳細訊息。  
類型：字串

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# DisassociateBackupVaultMpaApprovalTeam
<a name="API_DisassociateBackupVaultMpaApprovalTeam"></a>

移除 MPA 核准團隊與備份保存庫之間的關聯，停用還原操作的 MPA 核准工作流程。

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

```
POST /backup-vaults/backupVaultName/mpaApprovalTeam?delete HTTP/1.1
Content-type: application/json

{
   "RequesterComment": "string"
}
```

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

請求會使用下列 URI 參數。

 ** [backupVaultName](#API_DisassociateBackupVaultMpaApprovalTeam_RequestSyntax) **   <a name="Backup-DisassociateBackupVaultMpaApprovalTeam-request-uri-BackupVaultName"></a>
要與 MPA 核准團隊取消關聯的備份保存庫名稱。  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必要：是

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

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

 ** [RequesterComment](#API_DisassociateBackupVaultMpaApprovalTeam_RequestSyntax) **   <a name="Backup-DisassociateBackupVaultMpaApprovalTeam-request-RequesterComment"></a>
選用註解，說明取消 MPA 核准團隊與備份保存庫的關聯的原因。  
類型：字串  
必要：否

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

```
HTTP/1.1 204
```

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

如果動作成功，則服務會送回具有空 HTTP 主體的 HTTP 204 回應。

## 錯誤
<a name="API_DisassociateBackupVaultMpaApprovalTeam_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_DisassociateBackupVaultMpaApprovalTeam_SeeAlso"></a>

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

# DisassociateRecoveryPoint
<a name="API_DisassociateRecoveryPoint"></a>

從 刪除指定的連續備份復原點， AWS Backup 並將該連續備份的控制釋放至來源服務，例如 Amazon RDS。來源服務將繼續使用您在原始備份計畫中指定的生命週期，以建立和保留連續備份。

不支援快照備份復原點。

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

```
POST /backup-vaults/backupVaultName/recovery-points/recoveryPointArn/disassociate HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [backupVaultName](#API_DisassociateRecoveryPoint_RequestSyntax) **   <a name="Backup-DisassociateRecoveryPoint-request-uri-BackupVaultName"></a>
 AWS Backup 保存庫的唯一名稱。  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必要：是

 ** [recoveryPointArn](#API_DisassociateRecoveryPoint_RequestSyntax) **   <a name="Backup-DisassociateRecoveryPoint-request-uri-RecoveryPointArn"></a>
唯一識別 AWS Backup 復原點的 Amazon Resource Name (ARN)。  
必要：是

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

請求沒有請求主體。

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

```
HTTP/1.1 200
```

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

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

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

 ** InvalidResourceStateException **   
 AWS Backup 正在對此復原點執行動作。在第一個動作完成之前，其無法執行您要求的動作。請稍後再試。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# DisassociateRecoveryPointFromParent
<a name="API_DisassociateRecoveryPointFromParent"></a>

此動作針對特定子 (巢狀) 復原點，會移除指定復原點與其父項 (複合) 復原點之間的關係。

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

```
DELETE /backup-vaults/backupVaultName/recovery-points/recoveryPointArn/parentAssociation HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [backupVaultName](#API_DisassociateRecoveryPointFromParent_RequestSyntax) **   <a name="Backup-DisassociateRecoveryPointFromParent-request-uri-BackupVaultName"></a>
儲存子 （巢狀） 復原點的邏輯容器名稱。備份保存庫是由用於建立它們的帳戶及其建立 AWS 區域的唯一名稱所識別。  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必要：是

 ** [recoveryPointArn](#API_DisassociateRecoveryPointFromParent_RequestSyntax) **   <a name="Backup-DisassociateRecoveryPointFromParent-request-uri-RecoveryPointArn"></a>
可唯一識別子 （巢狀） 復原點的 Amazon Resource Name (ARN)；例如， `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.`  
必要：是

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

請求沒有請求主體。

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

```
HTTP/1.1 204
```

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

如果動作成功，則服務會送回具有空 HTTP 主體的 HTTP 204 回應。

## 錯誤
<a name="API_DisassociateRecoveryPointFromParent_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_DisassociateRecoveryPointFromParent_SeeAlso"></a>

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

# ExportBackupPlanTemplate
<a name="API_ExportBackupPlanTemplate"></a>

傳回由計劃 ID 指定為備份範本的備份計劃。

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

```
GET /backup/plans/backupPlanId/toTemplate/ HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [backupPlanId](#API_ExportBackupPlanTemplate_RequestSyntax) **   <a name="Backup-ExportBackupPlanTemplate-request-uri-BackupPlanId"></a>
唯一識別備份計畫。  
必要：是

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

請求沒有請求主體。

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

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

{
   "BackupPlanTemplateJson": "string"
}
```

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

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

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

 ** [BackupPlanTemplateJson](#API_ExportBackupPlanTemplate_ResponseSyntax) **   <a name="Backup-ExportBackupPlanTemplate-response-BackupPlanTemplateJson"></a>
JSON 格式的備份計劃範本本文。  
這是已簽署的 JSON 文件，無法在傳遞至 `GetBackupPlanFromJSON.` 之前修改 
類型：字串

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# GetBackupPlan
<a name="API_GetBackupPlan"></a>

傳回指定 `BackupPlanId` 的 `BackupPlan` 詳細資訊。詳細資料是 JSON 格式的備份計畫內文，並包括計畫中繼資料。

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

```
GET /backup/plans/backupPlanId/?MaxScheduledRunsPreview=MaxScheduledRunsPreview&versionId=VersionId HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [backupPlanId](#API_GetBackupPlan_RequestSyntax) **   <a name="Backup-GetBackupPlan-request-uri-BackupPlanId"></a>
唯一識別備份計畫。  
必要：是

 ** [MaxScheduledRunsPreview](#API_GetBackupPlan_RequestSyntax) **   <a name="Backup-GetBackupPlan-request-uri-MaxScheduledRunsPreview"></a>
要預覽的未來排程備份執行數目。設為 0 （預設） 時，回應中不會包含排定的執行預覽。有效範圍為 0-10。  
有效範圍：最小值為 0。最大值為 10。

 ** [VersionId](#API_GetBackupPlan_RequestSyntax) **   <a name="Backup-GetBackupPlan-request-uri-VersionId"></a>
唯一隨機產生的 Unicode、UTF-8 編碼字串，最長 1,024 個位元組。版本 ID 不能編輯。

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

請求沒有請求主體。

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

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

{
   "AdvancedBackupSettings": [ 
      { 
         "BackupOptions": { 
            "string" : "string" 
         },
         "ResourceType": "string"
      }
   ],
   "BackupPlan": { 
      "AdvancedBackupSettings": [ 
         { 
            "BackupOptions": { 
               "string" : "string" 
            },
            "ResourceType": "string"
         }
      ],
      "BackupPlanName": "string",
      "Rules": [ 
         { 
            "CompletionWindowMinutes": number,
            "CopyActions": [ 
               { 
                  "DestinationBackupVaultArn": "string",
                  "Lifecycle": { 
                     "DeleteAfterDays": number,
                     "DeleteAfterEvent": "string",
                     "MoveToColdStorageAfterDays": number,
                     "OptInToArchiveForSupportedResources": boolean
                  }
               }
            ],
            "EnableContinuousBackup": boolean,
            "IndexActions": [ 
               { 
                  "ResourceTypes": [ "string" ]
               }
            ],
            "Lifecycle": { 
               "DeleteAfterDays": number,
               "DeleteAfterEvent": "string",
               "MoveToColdStorageAfterDays": number,
               "OptInToArchiveForSupportedResources": boolean
            },
            "RecoveryPointTags": { 
               "string" : "string" 
            },
            "RuleId": "string",
            "RuleName": "string",
            "ScanActions": [ 
               { 
                  "MalwareScanner": "string",
                  "ScanMode": "string"
               }
            ],
            "ScheduleExpression": "string",
            "ScheduleExpressionTimezone": "string",
            "StartWindowMinutes": number,
            "TargetBackupVaultName": "string",
            "TargetLogicallyAirGappedBackupVaultArn": "string"
         }
      ],
      "ScanSettings": [ 
         { 
            "MalwareScanner": "string",
            "ResourceTypes": [ "string" ],
            "ScannerRoleArn": "string"
         }
      ]
   },
   "BackupPlanArn": "string",
   "BackupPlanId": "string",
   "CreationDate": number,
   "CreatorRequestId": "string",
   "DeletionDate": number,
   "LastExecutionDate": number,
   "ScheduledRunsPreview": [ 
      { 
         "ExecutionTime": number,
         "RuleExecutionType": "string",
         "RuleId": "string"
      }
   ],
   "VersionId": "string"
}
```

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

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

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

 ** [AdvancedBackupSettings](#API_GetBackupPlan_ResponseSyntax) **   <a name="Backup-GetBackupPlan-response-AdvancedBackupSettings"></a>
包含每種資源類型的 `BackupOptions` 清單。只有在為備份計畫設定進階選項時，才會填入清單。  
類型：[AdvancedBackupSetting](API_AdvancedBackupSetting.md) 物件陣列

 ** [BackupPlan](#API_GetBackupPlan_ResponseSyntax) **   <a name="Backup-GetBackupPlan-response-BackupPlan"></a>
指定備份計畫的內文。包括一個 `BackupPlanName` 和一或多組 `Rules`。  
類型：[BackupPlan](API_BackupPlan.md) 物件

 ** [BackupPlanArn](#API_GetBackupPlan_ResponseSyntax) **   <a name="Backup-GetBackupPlan-response-BackupPlanArn"></a>
可唯一識別備份計畫的 Amazon Resource Name (ARN)，例如 `arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50`。  
類型：字串

 ** [BackupPlanId](#API_GetBackupPlan_ResponseSyntax) **   <a name="Backup-GetBackupPlan-response-BackupPlanId"></a>
唯一識別備份計畫。  
類型：字串

 ** [CreationDate](#API_GetBackupPlan_ResponseSyntax) **   <a name="Backup-GetBackupPlan-response-CreationDate"></a>
建立備份計畫時的日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。`CreationDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [CreatorRequestId](#API_GetBackupPlan_ResponseSyntax) **   <a name="Backup-GetBackupPlan-response-CreatorRequestId"></a>
可識別請求的唯一字串，且允許重試失敗的請求，而不會有兩次執行操作的風險。  
類型：字串

 ** [DeletionDate](#API_GetBackupPlan_ResponseSyntax) **   <a name="Backup-GetBackupPlan-response-DeletionDate"></a>
刪除備份計畫時的日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。`DeletionDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [LastExecutionDate](#API_GetBackupPlan_ResponseSyntax) **   <a name="Backup-GetBackupPlan-response-LastExecutionDate"></a>
上次執行此備份計畫的時間。日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。`LastExecutionDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [ScheduledRunsPreview](#API_GetBackupPlan_ResponseSyntax) **   <a name="Backup-GetBackupPlan-response-ScheduledRunsPreview"></a>
近期排程備份執行的清單。僅在`MaxScheduledRunsPreview`參數大於 0 時包含。包含最多 10 個未來的備份執行及其排程時間、執行類型和關聯的規則 IDs。  
類型：[ScheduledPlanExecutionMember](API_ScheduledPlanExecutionMember.md) 物件陣列

 ** [VersionId](#API_GetBackupPlan_ResponseSyntax) **   <a name="Backup-GetBackupPlan-response-VersionId"></a>
唯一隨機產生的 Unicode、UTF-8 編碼字串，最長 1,024 個位元組。版本 ID 不能編輯。  
類型：字串

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# GetBackupPlanFromJSON
<a name="API_GetBackupPlanFromJSON"></a>

傳回指定備份計劃或錯誤的有效 JSON 文件。

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

```
POST /backup/template/json/toPlan HTTP/1.1
Content-type: application/json

{
   "BackupPlanTemplateJson": "string"
}
```

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

請求不會使用任何 URI 參數。

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

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

 ** [BackupPlanTemplateJson](#API_GetBackupPlanFromJSON_RequestSyntax) **   <a name="Backup-GetBackupPlanFromJSON-request-BackupPlanTemplateJson"></a>
客戶提供的 JSON 格式備份計劃文件。  
類型：字串  
必要：是

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

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

{
   "BackupPlan": { 
      "AdvancedBackupSettings": [ 
         { 
            "BackupOptions": { 
               "string" : "string" 
            },
            "ResourceType": "string"
         }
      ],
      "BackupPlanName": "string",
      "Rules": [ 
         { 
            "CompletionWindowMinutes": number,
            "CopyActions": [ 
               { 
                  "DestinationBackupVaultArn": "string",
                  "Lifecycle": { 
                     "DeleteAfterDays": number,
                     "DeleteAfterEvent": "string",
                     "MoveToColdStorageAfterDays": number,
                     "OptInToArchiveForSupportedResources": boolean
                  }
               }
            ],
            "EnableContinuousBackup": boolean,
            "IndexActions": [ 
               { 
                  "ResourceTypes": [ "string" ]
               }
            ],
            "Lifecycle": { 
               "DeleteAfterDays": number,
               "DeleteAfterEvent": "string",
               "MoveToColdStorageAfterDays": number,
               "OptInToArchiveForSupportedResources": boolean
            },
            "RecoveryPointTags": { 
               "string" : "string" 
            },
            "RuleId": "string",
            "RuleName": "string",
            "ScanActions": [ 
               { 
                  "MalwareScanner": "string",
                  "ScanMode": "string"
               }
            ],
            "ScheduleExpression": "string",
            "ScheduleExpressionTimezone": "string",
            "StartWindowMinutes": number,
            "TargetBackupVaultName": "string",
            "TargetLogicallyAirGappedBackupVaultArn": "string"
         }
      ],
      "ScanSettings": [ 
         { 
            "MalwareScanner": "string",
            "ResourceTypes": [ "string" ],
            "ScannerRoleArn": "string"
         }
      ]
   }
}
```

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

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

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

 ** [BackupPlan](#API_GetBackupPlanFromJSON_ResponseSyntax) **   <a name="Backup-GetBackupPlanFromJSON-response-BackupPlan"></a>
指定備份計劃的本文。包括一個 `BackupPlanName` 和一或多組 `Rules`。  
類型：[BackupPlan](API_BackupPlan.md) 物件

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

 ** LimitExceededException **   
請求已超過限制；例如，請求中允許的最大項目數量。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# GetBackupPlanFromTemplate
<a name="API_GetBackupPlanFromTemplate"></a>

傳回由其 `templateId` 指定為備份計劃的範本。

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

```
GET /backup/template/plans/templateId/toPlan HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [templateId](#API_GetBackupPlanFromTemplate_RequestSyntax) **   <a name="Backup-GetBackupPlanFromTemplate-request-uri-BackupPlanTemplateId"></a>
可唯一識別儲存的備份計劃範本。  
必要：是

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

請求沒有請求主體。

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

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

{
   "BackupPlanDocument": { 
      "AdvancedBackupSettings": [ 
         { 
            "BackupOptions": { 
               "string" : "string" 
            },
            "ResourceType": "string"
         }
      ],
      "BackupPlanName": "string",
      "Rules": [ 
         { 
            "CompletionWindowMinutes": number,
            "CopyActions": [ 
               { 
                  "DestinationBackupVaultArn": "string",
                  "Lifecycle": { 
                     "DeleteAfterDays": number,
                     "DeleteAfterEvent": "string",
                     "MoveToColdStorageAfterDays": number,
                     "OptInToArchiveForSupportedResources": boolean
                  }
               }
            ],
            "EnableContinuousBackup": boolean,
            "IndexActions": [ 
               { 
                  "ResourceTypes": [ "string" ]
               }
            ],
            "Lifecycle": { 
               "DeleteAfterDays": number,
               "DeleteAfterEvent": "string",
               "MoveToColdStorageAfterDays": number,
               "OptInToArchiveForSupportedResources": boolean
            },
            "RecoveryPointTags": { 
               "string" : "string" 
            },
            "RuleId": "string",
            "RuleName": "string",
            "ScanActions": [ 
               { 
                  "MalwareScanner": "string",
                  "ScanMode": "string"
               }
            ],
            "ScheduleExpression": "string",
            "ScheduleExpressionTimezone": "string",
            "StartWindowMinutes": number,
            "TargetBackupVaultName": "string",
            "TargetLogicallyAirGappedBackupVaultArn": "string"
         }
      ],
      "ScanSettings": [ 
         { 
            "MalwareScanner": "string",
            "ResourceTypes": [ "string" ],
            "ScannerRoleArn": "string"
         }
      ]
   }
}
```

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

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

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

 ** [BackupPlanDocument](#API_GetBackupPlanFromTemplate_ResponseSyntax) **   <a name="Backup-GetBackupPlanFromTemplate-response-BackupPlanDocument"></a>
根據目標範本傳回備份計劃的主文，包括計劃的名稱、規則和備份保存庫。  
類型：[BackupPlan](API_BackupPlan.md) 物件

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# GetBackupSelection
<a name="API_GetBackupSelection"></a>

傳回所選取中繼資料和 JSON 格式的文件，此文件會指定與備份計劃相關聯的資源清單。

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

```
GET /backup/plans/backupPlanId/selections/selectionId HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [backupPlanId](#API_GetBackupSelection_RequestSyntax) **   <a name="Backup-GetBackupSelection-request-uri-BackupPlanId"></a>
唯一識別備份計畫。  
必要：是

 ** [selectionId](#API_GetBackupSelection_RequestSyntax) **   <a name="Backup-GetBackupSelection-request-uri-SelectionId"></a>
可唯一識別請求本文，將一組資源指派給備份計劃。  
必要：是

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

請求沒有請求主體。

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

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

{
   "BackupPlanId": "string",
   "BackupSelection": { 
      "Conditions": { 
         "StringEquals": [ 
            { 
               "ConditionKey": "string",
               "ConditionValue": "string"
            }
         ],
         "StringLike": [ 
            { 
               "ConditionKey": "string",
               "ConditionValue": "string"
            }
         ],
         "StringNotEquals": [ 
            { 
               "ConditionKey": "string",
               "ConditionValue": "string"
            }
         ],
         "StringNotLike": [ 
            { 
               "ConditionKey": "string",
               "ConditionValue": "string"
            }
         ]
      },
      "IamRoleArn": "string",
      "ListOfTags": [ 
         { 
            "ConditionKey": "string",
            "ConditionType": "string",
            "ConditionValue": "string"
         }
      ],
      "NotResources": [ "string" ],
      "Resources": [ "string" ],
      "SelectionName": "string"
   },
   "CreationDate": number,
   "CreatorRequestId": "string",
   "SelectionId": "string"
}
```

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

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

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

 ** [BackupPlanId](#API_GetBackupSelection_ResponseSyntax) **   <a name="Backup-GetBackupSelection-response-BackupPlanId"></a>
唯一識別備份計畫。  
類型：字串

 ** [BackupSelection](#API_GetBackupSelection_ResponseSyntax) **   <a name="Backup-GetBackupSelection-response-BackupSelection"></a>
指定請求的內文，將一組資源指派給備份計畫。  
類型：[BackupSelection](API_BackupSelection.md) 物件

 ** [CreationDate](#API_GetBackupSelection_ResponseSyntax) **   <a name="Backup-GetBackupSelection-response-CreationDate"></a>
建立備份選擇時的日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。`CreationDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [CreatorRequestId](#API_GetBackupSelection_ResponseSyntax) **   <a name="Backup-GetBackupSelection-response-CreatorRequestId"></a>
可識別請求的唯一字串，且允許重試失敗的請求，而不會有兩次執行操作的風險。  
類型：字串

 ** [SelectionId](#API_GetBackupSelection_ResponseSyntax) **   <a name="Backup-GetBackupSelection-response-SelectionId"></a>
可唯一識別請求本文，將一組資源指派給備份計劃。  
類型：字串

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# GetBackupVaultAccessPolicy
<a name="API_GetBackupVaultAccessPolicy"></a>

傳回與具名備份保存庫相關聯的存取政策文件。

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

```
GET /backup-vaults/backupVaultName/access-policy HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [backupVaultName](#API_GetBackupVaultAccessPolicy_RequestSyntax) **   <a name="Backup-GetBackupVaultAccessPolicy-request-uri-BackupVaultName"></a>
存放備份的邏輯容器名稱。備份文件庫依名稱識別，這些名稱對建立文件庫的帳戶和 AWS 區域來說是唯一的。  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必要：是

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

請求沒有請求主體。

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

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

{
   "BackupVaultArn": "string",
   "BackupVaultName": "string",
   "Policy": "string"
}
```

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

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

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

 ** [BackupVaultArn](#API_GetBackupVaultAccessPolicy_ResponseSyntax) **   <a name="Backup-GetBackupVaultAccessPolicy-response-BackupVaultArn"></a>
可唯一識別備份文件庫的 Amazon Resource Name (ARN)，例如 `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`。  
類型：字串

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

 ** [Policy](#API_GetBackupVaultAccessPolicy_ResponseSyntax) **   <a name="Backup-GetBackupVaultAccessPolicy-response-Policy"></a>
JSON 格式的備份保存庫存取政策文件。  
類型：字串

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# GetBackupVaultNotifications
<a name="API_GetBackupVaultNotifications"></a>

傳回指定備份文件庫的事件通知。

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

```
GET /backup-vaults/backupVaultName/notification-configuration HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [backupVaultName](#API_GetBackupVaultNotifications_RequestSyntax) **   <a name="Backup-GetBackupVaultNotifications-request-uri-BackupVaultName"></a>
存放備份的邏輯容器名稱。備份文件庫依名稱識別，這些名稱對建立文件庫的帳戶和 AWS 區域來說是唯一的。  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必要：是

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

請求沒有請求主體。

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

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

{
   "BackupVaultArn": "string",
   "BackupVaultEvents": [ "string" ],
   "BackupVaultName": "string",
   "SNSTopicArn": "string"
}
```

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

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

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

 ** [BackupVaultArn](#API_GetBackupVaultNotifications_ResponseSyntax) **   <a name="Backup-GetBackupVaultNotifications-response-BackupVaultArn"></a>
可唯一識別備份文件庫的 Amazon Resource Name (ARN)，例如 `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`。  
類型：字串

 ** [BackupVaultEvents](#API_GetBackupVaultNotifications_ResponseSyntax) **   <a name="Backup-GetBackupVaultNotifications-response-BackupVaultEvents"></a>
事件陣列，指示將資源備份到備份文件庫的任務狀態。  
類型：字串陣列  
有效值:`BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED | BACKUP_JOB_SUCCESSFUL | BACKUP_JOB_FAILED | BACKUP_JOB_EXPIRED | RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RESTORE_JOB_SUCCESSFUL | RESTORE_JOB_FAILED | COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED | RECOVERY_POINT_MODIFIED | BACKUP_PLAN_CREATED | BACKUP_PLAN_MODIFIED | S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED | CONTINUOUS_BACKUP_INTERRUPTED | RECOVERY_POINT_INDEX_COMPLETED | RECOVERY_POINT_INDEX_DELETED | RECOVERY_POINT_INDEXING_FAILED` 

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

 ** [SNSTopicArn](#API_GetBackupVaultNotifications_ResponseSyntax) **   <a name="Backup-GetBackupVaultNotifications-response-SNSTopicArn"></a>
唯一識別 Amazon Simple Notification Service (Amazon SNS) 主題的 ARN，例如，`arn:aws:sns:us-west-2:111122223333:MyTopic`。  
類型：字串

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# GetLegalHold
<a name="API_GetLegalHold"></a>

此動作會傳回指定法務保存的詳細資訊。詳細資料是 JSON 格式的法務保存內文，並包括中繼資料。

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

```
GET /legal-holds/legalHoldId/ HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [legalHoldId](#API_GetLegalHold_RequestSyntax) **   <a name="Backup-GetLegalHold-request-uri-LegalHoldId"></a>
法務保存的 ID。  
必要：是

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

請求沒有請求主體。

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

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

{
   "CancelDescription": "string",
   "CancellationDate": number,
   "CreationDate": number,
   "Description": "string",
   "LegalHoldArn": "string",
   "LegalHoldId": "string",
   "RecoveryPointSelection": { 
      "DateRange": { 
         "FromDate": number,
         "ToDate": number
      },
      "ResourceIdentifiers": [ "string" ],
      "VaultNames": [ "string" ]
   },
   "RetainRecordUntil": number,
   "Status": "string",
   "Title": "string"
}
```

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

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

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

 ** [CancelDescription](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-CancelDescription"></a>
移除法務保存的原因。  
類型：字串

 ** [CancellationDate](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-CancellationDate"></a>
取消法務保存的時間。  
類型：Timestamp

 ** [CreationDate](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-CreationDate"></a>
建立法務保存的時間。  
類型：Timestamp

 ** [Description](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-Description"></a>
法務保存的說明。  
類型：字串

 ** [LegalHoldArn](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-LegalHoldArn"></a>
指定法務保存的架構 ARN。ARN 的格式取決於資源類型。  
類型：字串

 ** [LegalHoldId](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-LegalHoldId"></a>
法務保存的 ID。  
類型：字串

 ** [RecoveryPointSelection](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-RecoveryPointSelection"></a>
指派一組資源的條件，例如資源類型或備份文件庫。  
類型：[RecoveryPointSelection](API_RecoveryPointSelection.md) 物件

 ** [RetainRecordUntil](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-RetainRecordUntil"></a>
保留法務保存記錄的日期和時間。  
類型：Timestamp

 ** [Status](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-Status"></a>
法務保存的狀態。  
類型：字串  
有效值:`CREATING | ACTIVE | CANCELING | CANCELED` 

 ** [Title](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-Title"></a>
法務保存的標題。  
類型：字串

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# GetRecoveryPointIndexDetails
<a name="API_GetRecoveryPointIndexDetails"></a>

此操作會傳回特定於與指定復原點相關聯之備份索引的中繼資料和詳細資訊。

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

```
GET /backup-vaults/backupVaultName/recovery-points/recoveryPointArn/index HTTP/1.1
```

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

請求會使用下列 URI 參數。

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

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

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

請求沒有請求主體。

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

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

{
   "BackupVaultArn": "string",
   "IndexCompletionDate": number,
   "IndexCreationDate": number,
   "IndexDeletionDate": number,
   "IndexStatus": "string",
   "IndexStatusMessage": "string",
   "RecoveryPointArn": "string",
   "SourceResourceArn": "string",
   "TotalItemsIndexed": number
}
```

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

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

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

 ** [BackupVaultArn](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **   <a name="Backup-GetRecoveryPointIndexDetails-response-BackupVaultArn"></a>
唯一識別儲存復原點索引之備份保存庫的 ARN。  
例如 `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`。  
類型：字串

 ** [IndexCompletionDate](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **   <a name="Backup-GetRecoveryPointIndexDetails-response-IndexCompletionDate"></a>
備份索引完成建立的日期和時間，採用 Unix 格式和國際標準時間 (UTC)。`CreationDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [IndexCreationDate](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **   <a name="Backup-GetRecoveryPointIndexDetails-response-IndexCreationDate"></a>
建立備份索引的日期和時間，採用 Unix 格式和國際標準時間 (UTC)。`CreationDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [IndexDeletionDate](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **   <a name="Backup-GetRecoveryPointIndexDetails-response-IndexDeletionDate"></a>
刪除備份索引的日期和時間，採用 Unix 格式和國際標準時間 (UTC)。`CreationDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

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

 ** [IndexStatusMessage](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **   <a name="Backup-GetRecoveryPointIndexDetails-response-IndexStatusMessage"></a>
說明與復原點相關聯之備份索引狀態的詳細訊息。  
類型：字串

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

 ** [SourceResourceArn](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **   <a name="Backup-GetRecoveryPointIndexDetails-response-SourceResourceArn"></a>
可唯一識別來源資源的 Amazon Resource Name (ARN) 字串。  
類型：字串

 ** [TotalItemsIndexed](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **   <a name="Backup-GetRecoveryPointIndexDetails-response-TotalItemsIndexed"></a>
與復原點相關聯之備份索引內的項目計數。  
類型：Long

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# GetRecoveryPointRestoreMetadata
<a name="API_GetRecoveryPointRestoreMetadata"></a>

傳回一組用於建立備份的中繼資料鍵值對。

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

```
GET /backup-vaults/backupVaultName/recovery-points/recoveryPointArn/restore-metadata?backupVaultAccountId=BackupVaultAccountId HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [BackupVaultAccountId](#API_GetRecoveryPointRestoreMetadata_RequestSyntax) **   <a name="Backup-GetRecoveryPointRestoreMetadata-request-uri-BackupVaultAccountId"></a>
指定備份保存庫的帳戶 ID。  
模式：`^[0-9]{12}$`

 ** [backupVaultName](#API_GetRecoveryPointRestoreMetadata_RequestSyntax) **   <a name="Backup-GetRecoveryPointRestoreMetadata-request-uri-BackupVaultName"></a>
存放備份的邏輯容器名稱。備份文件庫依名稱識別，這些名稱對建立文件庫的帳戶和 AWS 區域來說是唯一的。  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必要：是

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

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

請求沒有請求主體。

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

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

{
   "BackupVaultArn": "string",
   "RecoveryPointArn": "string",
   "ResourceType": "string",
   "RestoreMetadata": { 
      "string" : "string" 
   }
}
```

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

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

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

 ** [BackupVaultArn](#API_GetRecoveryPointRestoreMetadata_ResponseSyntax) **   <a name="Backup-GetRecoveryPointRestoreMetadata-response-BackupVaultArn"></a>
可唯一識別備份保存庫的 ARN，例如 `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`。  
類型：字串

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

 ** [ResourceType](#API_GetRecoveryPointRestoreMetadata_ResponseSyntax) **   <a name="Backup-GetRecoveryPointRestoreMetadata-response-ResourceType"></a>
復原點的資源類型。  
類型：字串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`

 ** [RestoreMetadata](#API_GetRecoveryPointRestoreMetadata_ResponseSyntax) **   <a name="Backup-GetRecoveryPointRestoreMetadata-response-RestoreMetadata"></a>
描述備份資源原始配置的中繼資料鍵值對集。這些值會根據正在還原的服務而有所不同。  
類型：字串到字串映射

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# GetRestoreJobMetadata
<a name="API_GetRestoreJobMetadata"></a>

此請求會傳回指定還原任務的中繼資料。

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

```
GET /restore-jobs/restoreJobId/metadata HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [restoreJobId](#API_GetRestoreJobMetadata_RequestSyntax) **   <a name="Backup-GetRestoreJobMetadata-request-uri-RestoreJobId"></a>
這是其中還原任務的唯一識別符 AWS Backup。  
必要：是

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

請求沒有請求主體。

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

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

{
   "Metadata": { 
      "string" : "string" 
   },
   "RestoreJobId": "string"
}
```

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

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

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

 ** [Metadata](#API_GetRestoreJobMetadata_ResponseSyntax) **   <a name="Backup-GetRestoreJobMetadata-response-Metadata"></a>
其中包含指定備份任務的中繼資料。  
類型：字串到字串映射

 ** [RestoreJobId](#API_GetRestoreJobMetadata_ResponseSyntax) **   <a name="Backup-GetRestoreJobMetadata-response-RestoreJobId"></a>
這是其中還原任務的唯一識別符 AWS Backup。  
類型：字串

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# GetRestoreTestingInferredMetadata
<a name="API_GetRestoreTestingInferredMetadata"></a>

此請求會傳回一組精簡的必要中繼資料，使用安全預設設定開始還原任務會需要這些資料。`BackupVaultName` 和 `RecoveryPointArn` 是必要的參數。`BackupVaultAccountId` 是選用的參數。

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

```
GET /restore-testing/inferred-metadata?BackupVaultAccountId=BackupVaultAccountId&BackupVaultName=BackupVaultName&RecoveryPointArn=RecoveryPointArn HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [BackupVaultAccountId](#API_GetRestoreTestingInferredMetadata_RequestSyntax) **   <a name="Backup-GetRestoreTestingInferredMetadata-request-uri-BackupVaultAccountId"></a>
指定備份保存庫的帳戶 ID。

 ** [BackupVaultName](#API_GetRestoreTestingInferredMetadata_RequestSyntax) **   <a name="Backup-GetRestoreTestingInferredMetadata-request-uri-BackupVaultName"></a>
存放備份的邏輯容器名稱。備份保存庫是由用於建立它們的帳戶及其建立 AWS區域的唯一名稱所識別。這些名稱由字母、數字和連字號組成。  
必要：是

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

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

請求沒有請求主體。

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

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

{
   "InferredMetadata": { 
      "string" : "string" 
   }
}
```

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

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

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

 ** [InferredMetadata](#API_GetRestoreTestingInferredMetadata_ResponseSyntax) **   <a name="Backup-GetRestoreTestingInferredMetadata-response-InferredMetadata"></a>
這是從請求推斷之中繼資料的字串映射。  
類型：字串到字串映射

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# GetRestoreTestingPlan
<a name="API_GetRestoreTestingPlan"></a>

傳回指定 `RestoreTestingPlanName` 的 `RestoreTestingPlan` 詳細資訊。詳細資訊是 JSON 格式的還原測試計畫內文，並包括計畫中繼資料。

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

```
GET /restore-testing/plans/RestoreTestingPlanName HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [RestoreTestingPlanName](#API_GetRestoreTestingPlan_RequestSyntax) **   <a name="Backup-GetRestoreTestingPlan-request-uri-RestoreTestingPlanName"></a>
還原測試計畫的必要不重複名稱。  
必要：是

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

請求沒有請求主體。

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

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

{
   "RestoreTestingPlan": { 
      "CreationTime": number,
      "CreatorRequestId": "string",
      "LastExecutionTime": number,
      "LastUpdateTime": number,
      "RecoveryPointSelection": { 
         "Algorithm": "string",
         "ExcludeVaults": [ "string" ],
         "IncludeVaults": [ "string" ],
         "RecoveryPointTypes": [ "string" ],
         "SelectionWindowDays": number
      },
      "RestoreTestingPlanArn": "string",
      "RestoreTestingPlanName": "string",
      "ScheduleExpression": "string",
      "ScheduleExpressionTimezone": "string",
      "StartWindowHours": number
   }
}
```

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

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

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

 ** [RestoreTestingPlan](#API_GetRestoreTestingPlan_ResponseSyntax) **   <a name="Backup-GetRestoreTestingPlan-response-RestoreTestingPlan"></a>
指定還原測試計畫的內文。包括 `RestoreTestingPlanName`。  
類型：[RestoreTestingPlanForGet](API_RestoreTestingPlanForGet.md) 物件

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

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

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

HTTP 狀態碼：400

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

HTTP 狀態碼：500

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

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

# GetRestoreTestingSelection
<a name="API_GetRestoreTestingSelection"></a>

傳回 RestoreTestingSelection，其中顯示還原測試計畫的資源和元素。

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

```
GET /restore-testing/plans/RestoreTestingPlanName/selections/RestoreTestingSelectionName HTTP/1.1
```

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

請求會使用下列 URI 參數。

 ** [RestoreTestingPlanName](#API_GetRestoreTestingSelection_RequestSyntax) **   <a name="Backup-GetRestoreTestingSelection-request-uri-RestoreTestingPlanName"></a>
還原測試計畫的必要不重複名稱。  
必要：是

 ** [RestoreTestingSelectionName](#API_GetRestoreTestingSelection_RequestSyntax) **   <a name="Backup-GetRestoreTestingSelection-request-uri-RestoreTestingSelectionName"></a>
還原測試選擇的必要不重複名稱。  
必要：是

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

請求沒有請求主體。

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

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

{
   "RestoreTestingSelection": { 
      "CreationTime": number,
      "CreatorRequestId": "string",
      "IamRoleArn": "string",
      "ProtectedResourceArns": [ "string" ],
      "ProtectedResourceConditions": { 
         "StringEquals": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "StringNotEquals": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ]
      },
      "ProtectedResourceType": "string",
      "RestoreMetadataOverrides": { 
         "string" : "string" 
      },
      "RestoreTestingPlanName": "string",
      "RestoreTestingSelectionName": "string",
      "ValidationWindowHours": number
   }
}
```

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

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

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

 ** [RestoreTestingSelection](#API_GetRestoreTestingSelection_ResponseSyntax) **   <a name="Backup-GetRestoreTestingSelection-response-RestoreTestingSelection"></a>
還原測試選擇的不重複名稱。  
類型：[RestoreTestingSelectionForGet](API_RestoreTestingSelectionForGet.md) 物件

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

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_GetRestoreTestingSelection_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/GetRestoreTestingSelection) 

# GetSupportedResourceTypes
<a name="API_GetSupportedResourceTypes"></a>

傳回 支援 AWS 的資源類型 AWS Backup。

## 請求語法
<a name="API_GetSupportedResourceTypes_RequestSyntax"></a>

```
GET /supported-resource-types HTTP/1.1
```

## URI 請求參數
<a name="API_GetSupportedResourceTypes_RequestParameters"></a>

請求不會使用任何 URI 參數。

## 請求主體
<a name="API_GetSupportedResourceTypes_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_GetSupportedResourceTypes_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ResourceTypes": [ "string" ]
}
```

## 回應元素
<a name="API_GetSupportedResourceTypes_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [ResourceTypes](#API_GetSupportedResourceTypes_ResponseSyntax) **   <a name="Backup-GetSupportedResourceTypes-response-ResourceTypes"></a>
包含具有支援 AWS 資源類型的字串：  
+  `Aurora` 代表 Amazon Aurora
+  `CloudFormation` 適用於 的 AWS CloudFormation 
+  `DocumentDB` 代表 Amazon DocumentDB (with MongoDB compatibility)
+  `DynamoDB` 代表 Amazon DynamoDB
+  `EBS` 代表 Amazon Elastic Block Store
+  `EC2` 代表 Amazon Elastic Compute Cloud
+  `EFS` 代表 Amazon Elastic File System
+  `EKS` for Amazon Elastic Kubernetes Service
+  `FSx` 代表 Amazon FSx
+  `Neptune` 代表 Amazon Neptune
+  `RDS` 代表 Amazon Relational Database Service
+  `Redshift` 代表 Amazon Redshift
+  `S3` for Amazon Simple Storage Service (Amazon S3)
+  `SAP HANA on Amazon EC2` 適用於 Amazon Elastic Compute Cloud 執行個體上的 SAP HANA 資料庫
+  `Storage Gateway` 適用於 的 AWS Storage Gateway 
+  `Timestream` 代表 Amazon Timestream
+  `VirtualMachine` 適用於 VMware 虛擬機器
類型：字串陣列  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`

## 錯誤
<a name="API_GetSupportedResourceTypes_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_GetSupportedResourceTypes_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/GetSupportedResourceTypes) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetSupportedResourceTypes) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetSupportedResourceTypes) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetSupportedResourceTypes) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetSupportedResourceTypes) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetSupportedResourceTypes) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetSupportedResourceTypes) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetSupportedResourceTypes) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetSupportedResourceTypes) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/GetSupportedResourceTypes) 

# GetTieringConfiguration
<a name="API_GetTieringConfiguration"></a>

傳回指定 `TieringConfigurationName` 的 `TieringConfiguration` 詳細資訊。除了組態中繼資料之外，詳細資訊也是 JSON 格式分層組態的內文。

## 請求語法
<a name="API_GetTieringConfiguration_RequestSyntax"></a>

```
GET /tiering-configurations/tieringConfigurationName HTTP/1.1
```

## URI 請求參數
<a name="API_GetTieringConfiguration_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [tieringConfigurationName](#API_GetTieringConfiguration_RequestSyntax) **   <a name="Backup-GetTieringConfiguration-request-uri-TieringConfigurationName"></a>
分層組態的唯一名稱。  
模式：`^[a-zA-Z0-9_]{1,200}$`  
必要：是

## 請求主體
<a name="API_GetTieringConfiguration_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_GetTieringConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "TieringConfiguration": { 
      "BackupVaultName": "string",
      "CreationTime": number,
      "CreatorRequestId": "string",
      "LastUpdatedTime": number,
      "ResourceSelection": [ 
         { 
            "Resources": [ "string" ],
            "ResourceType": "string",
            "TieringDownSettingsInDays": number
         }
      ],
      "TieringConfigurationArn": "string",
      "TieringConfigurationName": "string"
   }
}
```

## 回應元素
<a name="API_GetTieringConfiguration_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [TieringConfiguration](#API_GetTieringConfiguration_ResponseSyntax) **   <a name="Backup-GetTieringConfiguration-response-TieringConfiguration"></a>
指定分層組態的內文。包括 `TieringConfigurationName`。  
類型：[TieringConfiguration](API_TieringConfiguration.md) 物件

## 錯誤
<a name="API_GetTieringConfiguration_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_GetTieringConfiguration_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/GetTieringConfiguration) 

# ListBackupJobs
<a name="API_ListBackupJobs"></a>

傳回過去 30 天內已驗證帳戶的現有備份任務清單。如需更長的時間，請考慮使用這些[監視工具](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html)。

## 請求語法
<a name="API_ListBackupJobs_RequestSyntax"></a>

```
GET /backup-jobs/?accountId=ByAccountId&backupVaultName=ByBackupVaultName&completeAfter=ByCompleteAfter&completeBefore=ByCompleteBefore&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&maxResults=MaxResults&messageCategory=ByMessageCategory&nextToken=NextToken&parentJobId=ByParentJobId&resourceArn=ByResourceArn&resourceType=ByResourceType&state=ByState HTTP/1.1
```

## URI 請求參數
<a name="API_ListBackupJobs_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [ByAccountId](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByAccountId"></a>
列出任務的帳戶 ID。僅傳回與特定帳戶 ID 相關聯的備份任務。  
如果從 AWS Organizations 管理帳戶使用 ，傳遞會`*`傳回整個組織的所有任務。  
模式：`^[0-9]{12}$`

 ** [ByBackupVaultName](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByBackupVaultName"></a>
僅傳回將儲存在特定備份保存庫中的備份任務。備份文件庫依名稱識別，這些名稱對建立文件庫的帳戶和 AWS 區域來說是唯一的。  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`

 ** [ByCompleteAfter](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByCompleteAfter"></a>
僅傳回以 Unix 格式和國際標準時間 (UTC) 所表示日期之後完成的備份任務。

 ** [ByCompleteBefore](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByCompleteBefore"></a>
僅傳回以 Unix 格式和國際標準時間 (UTC) 所表示日期之前完成的備份任務。

 ** [ByCreatedAfter](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByCreatedAfter"></a>
僅傳回特定日期之後建立的備份任務。

 ** [ByCreatedBefore](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByCreatedBefore"></a>
僅傳回特定日期之前建立的備份任務。

 ** [ByMessageCategory](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByMessageCategory"></a>
這是選用參數，可用於透過與您輸入之值相符的 MessageCategory 來篩選任務。  
範例字串可能包括 `AccessDenied`、`SUCCESS`、`AGGREGATE_ALL` 和 `InvalidParameters`。  
檢視[監控](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html)   
萬用字元 () 會傳回所有訊息類別的計數。  
 `AGGREGATE_ALL` 彙總所有訊息類別的任務計數，並傳回總和。

 ** [ByParentJobId](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByParentJobId"></a>
這是根據父系任務 ID 列出子 (巢狀) 任務的篩選器。

 ** [ByResourceArn](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByResourceArn"></a>
僅傳回符合特定資源 Amazon Resource Name (ARN) 的備份任務。

 ** [ByResourceType](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByResourceType"></a>
僅傳回指定資源的備份任務：  
+  `Aurora` 代表 Amazon Aurora
+  `CloudFormation` 適用於 的 AWS CloudFormation 
+  `DocumentDB` 代表 Amazon DocumentDB (with MongoDB compatibility)
+  `DynamoDB` 代表 Amazon DynamoDB
+  `EBS` 代表 Amazon Elastic Block Store
+  `EC2` 代表 Amazon Elastic Compute Cloud
+  `EFS` 代表 Amazon Elastic File System
+  `EKS` for Amazon Elastic Kubernetes Service
+  `FSx` 代表 Amazon FSx
+  `Neptune` 代表 Amazon Neptune
+  `RDS` 代表 Amazon Relational Database Service
+  `Redshift` 代表 Amazon Redshift
+  `S3` for Amazon Simple Storage Service (Amazon S3)
+  `SAP HANA on Amazon EC2` 適用於 Amazon Elastic Compute Cloud 執行個體上的 SAP HANA 資料庫
+  `Storage Gateway` 適用於 的 AWS Storage Gateway 
+  `Timestream` 代表 Amazon Timestream
+  `VirtualMachine` 適用於 VMware 虛擬機器
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`

 ** [ByState](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByState"></a>
僅傳回處於特定狀態的備份任務。  
 `Completed with issues` 是僅在 AWS Backup 主控台中找到的狀態。對於 API，此狀態是指狀態為 `COMPLETED` 且值不是 `SUCCESS` 之 `MessageCategory` 的任務；也就是說，狀態為已完成，但出現狀態訊息。  
若要取得 `Completed with issues` 的任務計數，請執行兩個 GET 請求，並減去第二個較小的數字：  
GET /backup-jobs/?state=COMPLETED  
GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED  
有效值:`CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL` 

 ** [MaxResults](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-MaxResults"></a>
所要傳回的項目數量上限。  
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。

## 請求主體
<a name="API_ListBackupJobs_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListBackupJobs_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "BackupJobs": [ 
      { 
         "AccountId": "string",
         "BackupJobId": "string",
         "BackupOptions": { 
            "string" : "string" 
         },
         "BackupSizeInBytes": number,
         "BackupType": "string",
         "BackupVaultArn": "string",
         "BackupVaultName": "string",
         "BytesTransferred": number,
         "CompletionDate": number,
         "CreatedBy": { 
            "BackupPlanArn": "string",
            "BackupPlanId": "string",
            "BackupPlanName": "string",
            "BackupPlanVersion": "string",
            "BackupRuleCron": "string",
            "BackupRuleId": "string",
            "BackupRuleName": "string",
            "BackupRuleTimezone": "string"
         },
         "CreationDate": number,
         "EncryptionKeyArn": "string",
         "ExpectedCompletionDate": number,
         "IamRoleArn": "string",
         "InitiationDate": number,
         "IsEncrypted": boolean,
         "IsParent": boolean,
         "MessageCategory": "string",
         "ParentJobId": "string",
         "PercentDone": "string",
         "RecoveryPointArn": "string",
         "RecoveryPointLifecycle": { 
            "DeleteAfterDays": number,
            "DeleteAfterEvent": "string",
            "MoveToColdStorageAfterDays": number,
            "OptInToArchiveForSupportedResources": boolean
         },
         "ResourceArn": "string",
         "ResourceName": "string",
         "ResourceType": "string",
         "StartBy": number,
         "State": "string",
         "StatusMessage": "string",
         "VaultLockState": "string",
         "VaultType": "string"
      }
   ],
   "NextToken": "string"
}
```

## 回應元素
<a name="API_ListBackupJobs_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [BackupJobs](#API_ListBackupJobs_ResponseSyntax) **   <a name="Backup-ListBackupJobs-response-BackupJobs"></a>
結構陣列，其中包含以 JSON 格式傳回的備份任務相關中繼資料。  
類型：[BackupJob](API_BackupJob.md) 物件陣列

 ** [NextToken](#API_ListBackupJobs_ResponseSyntax) **   <a name="Backup-ListBackupJobs-response-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。  
類型：字串

## 錯誤
<a name="API_ListBackupJobs_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListBackupJobs_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListBackupJobs) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListBackupJobs) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListBackupJobs) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListBackupJobs) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListBackupJobs) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListBackupJobs) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListBackupJobs) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListBackupJobs) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListBackupJobs) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListBackupJobs) 

# ListBackupJobSummaries
<a name="API_ListBackupJobSummaries"></a>

這是最近 30 天內建立或執行的備份任務摘要請求。您可以包括參數 AccountID、State、ResourceType、MessageCategory、AggregationPeriod、MaxResults 或 NextToken 來篩選結果。

此請求傳回的摘要包含 Region、Account，State、ResourceType、MessageCategory、StartTime、EndTime 和包含任務的計數。

## 請求語法
<a name="API_ListBackupJobSummaries_RequestSyntax"></a>

```
GET /audit/backup-job-summaries?AccountId=AccountId&AggregationPeriod=AggregationPeriod&MaxResults=MaxResults&MessageCategory=MessageCategory&NextToken=NextToken&ResourceType=ResourceType&State=State HTTP/1.1
```

## URI 請求參數
<a name="API_ListBackupJobSummaries_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [AccountId](#API_ListBackupJobSummaries_RequestSyntax) **   <a name="Backup-ListBackupJobSummaries-request-uri-AccountId"></a>
傳回指定帳戶的任務計數。  
如果請求是從成員帳戶或不屬於 AWS Organizations 的帳戶傳送，則會傳回請求者帳戶中的任務。  
根、管理員和委派管理員帳戶可以使用 ANY 值，傳回組織中每個帳戶的任務計數。  
 `AGGREGATE_ALL` 彙總已驗證組織內所有帳戶的任務計數，然後傳回總和。  
模式：`^[0-9]{12}$`

 ** [AggregationPeriod](#API_ListBackupJobSummaries_RequestSyntax) **   <a name="Backup-ListBackupJobSummaries-request-uri-AggregationPeriod"></a>
傳回結果的期間。  
+  `ONE_DAY` - 過去 14 天的每日任務計數。
+  `SEVEN_DAYS` - 過去 7 天的彙總任務計數。
+  `FOURTEEN_DAYS` - 過去 14 天的彙總任務計數。
有效值:`ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS` 

 ** [MaxResults](#API_ListBackupJobSummaries_RequestSyntax) **   <a name="Backup-ListBackupJobSummaries-request-uri-MaxResults"></a>
所要傳回的項目數量上限。  
值是整數。可接受值的範圍是從 1 到 500。  
有效範圍：最小值為 1。最大值為 1000。

 ** [MessageCategory](#API_ListBackupJobSummaries_RequestSyntax) **   <a name="Backup-ListBackupJobSummaries-request-uri-MessageCategory"></a>
此參數會傳回指定訊息類別的任務計數。  
接受的字串範例包括 `AccessDenied`、`Success` 和 `InvalidParameters`。請參閱[監控](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html)以取得接受的 MessageCategory 字串清單。  
該值 ANY 會傳回所有訊息類別的計數。  
 `AGGREGATE_ALL` 彙總所有訊息類別的任務計數，並傳回總和。

 ** [NextToken](#API_ListBackupJobSummaries_RequestSyntax) **   <a name="Backup-ListBackupJobSummaries-request-uri-NextToken"></a>
所傳回資源部分清單之後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的資源，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。

 ** [ResourceType](#API_ListBackupJobSummaries_RequestSyntax) **   <a name="Backup-ListBackupJobSummaries-request-uri-ResourceType"></a>
傳回指定資源類型的任務計數。使用請求 `GetSupportedResourceTypes` 取得支援資源類型的字串。  
該值 ANY 會傳回所有資源類型的計數。  
 `AGGREGATE_ALL` 彙總所有資源類型的任務計數，並傳回總和。  
要備份 AWS 的資源類型；例如，Amazon Elastic Block Store (Amazon EBS) 磁碟區或 Amazon Relational Database Service (Amazon RDS) 資料庫。  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`

 ** [State](#API_ListBackupJobSummaries_RequestSyntax) **   <a name="Backup-ListBackupJobSummaries-request-uri-State"></a>
此參數會傳回具有指定狀態之任務的任務計數。  
該值 ANY 會傳回所有狀態的計數。  
 `AGGREGATE_ALL` 彙總所有狀態的任務計數，並傳回總和。  
 `Completed with issues` 是僅在 AWS Backup 主控台中找到的狀態。對於 API，此狀態是指狀態為 `COMPLETED` 且值不是 `SUCCESS` 之 `MessageCategory` 的任務；也就是說，狀態為已完成，但出現狀態訊息。若要取得 `Completed with issues` 的任務計數，請執行兩個 GET 請求，並減去第二個較小的數字：  
GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN\$1DAYS&State=COMPLETED  
GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN\$1DAYS&MessageCategory=SUCCESS&State=COMPLETED  
有效值:`CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL | AGGREGATE_ALL | ANY` 

## 請求主體
<a name="API_ListBackupJobSummaries_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListBackupJobSummaries_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AggregationPeriod": "string",
   "BackupJobSummaries": [ 
      { 
         "AccountId": "string",
         "Count": number,
         "EndTime": number,
         "MessageCategory": "string",
         "Region": "string",
         "ResourceType": "string",
         "StartTime": number,
         "State": "string"
      }
   ],
   "NextToken": "string"
}
```

## 回應元素
<a name="API_ListBackupJobSummaries_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [AggregationPeriod](#API_ListBackupJobSummaries_ResponseSyntax) **   <a name="Backup-ListBackupJobSummaries-response-AggregationPeriod"></a>
傳回結果的期間。  
+  `ONE_DAY` - 過去 14 天的每日任務計數。
+  `SEVEN_DAYS` - 過去 7 天的彙總任務計數。
+  `FOURTEEN_DAYS` - 過去 14 天的彙總任務計數。
類型：字串

 ** [BackupJobSummaries](#API_ListBackupJobSummaries_ResponseSyntax) **   <a name="Backup-ListBackupJobSummaries-response-BackupJobSummaries"></a>
摘要資訊。  
類型：[BackupJobSummary](API_BackupJobSummary.md) 物件陣列

 ** [NextToken](#API_ListBackupJobSummaries_ResponseSyntax) **   <a name="Backup-ListBackupJobSummaries-response-NextToken"></a>
所傳回資源部分清單之後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的資源，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。  
類型：字串

## 錯誤
<a name="API_ListBackupJobSummaries_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListBackupJobSummaries_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListBackupJobSummaries) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListBackupJobSummaries) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListBackupJobSummaries) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListBackupJobSummaries) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListBackupJobSummaries) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListBackupJobSummaries) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListBackupJobSummaries) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListBackupJobSummaries) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListBackupJobSummaries) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListBackupJobSummaries) 

# ListBackupPlans
<a name="API_ListBackupPlans"></a>

列出帳戶的作用中備份計劃。

## 請求語法
<a name="API_ListBackupPlans_RequestSyntax"></a>

```
GET /backup/plans/?includeDeleted=IncludeDeleted&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI 請求參數
<a name="API_ListBackupPlans_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [IncludeDeleted](#API_ListBackupPlans_RequestSyntax) **   <a name="Backup-ListBackupPlans-request-uri-IncludeDeleted"></a>
預設值為 `FALSE` 的布林值，當設為 `TRUE` 時，會傳回已刪除的備份計畫。

 ** [MaxResults](#API_ListBackupPlans_RequestSyntax) **   <a name="Backup-ListBackupPlans-request-uri-MaxResults"></a>
所要傳回的項目數量上限。  
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListBackupPlans_RequestSyntax) **   <a name="Backup-ListBackupPlans-request-uri-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。

## 請求主體
<a name="API_ListBackupPlans_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListBackupPlans_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "BackupPlansList": [ 
      { 
         "AdvancedBackupSettings": [ 
            { 
               "BackupOptions": { 
                  "string" : "string" 
               },
               "ResourceType": "string"
            }
         ],
         "BackupPlanArn": "string",
         "BackupPlanId": "string",
         "BackupPlanName": "string",
         "CreationDate": number,
         "CreatorRequestId": "string",
         "DeletionDate": number,
         "LastExecutionDate": number,
         "VersionId": "string"
      }
   ],
   "NextToken": "string"
}
```

## 回應元素
<a name="API_ListBackupPlans_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [BackupPlansList](#API_ListBackupPlans_ResponseSyntax) **   <a name="Backup-ListBackupPlans-response-BackupPlansList"></a>
備份計畫的相關資訊。  
類型：[BackupPlansListMember](API_BackupPlansListMember.md) 物件陣列

 ** [NextToken](#API_ListBackupPlans_ResponseSyntax) **   <a name="Backup-ListBackupPlans-response-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。  
類型：字串

## 錯誤
<a name="API_ListBackupPlans_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListBackupPlans_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListBackupPlans) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListBackupPlans) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListBackupPlans) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListBackupPlans) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListBackupPlans) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListBackupPlans) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListBackupPlans) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListBackupPlans) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListBackupPlans) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListBackupPlans) 

# ListBackupPlanTemplates
<a name="API_ListBackupPlanTemplates"></a>

列出備份計劃範本。

## 請求語法
<a name="API_ListBackupPlanTemplates_RequestSyntax"></a>

```
GET /backup/template/plans?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI 請求參數
<a name="API_ListBackupPlanTemplates_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [MaxResults](#API_ListBackupPlanTemplates_RequestSyntax) **   <a name="Backup-ListBackupPlanTemplates-request-uri-MaxResults"></a>
要傳回的項目數量上限。  
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListBackupPlanTemplates_RequestSyntax) **   <a name="Backup-ListBackupPlanTemplates-request-uri-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。

## 請求主體
<a name="API_ListBackupPlanTemplates_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListBackupPlanTemplates_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "BackupPlanTemplatesList": [ 
      { 
         "BackupPlanTemplateId": "string",
         "BackupPlanTemplateName": "string"
      }
   ],
   "NextToken": "string"
}
```

## 回應元素
<a name="API_ListBackupPlanTemplates_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [BackupPlanTemplatesList](#API_ListBackupPlanTemplates_ResponseSyntax) **   <a name="Backup-ListBackupPlanTemplates-response-BackupPlanTemplatesList"></a>
一系列範本清單項目，其中包含已儲存範本的中繼資料。  
類型：[BackupPlanTemplatesListMember](API_BackupPlanTemplatesListMember.md) 物件陣列

 ** [NextToken](#API_ListBackupPlanTemplates_ResponseSyntax) **   <a name="Backup-ListBackupPlanTemplates-response-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。  
類型：字串

## 錯誤
<a name="API_ListBackupPlanTemplates_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListBackupPlanTemplates_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListBackupPlanTemplates) 

# ListBackupPlanVersions
<a name="API_ListBackupPlanVersions"></a>

傳回備份計畫的版本中繼資料，包括 Amazon Resource Name (ARN)、備份計畫 ID、建立和刪除日期、計畫名稱和版本 ID。

## 請求語法
<a name="API_ListBackupPlanVersions_RequestSyntax"></a>

```
GET /backup/plans/backupPlanId/versions/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI 請求參數
<a name="API_ListBackupPlanVersions_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [backupPlanId](#API_ListBackupPlanVersions_RequestSyntax) **   <a name="Backup-ListBackupPlanVersions-request-uri-BackupPlanId"></a>
唯一識別備份計畫。  
必要：是

 ** [MaxResults](#API_ListBackupPlanVersions_RequestSyntax) **   <a name="Backup-ListBackupPlanVersions-request-uri-MaxResults"></a>
所要傳回的項目數量上限。  
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListBackupPlanVersions_RequestSyntax) **   <a name="Backup-ListBackupPlanVersions-request-uri-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。

## 請求主體
<a name="API_ListBackupPlanVersions_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListBackupPlanVersions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "BackupPlanVersionsList": [ 
      { 
         "AdvancedBackupSettings": [ 
            { 
               "BackupOptions": { 
                  "string" : "string" 
               },
               "ResourceType": "string"
            }
         ],
         "BackupPlanArn": "string",
         "BackupPlanId": "string",
         "BackupPlanName": "string",
         "CreationDate": number,
         "CreatorRequestId": "string",
         "DeletionDate": number,
         "LastExecutionDate": number,
         "VersionId": "string"
      }
   ],
   "NextToken": "string"
}
```

## 回應元素
<a name="API_ListBackupPlanVersions_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [BackupPlanVersionsList](#API_ListBackupPlanVersions_ResponseSyntax) **   <a name="Backup-ListBackupPlanVersions-response-BackupPlanVersionsList"></a>
包含備份計畫中繼資料的一系列版本清單項目。  
類型：[BackupPlansListMember](API_BackupPlansListMember.md) 物件陣列

 ** [NextToken](#API_ListBackupPlanVersions_ResponseSyntax) **   <a name="Backup-ListBackupPlanVersions-response-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。  
類型：字串

## 錯誤
<a name="API_ListBackupPlanVersions_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListBackupPlanVersions_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListBackupPlanVersions) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListBackupPlanVersions) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListBackupPlanVersions) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListBackupPlanVersions) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListBackupPlanVersions) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListBackupPlanVersions) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListBackupPlanVersions) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListBackupPlanVersions) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListBackupPlanVersions) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListBackupPlanVersions) 

# ListBackupSelections
<a name="API_ListBackupSelections"></a>

傳回包含與目標備份計劃相關聯之資源中繼資料的陣列。

## 請求語法
<a name="API_ListBackupSelections_RequestSyntax"></a>

```
GET /backup/plans/backupPlanId/selections/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI 請求參數
<a name="API_ListBackupSelections_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [backupPlanId](#API_ListBackupSelections_RequestSyntax) **   <a name="Backup-ListBackupSelections-request-uri-BackupPlanId"></a>
唯一識別備份計畫。  
必要：是

 ** [MaxResults](#API_ListBackupSelections_RequestSyntax) **   <a name="Backup-ListBackupSelections-request-uri-MaxResults"></a>
所要傳回的項目數量上限。  
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListBackupSelections_RequestSyntax) **   <a name="Backup-ListBackupSelections-request-uri-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。

## 請求主體
<a name="API_ListBackupSelections_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListBackupSelections_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "BackupSelectionsList": [ 
      { 
         "BackupPlanId": "string",
         "CreationDate": number,
         "CreatorRequestId": "string",
         "IamRoleArn": "string",
         "SelectionId": "string",
         "SelectionName": "string"
      }
   ],
   "NextToken": "string"
}
```

## 回應元素
<a name="API_ListBackupSelections_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [BackupSelectionsList](#API_ListBackupSelections_ResponseSyntax) **   <a name="Backup-ListBackupSelections-response-BackupSelectionsList"></a>
備份選擇清單項目的陣列，其中包含清單中每個資源的中繼資料。  
類型：[BackupSelectionsListMember](API_BackupSelectionsListMember.md) 物件陣列

 ** [NextToken](#API_ListBackupSelections_ResponseSyntax) **   <a name="Backup-ListBackupSelections-response-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。  
類型：字串

## 錯誤
<a name="API_ListBackupSelections_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListBackupSelections_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListBackupSelections) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListBackupSelections) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListBackupSelections) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListBackupSelections) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListBackupSelections) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListBackupSelections) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListBackupSelections) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListBackupSelections) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListBackupSelections) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListBackupSelections) 

# ListBackupVaults
<a name="API_ListBackupVaults"></a>

傳回復原點儲存體容器的清單及其相關資訊。

## 請求語法
<a name="API_ListBackupVaults_RequestSyntax"></a>

```
GET /backup-vaults/?maxResults=MaxResults&nextToken=NextToken&shared=ByShared&vaultType=ByVaultType HTTP/1.1
```

## URI 請求參數
<a name="API_ListBackupVaults_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [ByShared](#API_ListBackupVaults_RequestSyntax) **   <a name="Backup-ListBackupVaults-request-uri-ByShared"></a>
此參數將依共用保存庫，對保存庫清單進行排序。

 ** [ByVaultType](#API_ListBackupVaults_RequestSyntax) **   <a name="Backup-ListBackupVaults-request-uri-ByVaultType"></a>
此參數將依保存庫類型，對保存庫清單進行排序。  
有效值:`BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT | RESTORE_ACCESS_BACKUP_VAULT` 

 ** [MaxResults](#API_ListBackupVaults_RequestSyntax) **   <a name="Backup-ListBackupVaults-request-uri-MaxResults"></a>
所要傳回的項目數量上限。  
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListBackupVaults_RequestSyntax) **   <a name="Backup-ListBackupVaults-request-uri-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。

## 請求主體
<a name="API_ListBackupVaults_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListBackupVaults_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "BackupVaultList": [ 
      { 
         "BackupVaultArn": "string",
         "BackupVaultName": "string",
         "CreationDate": number,
         "CreatorRequestId": "string",
         "EncryptionKeyArn": "string",
         "EncryptionKeyType": "string",
         "LockDate": number,
         "Locked": boolean,
         "MaxRetentionDays": number,
         "MinRetentionDays": number,
         "NumberOfRecoveryPoints": number,
         "VaultState": "string",
         "VaultType": "string"
      }
   ],
   "NextToken": "string"
}
```

## 回應元素
<a name="API_ListBackupVaults_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [BackupVaultList](#API_ListBackupVaults_ResponseSyntax) **   <a name="Backup-ListBackupVaults-response-BackupVaultList"></a>
一系列包含保存庫中繼資料的備份保存庫清單成員，包括 Amazon Resource Name (ARN)、顯示名稱、建立日期、儲存的復原點數量，以及加密資訊 (如果儲存在備份保存庫中的資源已加密)。  
類型：[BackupVaultListMember](API_BackupVaultListMember.md) 物件陣列

 ** [NextToken](#API_ListBackupVaults_ResponseSyntax) **   <a name="Backup-ListBackupVaults-response-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。  
類型：字串

## 錯誤
<a name="API_ListBackupVaults_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListBackupVaults_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListBackupVaults) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListBackupVaults) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListBackupVaults) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListBackupVaults) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListBackupVaults) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListBackupVaults) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListBackupVaults) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListBackupVaults) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListBackupVaults) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListBackupVaults) 

# ListCopyJobs
<a name="API_ListCopyJobs"></a>

傳回複製任務的相關中繼資料。

## 請求語法
<a name="API_ListCopyJobs_RequestSyntax"></a>

```
GET /copy-jobs/?accountId=ByAccountId&completeAfter=ByCompleteAfter&completeBefore=ByCompleteBefore&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&destinationVaultArn=ByDestinationVaultArn&maxResults=MaxResults&messageCategory=ByMessageCategory&nextToken=NextToken&parentJobId=ByParentJobId&resourceArn=ByResourceArn&resourceType=ByResourceType&sourceRecoveryPointArn=BySourceRecoveryPointArn&state=ByState HTTP/1.1
```

## URI 請求參數
<a name="API_ListCopyJobs_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [ByAccountId](#API_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-request-uri-ByAccountId"></a>
要列出任務的帳戶 ID。僅傳回與指定帳戶 ID 相關聯的複製任務。  
模式：`^[0-9]{12}$`

 ** [ByCompleteAfter](#API_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-request-uri-ByCompleteAfter"></a>
僅傳回以 Unix 格式和國際標準時間 (UTC) 所表示日期之後完成的複製任務。

 ** [ByCompleteBefore](#API_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-request-uri-ByCompleteBefore"></a>
僅傳回以 Unix 格式和國際標準時間 (UTC) 所表示日期之前完成的複製任務。

 ** [ByCreatedAfter](#API_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-request-uri-ByCreatedAfter"></a>
僅傳回特定日期之後建立的複製任務。

 ** [ByCreatedBefore](#API_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-request-uri-ByCreatedBefore"></a>
僅傳回特定日期之前建立的複製任務。

 ** [ByDestinationVaultArn](#API_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-request-uri-ByDestinationVaultArn"></a>
可唯一識別要複製之來源備份保存庫的 Amazon Resource Name (ARN)，例如 `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`。

 ** [ByMessageCategory](#API_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-request-uri-ByMessageCategory"></a>
這是選用參數，可用於透過與您輸入之值相符的 MessageCategory 來篩選任務。  
範例字串可能包括 `AccessDenied`、`SUCCESS`、`AGGREGATE_ALL` 和 `INVALIDPARAMETERS`。  
檢視[監控](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html)以取得接受的字串清單。  
該值 ANY 會傳回所有訊息類別的計數。  
 `AGGREGATE_ALL` 彙總所有訊息類別的任務計數，並傳回總和。

 ** [ByParentJobId](#API_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-request-uri-ByParentJobId"></a>
這是根據父系任務 ID 列出子 (巢狀) 任務的篩選器。

 ** [ByResourceArn](#API_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-request-uri-ByResourceArn"></a>
僅傳回符合特定資源 Amazon Resource Name (ARN) 的複製任務。

 ** [ByResourceType](#API_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-request-uri-ByResourceType"></a>
僅傳回指定資源的備份任務：  
+  `Aurora` 代表 Amazon Aurora
+  `CloudFormation` 適用於 的 AWS CloudFormation 
+  `DocumentDB` 代表 Amazon DocumentDB (with MongoDB compatibility)
+  `DynamoDB` 代表 Amazon DynamoDB
+  `EBS` 代表 Amazon Elastic Block Store
+  `EC2` 代表 Amazon Elastic Compute Cloud
+  `EFS` 代表 Amazon Elastic File System
+  `EKS` for Amazon Elastic Kubernetes Service
+  `FSx` 代表 Amazon FSx
+  `Neptune` 代表 Amazon Neptune
+  `RDS` 代表 Amazon Relational Database Service
+  `Redshift` 代表 Amazon Redshift
+  `S3` for Amazon Simple Storage Service (Amazon S3)
+  `SAP HANA on Amazon EC2` 適用於 Amazon Elastic Compute Cloud 執行個體上的 SAP HANA 資料庫
+  `Storage Gateway` 適用於 的 AWS Storage Gateway 
+  `Timestream` 代表 Amazon Timestream
+  `VirtualMachine` 適用於 VMware 虛擬機器
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`

 ** [BySourceRecoveryPointArn](#API_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-request-uri-BySourceRecoveryPointArn"></a>
依指定的來源復原點 ARN 篩選複製任務。

 ** [ByState](#API_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-request-uri-ByState"></a>
僅傳回處於指定狀態的複製任務。  
有效值:`CREATED | RUNNING | COMPLETED | FAILED | PARTIAL` 

 ** [MaxResults](#API_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-request-uri-MaxResults"></a>
所要傳回的項目數量上限。  
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-request-uri-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 MaxResults 個數量的項目，則 NextToken 允許您從下一個字符指向的位置開始傳回清單中的更多項目。

## 請求主體
<a name="API_ListCopyJobs_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListCopyJobs_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CopyJobs": [ 
      { 
         "AccountId": "string",
         "BackupSizeInBytes": number,
         "ChildJobsInState": { 
            "string" : number 
         },
         "CompletionDate": number,
         "CompositeMemberIdentifier": "string",
         "CopyJobId": "string",
         "CreatedBy": { 
            "BackupPlanArn": "string",
            "BackupPlanId": "string",
            "BackupPlanName": "string",
            "BackupPlanVersion": "string",
            "BackupRuleCron": "string",
            "BackupRuleId": "string",
            "BackupRuleName": "string",
            "BackupRuleTimezone": "string"
         },
         "CreatedByBackupJobId": "string",
         "CreationDate": number,
         "DestinationBackupVaultArn": "string",
         "DestinationEncryptionKeyArn": "string",
         "DestinationRecoveryPointArn": "string",
         "DestinationRecoveryPointLifecycle": { 
            "DeleteAfterDays": number,
            "DeleteAfterEvent": "string",
            "MoveToColdStorageAfterDays": number,
            "OptInToArchiveForSupportedResources": boolean
         },
         "DestinationVaultLockState": "string",
         "DestinationVaultType": "string",
         "IamRoleArn": "string",
         "IsParent": boolean,
         "MessageCategory": "string",
         "NumberOfChildJobs": number,
         "ParentJobId": "string",
         "ResourceArn": "string",
         "ResourceName": "string",
         "ResourceType": "string",
         "SourceBackupVaultArn": "string",
         "SourceRecoveryPointArn": "string",
         "State": "string",
         "StatusMessage": "string"
      }
   ],
   "NextToken": "string"
}
```

## 回應元素
<a name="API_ListCopyJobs_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [CopyJobs](#API_ListCopyJobs_ResponseSyntax) **   <a name="Backup-ListCopyJobs-response-CopyJobs"></a>
結構陣列，其中包含以 JSON 格式傳回的複製任務相關中繼資料。  
類型：[CopyJob](API_CopyJob.md) 物件陣列

 ** [NextToken](#API_ListCopyJobs_ResponseSyntax) **   <a name="Backup-ListCopyJobs-response-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 MaxResults 個數量的項目，則 NextToken 允許您從下一個字符指向的位置開始傳回清單中的更多項目。  
類型：字串

## 錯誤
<a name="API_ListCopyJobs_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListCopyJobs_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListCopyJobs) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListCopyJobs) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListCopyJobs) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListCopyJobs) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListCopyJobs) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListCopyJobs) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListCopyJobs) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListCopyJobs) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListCopyJobs) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListCopyJobs) 

# ListCopyJobSummaries
<a name="API_ListCopyJobSummaries"></a>

此請求會取得最近 30 天內建立或執行的複製任務清單。您可以包括參數 AccountID、State、ResourceType、MessageCategory、AggregationPeriod、MaxResults 或 NextToken 來篩選結果。

此請求傳回的摘要包含 Region、Account，State、RestourceType、MessageCategory、StartTime、EndTime 和包含任務的計數。

## 請求語法
<a name="API_ListCopyJobSummaries_RequestSyntax"></a>

```
GET /audit/copy-job-summaries?AccountId=AccountId&AggregationPeriod=AggregationPeriod&MaxResults=MaxResults&MessageCategory=MessageCategory&NextToken=NextToken&ResourceType=ResourceType&State=State HTTP/1.1
```

## URI 請求參數
<a name="API_ListCopyJobSummaries_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [AccountId](#API_ListCopyJobSummaries_RequestSyntax) **   <a name="Backup-ListCopyJobSummaries-request-uri-AccountId"></a>
傳回指定帳戶的任務計數。  
如果請求是從成員帳戶或不屬於 AWS Organizations 的帳戶傳送，則會傳回請求者帳戶中的任務。  
根、管理員和委派管理員帳戶可以使用 ANY 值，傳回組織中每個帳戶的任務計數。  
 `AGGREGATE_ALL` 彙總已驗證組織內所有帳戶的任務計數，然後傳回總和。  
模式：`^[0-9]{12}$`

 ** [AggregationPeriod](#API_ListCopyJobSummaries_RequestSyntax) **   <a name="Backup-ListCopyJobSummaries-request-uri-AggregationPeriod"></a>
傳回結果的期間。  
+  `ONE_DAY` - 過去 14 天的每日任務計數。
+  `SEVEN_DAYS` - 過去 7 天的彙總任務計數。
+  `FOURTEEN_DAYS` - 過去 14 天的彙總任務計數。
有效值:`ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS` 

 ** [MaxResults](#API_ListCopyJobSummaries_RequestSyntax) **   <a name="Backup-ListCopyJobSummaries-request-uri-MaxResults"></a>
此參數會設定要傳回的項目數量上限。  
值是整數。可接受值的範圍是從 1 到 500。  
有效範圍：最小值為 1。最大值為 1000。

 ** [MessageCategory](#API_ListCopyJobSummaries_RequestSyntax) **   <a name="Backup-ListCopyJobSummaries-request-uri-MessageCategory"></a>
此參數會傳回指定訊息類別的任務計數。  
接受的字串範例包括 `AccessDenied`、`Success` 和 `InvalidParameters`。請參閱[監控](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html)以取得接受的 MessageCategory 字串清單。  
該值 ANY 會傳回所有訊息類別的計數。  
 `AGGREGATE_ALL` 彙總所有訊息類別的任務計數，並傳回總和。

 ** [NextToken](#API_ListCopyJobSummaries_RequestSyntax) **   <a name="Backup-ListCopyJobSummaries-request-uri-NextToken"></a>
所傳回資源部分清單之後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的資源，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。

 ** [ResourceType](#API_ListCopyJobSummaries_RequestSyntax) **   <a name="Backup-ListCopyJobSummaries-request-uri-ResourceType"></a>
傳回指定資源類型的任務計數。使用請求 `GetSupportedResourceTypes` 取得支援資源類型的字串。  
該值 ANY 會傳回所有資源類型的計數。  
 `AGGREGATE_ALL` 彙總所有資源類型的任務計數，並傳回總和。  
要備份 AWS 的資源類型；例如，Amazon Elastic Block Store (Amazon EBS) 磁碟區或 Amazon Relational Database Service (Amazon RDS) 資料庫。  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`

 ** [State](#API_ListCopyJobSummaries_RequestSyntax) **   <a name="Backup-ListCopyJobSummaries-request-uri-State"></a>
此參數會傳回具有指定狀態之任務的任務計數。  
該值 ANY 會傳回所有狀態的計數。  
 `AGGREGATE_ALL` 彙總所有狀態的任務計數，並傳回總和。  
有效值:`CREATED | RUNNING | ABORTING | ABORTED | COMPLETING | COMPLETED | FAILING | FAILED | PARTIAL | AGGREGATE_ALL | ANY` 

## 請求主體
<a name="API_ListCopyJobSummaries_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListCopyJobSummaries_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AggregationPeriod": "string",
   "CopyJobSummaries": [ 
      { 
         "AccountId": "string",
         "Count": number,
         "EndTime": number,
         "MessageCategory": "string",
         "Region": "string",
         "ResourceType": "string",
         "StartTime": number,
         "State": "string"
      }
   ],
   "NextToken": "string"
}
```

## 回應元素
<a name="API_ListCopyJobSummaries_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [AggregationPeriod](#API_ListCopyJobSummaries_ResponseSyntax) **   <a name="Backup-ListCopyJobSummaries-response-AggregationPeriod"></a>
傳回結果的期間。  
+  `ONE_DAY` - 過去 14 天的每日任務計數。
+  `SEVEN_DAYS` - 過去 7 天的彙總任務計數。
+  `FOURTEEN_DAYS` - 過去 14 天的彙總任務計數。
類型：字串

 ** [CopyJobSummaries](#API_ListCopyJobSummaries_ResponseSyntax) **   <a name="Backup-ListCopyJobSummaries-response-CopyJobSummaries"></a>
此請求顯示的摘要包含 Region、Account，State、ResourceType、MessageCategory、StartTime、EndTime 和包含任務的計數。  
類型：[CopyJobSummary](API_CopyJobSummary.md) 物件陣列

 ** [NextToken](#API_ListCopyJobSummaries_ResponseSyntax) **   <a name="Backup-ListCopyJobSummaries-response-NextToken"></a>
所傳回資源部分清單之後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的資源，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。  
類型：字串

## 錯誤
<a name="API_ListCopyJobSummaries_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListCopyJobSummaries_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListCopyJobSummaries) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListCopyJobSummaries) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListCopyJobSummaries) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListCopyJobSummaries) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListCopyJobSummaries) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListCopyJobSummaries) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListCopyJobSummaries) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListCopyJobSummaries) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListCopyJobSummaries) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListCopyJobSummaries) 

# ListFrameworks
<a name="API_ListFrameworks"></a>

傳回 AWS 帳戶 和 的所有架構清單 AWS 區域。

## 請求語法
<a name="API_ListFrameworks_RequestSyntax"></a>

```
GET /audit/frameworks?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```

## URI 請求參數
<a name="API_ListFrameworks_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [MaxResults](#API_ListFrameworks_RequestSyntax) **   <a name="Backup-ListFrameworks-request-uri-MaxResults"></a>
從 1 到 1000 的期望結果數量。選用。如果未指定，查詢將傳回 1 MB 的資料。  
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListFrameworks_RequestSyntax) **   <a name="Backup-ListFrameworks-request-uri-NextToken"></a>
從上一次呼叫此操作傳回的識別符，可用來傳回清單中的下一組項目。

## 請求主體
<a name="API_ListFrameworks_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListFrameworks_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Frameworks": [ 
      { 
         "CreationTime": number,
         "DeploymentStatus": "string",
         "FrameworkArn": "string",
         "FrameworkDescription": "string",
         "FrameworkName": "string",
         "NumberOfControls": number
      }
   ],
   "NextToken": "string"
}
```

## 回應元素
<a name="API_ListFrameworks_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [Frameworks](#API_ListFrameworks_ResponseSyntax) **   <a name="Backup-ListFrameworks-response-Frameworks"></a>
包含每個架構詳細資訊的架構，包括架構名稱、Amazon Resource Name (ARN)、描述、控制項數量、建立時間和部署狀態。  
類型：[Framework](API_Framework.md) 物件陣列

 ** [NextToken](#API_ListFrameworks_ResponseSyntax) **   <a name="Backup-ListFrameworks-response-NextToken"></a>
從上一次呼叫此操作傳回的識別符，可用來傳回清單中的下一組項目。  
類型：字串

## 錯誤
<a name="API_ListFrameworks_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListFrameworks_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListFrameworks) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListFrameworks) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListFrameworks) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListFrameworks) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListFrameworks) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListFrameworks) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListFrameworks) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListFrameworks) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListFrameworks) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListFrameworks) 

# ListIndexedRecoveryPoints
<a name="API_ListIndexedRecoveryPoints"></a>

此操作會傳回具有關聯索引的復原點清單，該索引屬於指定的帳戶。

您可以包含的選用參數包括：MaxResults；NextToken；SourceResourceArns；CreatedBefore；CreatedAfter；以及 ResourceType。

## 請求語法
<a name="API_ListIndexedRecoveryPoints_RequestSyntax"></a>

```
GET /indexes/recovery-point/?createdAfter=CreatedAfter&createdBefore=CreatedBefore&indexStatus=IndexStatus&maxResults=MaxResults&nextToken=NextToken&resourceType=ResourceType&sourceResourceArn=SourceResourceArn HTTP/1.1
```

## URI 請求參數
<a name="API_ListIndexedRecoveryPoints_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [CreatedAfter](#API_ListIndexedRecoveryPoints_RequestSyntax) **   <a name="Backup-ListIndexedRecoveryPoints-request-uri-CreatedAfter"></a>
僅傳回指定日期之後建立的索引復原點。

 ** [CreatedBefore](#API_ListIndexedRecoveryPoints_RequestSyntax) **   <a name="Backup-ListIndexedRecoveryPoints-request-uri-CreatedBefore"></a>
僅傳回指定日期之前建立的索引復原點。

 ** [IndexStatus](#API_ListIndexedRecoveryPoints_RequestSyntax) **   <a name="Backup-ListIndexedRecoveryPoints-request-uri-IndexStatus"></a>
包含此參數，依指示的狀態篩選傳回的清單。  
接受的值： `PENDING` \$1 `ACTIVE` \$1 `FAILED` \$1 `DELETING`   
索引狀態為 的復原點`ACTIVE`可以包含在搜尋中。  
有效值:`PENDING | ACTIVE | FAILED | DELETING` 

 ** [MaxResults](#API_ListIndexedRecoveryPoints_RequestSyntax) **   <a name="Backup-ListIndexedRecoveryPoints-request-uri-MaxResults"></a>
要傳回的資源清單項目最大數量。  
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListIndexedRecoveryPoints_RequestSyntax) **   <a name="Backup-ListIndexedRecoveryPoints-request-uri-NextToken"></a>
傳回復原點的部分清單之後的下一個項目。  
例如，如果請求傳回索引復原點`MaxResults`的數量， `NextToken`可讓您從下一個字符指向的位置開始傳回清單中的更多項目。

 ** [ResourceType](#API_ListIndexedRecoveryPoints_RequestSyntax) **   <a name="Backup-ListIndexedRecoveryPoints-request-uri-ResourceType"></a>
傳回指定資源類型的索引復原點清單 ()。  
接受的值包括：  
+  `EBS` 代表 Amazon Elastic Block Store
+  `S3` for Amazon Simple Storage Service (Amazon S3)
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`

 ** [SourceResourceArn](#API_ListIndexedRecoveryPoints_RequestSyntax) **   <a name="Backup-ListIndexedRecoveryPoints-request-uri-SourceResourceArn"></a>
可唯一識別來源資源的 Amazon Resource Name (ARN) 字串。

## 請求主體
<a name="API_ListIndexedRecoveryPoints_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListIndexedRecoveryPoints_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "IndexedRecoveryPoints": [ 
      { 
         "BackupCreationDate": number,
         "BackupVaultArn": "string",
         "IamRoleArn": "string",
         "IndexCreationDate": number,
         "IndexStatus": "string",
         "IndexStatusMessage": "string",
         "RecoveryPointArn": "string",
         "ResourceType": "string",
         "SourceResourceArn": "string"
      }
   ],
   "NextToken": "string"
}
```

## 回應元素
<a name="API_ListIndexedRecoveryPoints_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [IndexedRecoveryPoints](#API_ListIndexedRecoveryPoints_ResponseSyntax) **   <a name="Backup-ListIndexedRecoveryPoints-response-IndexedRecoveryPoints"></a>
這是具有關聯索引的復原點清單，屬於指定的帳戶。  
類型：[IndexedRecoveryPoint](API_IndexedRecoveryPoint.md) 物件陣列

 ** [NextToken](#API_ListIndexedRecoveryPoints_ResponseSyntax) **   <a name="Backup-ListIndexedRecoveryPoints-response-NextToken"></a>
傳回復原點的部分清單之後的下一個項目。  
例如，如果請求傳回索引復原點`MaxResults`的數量， `NextToken`可讓您從下一個字符指向的位置開始傳回清單中的更多項目。  
類型：字串

## 錯誤
<a name="API_ListIndexedRecoveryPoints_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListIndexedRecoveryPoints_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListIndexedRecoveryPoints) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListIndexedRecoveryPoints) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListIndexedRecoveryPoints) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListIndexedRecoveryPoints) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListIndexedRecoveryPoints) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListIndexedRecoveryPoints) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListIndexedRecoveryPoints) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListIndexedRecoveryPoints) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListIndexedRecoveryPoints) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListIndexedRecoveryPoints) 

# ListLegalHolds
<a name="API_ListLegalHolds"></a>

此動作會傳回與作用中和先前法務保存有關的中繼資料。

## 請求語法
<a name="API_ListLegalHolds_RequestSyntax"></a>

```
GET /legal-holds/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI 請求參數
<a name="API_ListLegalHolds_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [MaxResults](#API_ListLegalHolds_RequestSyntax) **   <a name="Backup-ListLegalHolds-request-uri-MaxResults"></a>
要傳回的資源清單項目最大數量。  
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListLegalHolds_RequestSyntax) **   <a name="Backup-ListLegalHolds-request-uri-NextToken"></a>
所傳回資源部分清單之後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的資源，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。

## 請求主體
<a name="API_ListLegalHolds_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListLegalHolds_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "LegalHolds": [ 
      { 
         "CancellationDate": number,
         "CreationDate": number,
         "Description": "string",
         "LegalHoldArn": "string",
         "LegalHoldId": "string",
         "Status": "string",
         "Title": "string"
      }
   ],
   "NextToken": "string"
}
```

## 回應元素
<a name="API_ListLegalHolds_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [LegalHolds](#API_ListLegalHolds_ResponseSyntax) **   <a name="Backup-ListLegalHolds-response-LegalHolds"></a>
這是傳回的法務保存陣列，包括作用中和先前的法務保存。  
類型：[LegalHold](API_LegalHold.md) 物件陣列

 ** [NextToken](#API_ListLegalHolds_ResponseSyntax) **   <a name="Backup-ListLegalHolds-response-NextToken"></a>
所傳回資源部分清單之後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的資源，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。  
類型：字串

## 錯誤
<a name="API_ListLegalHolds_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListLegalHolds_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListLegalHolds) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListLegalHolds) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListLegalHolds) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListLegalHolds) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListLegalHolds) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListLegalHolds) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListLegalHolds) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListLegalHolds) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListLegalHolds) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListLegalHolds) 

# ListProtectedResources
<a name="API_ListProtectedResources"></a>

傳回 資源陣列，其中包含由 AWS Backup 建立的復原點 （無論復原點[的狀態](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_DescribeRecoveryPoint.html#Backup-DescribeRecoveryPoint-response-Status)為何），包括資源的儲存時間、資源的 Amazon Resource Name (ARN)，以及資源類型。

## 請求語法
<a name="API_ListProtectedResources_RequestSyntax"></a>

```
GET /resources/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI 請求參數
<a name="API_ListProtectedResources_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [MaxResults](#API_ListProtectedResources_RequestSyntax) **   <a name="Backup-ListProtectedResources-request-uri-MaxResults"></a>
所要傳回的項目數量上限。  
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListProtectedResources_RequestSyntax) **   <a name="Backup-ListProtectedResources-request-uri-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。

## 請求主體
<a name="API_ListProtectedResources_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListProtectedResources_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Results": [ 
      { 
         "LastBackupTime": number,
         "LastBackupVaultArn": "string",
         "LastRecoveryPointArn": "string",
         "ResourceArn": "string",
         "ResourceName": "string",
         "ResourceType": "string"
      }
   ]
}
```

## 回應元素
<a name="API_ListProtectedResources_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [NextToken](#API_ListProtectedResources_ResponseSyntax) **   <a name="Backup-ListProtectedResources-response-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。  
類型：字串

 ** [Results](#API_ListProtectedResources_ResponseSyntax) **   <a name="Backup-ListProtectedResources-response-Results"></a>
透過 AWS Backup 包含資源的儲存時間、資源的 Amazon Resource Name (ARN) 和資源類型，成功備份資源的陣列。  
類型：[ProtectedResource](API_ProtectedResource.md) 物件陣列

## 錯誤
<a name="API_ListProtectedResources_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListProtectedResources_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListProtectedResources) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListProtectedResources) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListProtectedResources) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListProtectedResources) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListProtectedResources) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListProtectedResources) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListProtectedResources) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListProtectedResources) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListProtectedResources) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListProtectedResources) 

# ListProtectedResourcesByBackupVault
<a name="API_ListProtectedResourcesByBackupVault"></a>

此請求會列出與每個備份保存庫對應的受保護資源。

## 請求語法
<a name="API_ListProtectedResourcesByBackupVault_RequestSyntax"></a>

```
GET /backup-vaults/backupVaultName/resources/?backupVaultAccountId=BackupVaultAccountId&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI 請求參數
<a name="API_ListProtectedResourcesByBackupVault_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [BackupVaultAccountId](#API_ListProtectedResourcesByBackupVault_RequestSyntax) **   <a name="Backup-ListProtectedResourcesByBackupVault-request-uri-BackupVaultAccountId"></a>
您依帳戶 ID 指定之保存庫內的備份保存庫的受保護資源清單 （備份保存庫）。  
模式：`^[0-9]{12}$`

 ** [backupVaultName](#API_ListProtectedResourcesByBackupVault_RequestSyntax) **   <a name="Backup-ListProtectedResourcesByBackupVault-request-uri-BackupVaultName"></a>
在您依名稱指定的保存庫中，備份保存庫的受保護資源清單 （備份保存庫）。  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必要：是

 ** [MaxResults](#API_ListProtectedResourcesByBackupVault_RequestSyntax) **   <a name="Backup-ListProtectedResourcesByBackupVault-request-uri-MaxResults"></a>
所要傳回的項目數量上限。  
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListProtectedResourcesByBackupVault_RequestSyntax) **   <a name="Backup-ListProtectedResourcesByBackupVault-request-uri-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。

## 請求主體
<a name="API_ListProtectedResourcesByBackupVault_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListProtectedResourcesByBackupVault_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Results": [ 
      { 
         "LastBackupTime": number,
         "LastBackupVaultArn": "string",
         "LastRecoveryPointArn": "string",
         "ResourceArn": "string",
         "ResourceName": "string",
         "ResourceType": "string"
      }
   ]
}
```

## 回應元素
<a name="API_ListProtectedResourcesByBackupVault_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [NextToken](#API_ListProtectedResourcesByBackupVault_ResponseSyntax) **   <a name="Backup-ListProtectedResourcesByBackupVault-response-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。  
類型：字串

 ** [Results](#API_ListProtectedResourcesByBackupVault_ResponseSyntax) **   <a name="Backup-ListProtectedResourcesByBackupVault-response-Results"></a>
這些是針對請求 ListProtectedResourcesByBackupVault 所傳回的結果。  
類型：[ProtectedResource](API_ProtectedResource.md) 物件陣列

## 錯誤
<a name="API_ListProtectedResourcesByBackupVault_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListProtectedResourcesByBackupVault_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListProtectedResourcesByBackupVault) 

# ListRecoveryPointsByBackupVault
<a name="API_ListRecoveryPointsByBackupVault"></a>

傳回儲存在備份保存庫之復原點的詳細資訊。

## 請求語法
<a name="API_ListRecoveryPointsByBackupVault_RequestSyntax"></a>

```
GET /backup-vaults/backupVaultName/recovery-points/?backupPlanId=ByBackupPlanId&backupVaultAccountId=BackupVaultAccountId&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&maxResults=MaxResults&nextToken=NextToken&parentRecoveryPointArn=ByParentRecoveryPointArn&resourceArn=ByResourceArn&resourceType=ByResourceType HTTP/1.1
```

## URI 請求參數
<a name="API_ListRecoveryPointsByBackupVault_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [BackupVaultAccountId](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-request-uri-BackupVaultAccountId"></a>
此參數會依帳戶 ID 排序復原點清單。  
模式：`^[0-9]{12}$`

 ** [backupVaultName](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-request-uri-BackupVaultName"></a>
存放備份的邏輯容器名稱。備份文件庫依名稱識別，這些名稱對建立文件庫的帳戶和 AWS 區域來說是唯一的。  
當受支援的服務建立備份時，備份保存庫名稱可能無法使用。
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必要：是

 ** [ByBackupPlanId](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-request-uri-ByBackupPlanId"></a>
僅傳回符合指定備份計畫 ID 的復原點。

 ** [ByCreatedAfter](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-request-uri-ByCreatedAfter"></a>
僅傳回在指定時間戳記之後建立的復原點。

 ** [ByCreatedBefore](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-request-uri-ByCreatedBefore"></a>
僅傳回在指定時間戳記之前建立的復原點。

 ** [ByParentRecoveryPointArn](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-request-uri-ByParentRecoveryPointArn"></a>
這只會傳回符合指定父系 (複合) 復原點 Amazon Resource Name (ARN) 的復原點。

 ** [ByResourceArn](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-request-uri-ByResourceArn"></a>
僅傳回符合指定資源 Amazon Resource Name (ARN) 的復原點。

 ** [ByResourceType](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-request-uri-ByResourceType"></a>
僅傳回符合指定資源類型的復原點：  
+  `Aurora` 代表 Amazon Aurora
+  `CloudFormation` 適用於 的 AWS CloudFormation 
+  `DocumentDB` 代表 Amazon DocumentDB (with MongoDB compatibility)
+  `DynamoDB` 代表 Amazon DynamoDB
+  `EBS` 代表 Amazon Elastic Block Store
+  `EC2` 代表 Amazon Elastic Compute Cloud
+  `EFS` 代表 Amazon Elastic File System
+  `EKS` for Amazon Elastic Kubernetes Service
+  `FSx` 代表 Amazon FSx
+  `Neptune` 代表 Amazon Neptune
+  `RDS` 代表 Amazon Relational Database Service
+  `Redshift` 代表 Amazon Redshift
+  `S3` for Amazon Simple Storage Service (Amazon S3)
+  `SAP HANA on Amazon EC2` 適用於 Amazon Elastic Compute Cloud 執行個體上的 SAP HANA 資料庫
+  `Storage Gateway` 適用於 的 AWS Storage Gateway 
+  `Timestream` 代表 Amazon Timestream
+  `VirtualMachine` 適用於 VMware 虛擬機器
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`

 ** [MaxResults](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-request-uri-MaxResults"></a>
所要傳回的項目數量上限。  
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-request-uri-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。

## 請求主體
<a name="API_ListRecoveryPointsByBackupVault_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListRecoveryPointsByBackupVault_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "RecoveryPoints": [ 
      { 
         "AggregatedScanResult": { 
            "FailedScan": boolean,
            "Findings": [ "string" ],
            "LastComputed": number
         },
         "BackupSizeInBytes": number,
         "BackupVaultArn": "string",
         "BackupVaultName": "string",
         "CalculatedLifecycle": { 
            "DeleteAt": number,
            "MoveToColdStorageAt": number
         },
         "CompletionDate": number,
         "CompositeMemberIdentifier": "string",
         "CreatedBy": { 
            "BackupPlanArn": "string",
            "BackupPlanId": "string",
            "BackupPlanName": "string",
            "BackupPlanVersion": "string",
            "BackupRuleCron": "string",
            "BackupRuleId": "string",
            "BackupRuleName": "string",
            "BackupRuleTimezone": "string"
         },
         "CreationDate": number,
         "EncryptionKeyArn": "string",
         "EncryptionKeyType": "string",
         "IamRoleArn": "string",
         "IndexStatus": "string",
         "IndexStatusMessage": "string",
         "InitiationDate": number,
         "IsEncrypted": boolean,
         "IsParent": boolean,
         "LastRestoreTime": number,
         "Lifecycle": { 
            "DeleteAfterDays": number,
            "DeleteAfterEvent": "string",
            "MoveToColdStorageAfterDays": number,
            "OptInToArchiveForSupportedResources": boolean
         },
         "ParentRecoveryPointArn": "string",
         "RecoveryPointArn": "string",
         "ResourceArn": "string",
         "ResourceName": "string",
         "ResourceType": "string",
         "SourceBackupVaultArn": "string",
         "Status": "string",
         "StatusMessage": "string",
         "VaultType": "string"
      }
   ]
}
```

## 回應元素
<a name="API_ListRecoveryPointsByBackupVault_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [NextToken](#API_ListRecoveryPointsByBackupVault_ResponseSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-response-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。  
類型：字串

 ** [RecoveryPoints](#API_ListRecoveryPointsByBackupVault_ResponseSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-response-RecoveryPoints"></a>
物件陣列，其中包含儲存在備份保存庫之復原點的詳細資訊。  
類型：[RecoveryPointByBackupVault](API_RecoveryPointByBackupVault.md) 物件陣列

## 錯誤
<a name="API_ListRecoveryPointsByBackupVault_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListRecoveryPointsByBackupVault_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListRecoveryPointsByBackupVault) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListRecoveryPointsByBackupVault) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListRecoveryPointsByBackupVault) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRecoveryPointsByBackupVault) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListRecoveryPointsByBackupVault) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListRecoveryPointsByBackupVault) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListRecoveryPointsByBackupVault) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRecoveryPointsByBackupVault) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListRecoveryPointsByBackupVault) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListRecoveryPointsByBackupVault) 

# ListRecoveryPointsByLegalHold
<a name="API_ListRecoveryPointsByLegalHold"></a>

此動作會傳回指定法務保存的復原點 ARN (Amazon Resource Names)。

## 請求語法
<a name="API_ListRecoveryPointsByLegalHold_RequestSyntax"></a>

```
GET /legal-holds/legalHoldId/recovery-points?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI 請求參數
<a name="API_ListRecoveryPointsByLegalHold_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [legalHoldId](#API_ListRecoveryPointsByLegalHold_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByLegalHold-request-uri-LegalHoldId"></a>
法務保存的 ID。  
必要：是

 ** [MaxResults](#API_ListRecoveryPointsByLegalHold_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByLegalHold-request-uri-MaxResults"></a>
要傳回的資源清單項目最大數量。  
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListRecoveryPointsByLegalHold_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByLegalHold-request-uri-NextToken"></a>
所傳回資源部分清單之後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的資源，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。

## 請求主體
<a name="API_ListRecoveryPointsByLegalHold_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListRecoveryPointsByLegalHold_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "RecoveryPoints": [ 
      { 
         "BackupVaultName": "string",
         "RecoveryPointArn": "string",
         "ResourceArn": "string",
         "ResourceType": "string"
      }
   ]
}
```

## 回應元素
<a name="API_ListRecoveryPointsByLegalHold_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [NextToken](#API_ListRecoveryPointsByLegalHold_ResponseSyntax) **   <a name="Backup-ListRecoveryPointsByLegalHold-response-NextToken"></a>
所傳回資源部分清單之後的下一個項目。  
類型：字串

 ** [RecoveryPoints](#API_ListRecoveryPointsByLegalHold_ResponseSyntax) **   <a name="Backup-ListRecoveryPointsByLegalHold-response-RecoveryPoints"></a>
復原點。  
類型：[RecoveryPointMember](API_RecoveryPointMember.md) 物件陣列

## 錯誤
<a name="API_ListRecoveryPointsByLegalHold_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListRecoveryPointsByLegalHold_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListRecoveryPointsByLegalHold) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListRecoveryPointsByLegalHold) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListRecoveryPointsByLegalHold) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRecoveryPointsByLegalHold) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListRecoveryPointsByLegalHold) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListRecoveryPointsByLegalHold) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListRecoveryPointsByLegalHold) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRecoveryPointsByLegalHold) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListRecoveryPointsByLegalHold) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListRecoveryPointsByLegalHold) 

# ListRecoveryPointsByResource
<a name="API_ListRecoveryPointsByResource"></a>

資源 Amazon Resource Name (ARN) 所指定類型之復原點的相關資訊。

**注意**  
對於 Amazon EFS 和 Amazon EC2，此動作僅列出由 AWS Backup建立的復原點。

## 請求語法
<a name="API_ListRecoveryPointsByResource_RequestSyntax"></a>

```
GET /resources/resourceArn/recovery-points/?managedByAWSBackupOnly=ManagedByAWSBackupOnly&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI 請求參數
<a name="API_ListRecoveryPointsByResource_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [ManagedByAWSBackupOnly](#API_ListRecoveryPointsByResource_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByResource-request-uri-ManagedByAWSBackupOnly"></a>
此屬性會根據擁有權篩選復原點。  
如果將此設為 `TRUE`，回應將包含與所管理之所選資源相關聯的復原點 AWS Backup。  
如果將此設為 `FALSE`，回應將包含與所選資源相關聯的所有復原點。  
類型：布林值

 ** [MaxResults](#API_ListRecoveryPointsByResource_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByResource-request-uri-MaxResults"></a>
所要傳回的項目數量上限。  
Amazon RDS 需要至少為 20 的值。
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListRecoveryPointsByResource_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByResource-request-uri-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。

 ** [resourceArn](#API_ListRecoveryPointsByResource_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByResource-request-uri-ResourceArn"></a>
可唯一識別資源的 ARN。ARN 的格式取決於資源類型。  
必要：是

## 請求主體
<a name="API_ListRecoveryPointsByResource_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListRecoveryPointsByResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "RecoveryPoints": [ 
      { 
         "AggregatedScanResult": { 
            "FailedScan": boolean,
            "Findings": [ "string" ],
            "LastComputed": number
         },
         "BackupSizeBytes": number,
         "BackupVaultName": "string",
         "CreationDate": number,
         "EncryptionKeyArn": "string",
         "EncryptionKeyType": "string",
         "IndexStatus": "string",
         "IndexStatusMessage": "string",
         "IsParent": boolean,
         "ParentRecoveryPointArn": "string",
         "RecoveryPointArn": "string",
         "ResourceName": "string",
         "Status": "string",
         "StatusMessage": "string",
         "VaultType": "string"
      }
   ]
}
```

## 回應元素
<a name="API_ListRecoveryPointsByResource_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [NextToken](#API_ListRecoveryPointsByResource_ResponseSyntax) **   <a name="Backup-ListRecoveryPointsByResource-response-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。  
類型：字串

 ** [RecoveryPoints](#API_ListRecoveryPointsByResource_ResponseSyntax) **   <a name="Backup-ListRecoveryPointsByResource-response-RecoveryPoints"></a>
物件陣列，其中包含指定資源類型之復原點的詳細資訊。  
只有 Amazon EFS 和 Amazon EC2 復原點會傳回 BackupVaultName。
類型：[RecoveryPointByResource](API_RecoveryPointByResource.md) 物件陣列

## 錯誤
<a name="API_ListRecoveryPointsByResource_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListRecoveryPointsByResource_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListRecoveryPointsByResource) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListRecoveryPointsByResource) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListRecoveryPointsByResource) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRecoveryPointsByResource) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListRecoveryPointsByResource) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListRecoveryPointsByResource) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListRecoveryPointsByResource) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRecoveryPointsByResource) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListRecoveryPointsByResource) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListRecoveryPointsByResource) 

# ListReportJobs
<a name="API_ListReportJobs"></a>

傳回報告任務的相關詳細資訊。

## 請求語法
<a name="API_ListReportJobs_RequestSyntax"></a>

```
GET /audit/report-jobs?CreationAfter=ByCreationAfter&CreationBefore=ByCreationBefore&MaxResults=MaxResults&NextToken=NextToken&ReportPlanName=ByReportPlanName&Status=ByStatus HTTP/1.1
```

## URI 請求參數
<a name="API_ListReportJobs_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [ByCreationAfter](#API_ListReportJobs_RequestSyntax) **   <a name="Backup-ListReportJobs-request-uri-ByCreationAfter"></a>
僅傳回以 Unix 格式和國際標準時間 (UTC) 指定之日期和時間之後建立的報告任務。例如，值 1516925490 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30 秒。

 ** [ByCreationBefore](#API_ListReportJobs_RequestSyntax) **   <a name="Backup-ListReportJobs-request-uri-ByCreationBefore"></a>
僅傳回以 Unix 格式和國際標準時間 (UTC) 指定之日期和時間之前建立的報告任務。例如，值 1516925490 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30 秒。

 ** [ByReportPlanName](#API_ListReportJobs_RequestSyntax) **   <a name="Backup-ListReportJobs-request-uri-ByReportPlanName"></a>
僅傳回具有指定報表計畫名稱的報表任務。  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z][_a-zA-Z0-9]*`

 ** [ByStatus](#API_ListReportJobs_RequestSyntax) **   <a name="Backup-ListReportJobs-request-uri-ByStatus"></a>
僅傳回處於指定狀態的報告任務。狀態如下：  
 `CREATED | RUNNING | COMPLETED | FAILED | COMPLETED_WITH_ISSUES`   
 請注意，只有掃描任務完成，狀態完成，但發生問題。對於備份任務，這是以已完成狀態完成且具有狀態訊息的任務的主控台解釋。

 ** [MaxResults](#API_ListReportJobs_RequestSyntax) **   <a name="Backup-ListReportJobs-request-uri-MaxResults"></a>
從 1 到 1000 的期望結果數量。選用。如果未指定，查詢將傳回 1 MB 的資料。  
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListReportJobs_RequestSyntax) **   <a name="Backup-ListReportJobs-request-uri-NextToken"></a>
從上一次呼叫此操作傳回的識別符，可用來傳回清單中的下一組項目。

## 請求主體
<a name="API_ListReportJobs_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListReportJobs_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "ReportJobs": [ 
      { 
         "CompletionTime": number,
         "CreationTime": number,
         "ReportDestination": { 
            "S3BucketName": "string",
            "S3Keys": [ "string" ]
         },
         "ReportJobId": "string",
         "ReportPlanArn": "string",
         "ReportTemplate": "string",
         "Status": "string",
         "StatusMessage": "string"
      }
   ]
}
```

## 回應元素
<a name="API_ListReportJobs_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [NextToken](#API_ListReportJobs_ResponseSyntax) **   <a name="Backup-ListReportJobs-response-NextToken"></a>
從上一次呼叫此操作傳回的識別符，可用來傳回清單中的下一組項目。  
類型：字串

 ** [ReportJobs](#API_ListReportJobs_ResponseSyntax) **   <a name="Backup-ListReportJobs-response-ReportJobs"></a>
JSON 格式報告任務的詳細資訊。  
類型：[ReportJob](API_ReportJob.md) 物件陣列

## 錯誤
<a name="API_ListReportJobs_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListReportJobs_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListReportJobs) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListReportJobs) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListReportJobs) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListReportJobs) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListReportJobs) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListReportJobs) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListReportJobs) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListReportJobs) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListReportJobs) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListReportJobs) 

# ListReportPlans
<a name="API_ListReportPlans"></a>

傳回報告計畫的清單。如需單一報告計畫的詳細資訊，請使用 `DescribeReportPlan`。

## 請求語法
<a name="API_ListReportPlans_RequestSyntax"></a>

```
GET /audit/report-plans?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```

## URI 請求參數
<a name="API_ListReportPlans_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [MaxResults](#API_ListReportPlans_RequestSyntax) **   <a name="Backup-ListReportPlans-request-uri-MaxResults"></a>
從 1 到 1000 的期望結果數量。選用。如果未指定，查詢將傳回 1 MB 的資料。  
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListReportPlans_RequestSyntax) **   <a name="Backup-ListReportPlans-request-uri-NextToken"></a>
從上一次呼叫此操作傳回的識別符，可用來傳回清單中的下一組項目。

## 請求主體
<a name="API_ListReportPlans_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListReportPlans_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "ReportPlans": [ 
      { 
         "CreationTime": number,
         "DeploymentStatus": "string",
         "LastAttemptedExecutionTime": number,
         "LastSuccessfulExecutionTime": number,
         "ReportDeliveryChannel": { 
            "Formats": [ "string" ],
            "S3BucketName": "string",
            "S3KeyPrefix": "string"
         },
         "ReportPlanArn": "string",
         "ReportPlanDescription": "string",
         "ReportPlanName": "string",
         "ReportSetting": { 
            "Accounts": [ "string" ],
            "FrameworkArns": [ "string" ],
            "NumberOfFrameworks": number,
            "OrganizationUnits": [ "string" ],
            "Regions": [ "string" ],
            "ReportTemplate": "string"
         }
      }
   ]
}
```

## 回應元素
<a name="API_ListReportPlans_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [NextToken](#API_ListReportPlans_ResponseSyntax) **   <a name="Backup-ListReportPlans-response-NextToken"></a>
從上一次呼叫此操作傳回的識別符，可用來傳回清單中的下一組項目。  
類型：字串

 ** [ReportPlans](#API_ListReportPlans_ResponseSyntax) **   <a name="Backup-ListReportPlans-response-ReportPlans"></a>
報告計畫包含每個計畫的詳細資訊。此資訊包括 Amazon Resource Name (ARN)、報告計畫名稱、描述、設定、交付管道、部署狀態、建立時間，以及報告計畫上一次嘗試並成功執行的時間。  
類型：[ReportPlan](API_ReportPlan.md) 物件陣列

## 錯誤
<a name="API_ListReportPlans_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListReportPlans_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListReportPlans) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListReportPlans) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListReportPlans) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListReportPlans) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListReportPlans) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListReportPlans) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListReportPlans) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListReportPlans) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListReportPlans) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListReportPlans) 

# ListRestoreAccessBackupVaults
<a name="API_ListRestoreAccessBackupVaults"></a>

傳回與指定備份保存庫相關聯的還原存取備份保存庫清單。

## 請求語法
<a name="API_ListRestoreAccessBackupVaults_RequestSyntax"></a>

```
GET /logically-air-gapped-backup-vaults/backupVaultName/restore-access-backup-vaults/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI 請求參數
<a name="API_ListRestoreAccessBackupVaults_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [backupVaultName](#API_ListRestoreAccessBackupVaults_RequestSyntax) **   <a name="Backup-ListRestoreAccessBackupVaults-request-uri-BackupVaultName"></a>
列出相關聯還原存取備份文件庫的備份文件庫名稱。  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必要：是

 ** [MaxResults](#API_ListRestoreAccessBackupVaults_RequestSyntax) **   <a name="Backup-ListRestoreAccessBackupVaults-request-uri-MaxResults"></a>
在回應中傳回的項目數量上限。  
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListRestoreAccessBackupVaults_RequestSyntax) **   <a name="Backup-ListRestoreAccessBackupVaults-request-uri-NextToken"></a>
上一個請求的分頁字符，用於擷取下一組結果。

## 請求主體
<a name="API_ListRestoreAccessBackupVaults_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListRestoreAccessBackupVaults_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "RestoreAccessBackupVaults": [ 
      { 
         "ApprovalDate": number,
         "CreationDate": number,
         "LatestRevokeRequest": { 
            "ExpiryDate": number,
            "InitiationDate": number,
            "MpaSessionArn": "string",
            "Status": "string",
            "StatusMessage": "string"
         },
         "RestoreAccessBackupVaultArn": "string",
         "VaultState": "string"
      }
   ]
}
```

## 回應元素
<a name="API_ListRestoreAccessBackupVaults_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [NextToken](#API_ListRestoreAccessBackupVaults_ResponseSyntax) **   <a name="Backup-ListRestoreAccessBackupVaults-response-NextToken"></a>
在後續請求中使用的分頁字符，用於擷取下一組結果。  
類型：字串

 ** [RestoreAccessBackupVaults](#API_ListRestoreAccessBackupVaults_ResponseSyntax) **   <a name="Backup-ListRestoreAccessBackupVaults-response-RestoreAccessBackupVaults"></a>
與指定備份保存庫相關聯的還原存取備份保存庫清單。  
類型：[RestoreAccessBackupVaultListMember](API_RestoreAccessBackupVaultListMember.md) 物件陣列

## 錯誤
<a name="API_ListRestoreAccessBackupVaults_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListRestoreAccessBackupVaults_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListRestoreAccessBackupVaults) 

# ListRestoreJobs
<a name="API_ListRestoreJobs"></a>

傳回 AWS Backup 啟動以還原已儲存資源的任務清單，包括復原程序的詳細資訊。

## 請求語法
<a name="API_ListRestoreJobs_RequestSyntax"></a>

```
GET /restore-jobs/?accountId=ByAccountId&completeAfter=ByCompleteAfter&completeBefore=ByCompleteBefore&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&maxResults=MaxResults&nextToken=NextToken&parentJobId=ByParentJobId&resourceType=ByResourceType&restoreTestingPlanArn=ByRestoreTestingPlanArn&status=ByStatus HTTP/1.1
```

## URI 請求參數
<a name="API_ListRestoreJobs_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [ByAccountId](#API_ListRestoreJobs_RequestSyntax) **   <a name="Backup-ListRestoreJobs-request-uri-ByAccountId"></a>
列出任務的帳戶 ID。僅傳回與指定帳戶 ID 相關聯的還原任務。  
模式：`^[0-9]{12}$`

 ** [ByCompleteAfter](#API_ListRestoreJobs_RequestSyntax) **   <a name="Backup-ListRestoreJobs-request-uri-ByCompleteAfter"></a>
僅傳回以 Unix 格式和國際標準時間 (UTC) 所表示日期之後完成的複製任務。

 ** [ByCompleteBefore](#API_ListRestoreJobs_RequestSyntax) **   <a name="Backup-ListRestoreJobs-request-uri-ByCompleteBefore"></a>
僅傳回以 Unix 格式和國際標準時間 (UTC) 所表示日期之前完成的複製任務。

 ** [ByCreatedAfter](#API_ListRestoreJobs_RequestSyntax) **   <a name="Backup-ListRestoreJobs-request-uri-ByCreatedAfter"></a>
僅傳回在指定日期之後建立的還原任務。

 ** [ByCreatedBefore](#API_ListRestoreJobs_RequestSyntax) **   <a name="Backup-ListRestoreJobs-request-uri-ByCreatedBefore"></a>
僅傳回在指定日期之前建立的還原任務。

 ** [ByParentJobId](#API_ListRestoreJobs_RequestSyntax) **   <a name="Backup-ListRestoreJobs-request-uri-ByParentJobId"></a>
這是根據父項還原任務 ID 列出子項 （巢狀） 還原任務的篩選條件。

 ** [ByResourceType](#API_ListRestoreJobs_RequestSyntax) **   <a name="Backup-ListRestoreJobs-request-uri-ByResourceType"></a>
包含此參數以僅傳回指定資源的還原任務：  
+  `Aurora` 代表 Amazon Aurora
+  `CloudFormation` 適用於 的 AWS CloudFormation 
+  `DocumentDB` 代表 Amazon DocumentDB (with MongoDB compatibility)
+  `DynamoDB` 代表 Amazon DynamoDB
+  `EBS` 代表 Amazon Elastic Block Store
+  `EC2` 代表 Amazon Elastic Compute Cloud
+  `EFS` 代表 Amazon Elastic File System
+  `EKS` for Amazon Elastic Kubernetes Service
+  `FSx` 代表 Amazon FSx
+  `Neptune` 代表 Amazon Neptune
+  `RDS` 代表 Amazon Relational Database Service
+  `Redshift` 代表 Amazon Redshift
+  `S3` for Amazon Simple Storage Service (Amazon S3)
+  `SAP HANA on Amazon EC2` 適用於 Amazon Elastic Compute Cloud 執行個體上的 SAP HANA 資料庫
+  `Storage Gateway` 適用於 的 AWS Storage Gateway 
+  `Timestream` 代表 Amazon Timestream
+  `VirtualMachine` 適用於 VMware 虛擬機器
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`

 ** [ByRestoreTestingPlanArn](#API_ListRestoreJobs_RequestSyntax) **   <a name="Backup-ListRestoreJobs-request-uri-ByRestoreTestingPlanArn"></a>
此項僅傳回符合指定資源 Amazon Resource Name (ARN) 的還原測試任務。

 ** [ByStatus](#API_ListRestoreJobs_RequestSyntax) **   <a name="Backup-ListRestoreJobs-request-uri-ByStatus"></a>
僅傳回與指定任務狀態相關聯的還原任務。  
有效值:`PENDING | RUNNING | COMPLETED | ABORTED | FAILED` 

 ** [MaxResults](#API_ListRestoreJobs_RequestSyntax) **   <a name="Backup-ListRestoreJobs-request-uri-MaxResults"></a>
所要傳回的項目數量上限。  
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListRestoreJobs_RequestSyntax) **   <a name="Backup-ListRestoreJobs-request-uri-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。

## 請求主體
<a name="API_ListRestoreJobs_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListRestoreJobs_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "RestoreJobs": [ 
      { 
         "AccountId": "string",
         "BackupSizeInBytes": number,
         "BackupVaultArn": "string",
         "CompletionDate": number,
         "CreatedBy": { 
            "RestoreTestingPlanArn": "string"
         },
         "CreatedResourceArn": "string",
         "CreationDate": number,
         "DeletionStatus": "string",
         "DeletionStatusMessage": "string",
         "ExpectedCompletionTimeMinutes": number,
         "IamRoleArn": "string",
         "IsParent": boolean,
         "ParentJobId": "string",
         "PercentDone": "string",
         "RecoveryPointArn": "string",
         "RecoveryPointCreationDate": number,
         "ResourceType": "string",
         "RestoreJobId": "string",
         "SourceResourceArn": "string",
         "Status": "string",
         "StatusMessage": "string",
         "ValidationStatus": "string",
         "ValidationStatusMessage": "string"
      }
   ]
}
```

## 回應元素
<a name="API_ListRestoreJobs_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [NextToken](#API_ListRestoreJobs_ResponseSyntax) **   <a name="Backup-ListRestoreJobs-response-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。  
類型：字串

 ** [RestoreJobs](#API_ListRestoreJobs_ResponseSyntax) **   <a name="Backup-ListRestoreJobs-response-RestoreJobs"></a>
物件陣列，其中包含還原所儲存資源之任務的詳細資訊。  
類型：[RestoreJobsListMember](API_RestoreJobsListMember.md) 物件陣列

## 錯誤
<a name="API_ListRestoreJobs_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListRestoreJobs_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListRestoreJobs) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListRestoreJobs) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListRestoreJobs) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRestoreJobs) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListRestoreJobs) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListRestoreJobs) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListRestoreJobs) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRestoreJobs) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListRestoreJobs) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListRestoreJobs) 

# ListRestoreJobsByProtectedResource
<a name="API_ListRestoreJobsByProtectedResource"></a>

這將傳回包含指定受保護資源的還原任務。

您必須包含 `ResourceArn`。您可以選擇性地包含 `NextToken`、`ByStatus`、`MaxResults`、`ByRecoveryPointCreationDateAfter` 和 `ByRecoveryPointCreationDateBefore`。

## 請求語法
<a name="API_ListRestoreJobsByProtectedResource_RequestSyntax"></a>

```
GET /resources/resourceArn/restore-jobs/?maxResults=MaxResults&nextToken=NextToken&recoveryPointCreationDateAfter=ByRecoveryPointCreationDateAfter&recoveryPointCreationDateBefore=ByRecoveryPointCreationDateBefore&status=ByStatus HTTP/1.1
```

## URI 請求參數
<a name="API_ListRestoreJobsByProtectedResource_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [ByRecoveryPointCreationDateAfter](#API_ListRestoreJobsByProtectedResource_RequestSyntax) **   <a name="Backup-ListRestoreJobsByProtectedResource-request-uri-ByRecoveryPointCreationDateAfter"></a>
僅傳回在指定日期之後建立的復原點還原任務。

 ** [ByRecoveryPointCreationDateBefore](#API_ListRestoreJobsByProtectedResource_RequestSyntax) **   <a name="Backup-ListRestoreJobsByProtectedResource-request-uri-ByRecoveryPointCreationDateBefore"></a>
僅傳回在指定日期之前建立的復原點還原任務。

 ** [ByStatus](#API_ListRestoreJobsByProtectedResource_RequestSyntax) **   <a name="Backup-ListRestoreJobsByProtectedResource-request-uri-ByStatus"></a>
僅傳回與指定任務狀態相關聯的還原任務。  
有效值:`PENDING | RUNNING | COMPLETED | ABORTED | FAILED` 

 ** [MaxResults](#API_ListRestoreJobsByProtectedResource_RequestSyntax) **   <a name="Backup-ListRestoreJobsByProtectedResource-request-uri-MaxResults"></a>
所要傳回的項目數量上限。  
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListRestoreJobsByProtectedResource_RequestSyntax) **   <a name="Backup-ListRestoreJobsByProtectedResource-request-uri-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回清單中的更多項目。

 ** [resourceArn](#API_ListRestoreJobsByProtectedResource_RequestSyntax) **   <a name="Backup-ListRestoreJobsByProtectedResource-request-uri-ResourceArn"></a>
僅傳回符合指定資源 Amazon Resource Name (ARN) 的還原任務。  
必要：是

## 請求主體
<a name="API_ListRestoreJobsByProtectedResource_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListRestoreJobsByProtectedResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "RestoreJobs": [ 
      { 
         "AccountId": "string",
         "BackupSizeInBytes": number,
         "BackupVaultArn": "string",
         "CompletionDate": number,
         "CreatedBy": { 
            "RestoreTestingPlanArn": "string"
         },
         "CreatedResourceArn": "string",
         "CreationDate": number,
         "DeletionStatus": "string",
         "DeletionStatusMessage": "string",
         "ExpectedCompletionTimeMinutes": number,
         "IamRoleArn": "string",
         "IsParent": boolean,
         "ParentJobId": "string",
         "PercentDone": "string",
         "RecoveryPointArn": "string",
         "RecoveryPointCreationDate": number,
         "ResourceType": "string",
         "RestoreJobId": "string",
         "SourceResourceArn": "string",
         "Status": "string",
         "StatusMessage": "string",
         "ValidationStatus": "string",
         "ValidationStatusMessage": "string"
      }
   ]
}
```

## 回應元素
<a name="API_ListRestoreJobsByProtectedResource_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [NextToken](#API_ListRestoreJobsByProtectedResource_ResponseSyntax) **   <a name="Backup-ListRestoreJobsByProtectedResource-response-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回清單中的更多項目  
類型：字串

 ** [RestoreJobs](#API_ListRestoreJobsByProtectedResource_ResponseSyntax) **   <a name="Backup-ListRestoreJobsByProtectedResource-response-RestoreJobs"></a>
物件陣列，其中包含還原所儲存資源之任務的詳細資訊。>  
類型：[RestoreJobsListMember](API_RestoreJobsListMember.md) 物件陣列

## 錯誤
<a name="API_ListRestoreJobsByProtectedResource_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListRestoreJobsByProtectedResource_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListRestoreJobsByProtectedResource) 

# ListRestoreJobSummaries
<a name="API_ListRestoreJobSummaries"></a>

此請求會取得最近 30 天內建立或執行的還原任務摘要。您可以包括參數 AccountID、State、ResourceType、AggregationPeriod、MaxResults 或 NextToken 來篩選結果。

此請求傳回的摘要包含 Region、Account，State、RestourceType、MessageCategory、StartTime、EndTime 和包含任務的計數。

## 請求語法
<a name="API_ListRestoreJobSummaries_RequestSyntax"></a>

```
GET /audit/restore-job-summaries?AccountId=AccountId&AggregationPeriod=AggregationPeriod&MaxResults=MaxResults&NextToken=NextToken&ResourceType=ResourceType&State=State HTTP/1.1
```

## URI 請求參數
<a name="API_ListRestoreJobSummaries_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [AccountId](#API_ListRestoreJobSummaries_RequestSyntax) **   <a name="Backup-ListRestoreJobSummaries-request-uri-AccountId"></a>
傳回指定帳戶的任務計數。  
如果請求是從成員帳戶或不屬於 AWS Organizations 的帳戶傳送，則會傳回請求者帳戶中的任務。  
根、管理員和委派管理員帳戶可以使用 ANY 值，傳回組織中每個帳戶的任務計數。  
 `AGGREGATE_ALL` 彙總已驗證組織內所有帳戶的任務計數，然後傳回總和。  
模式：`^[0-9]{12}$`

 ** [AggregationPeriod](#API_ListRestoreJobSummaries_RequestSyntax) **   <a name="Backup-ListRestoreJobSummaries-request-uri-AggregationPeriod"></a>
傳回結果的期間。  
+  `ONE_DAY` - 過去 14 天的每日任務計數。
+  `SEVEN_DAYS` - 過去 7 天的彙總任務計數。
+  `FOURTEEN_DAYS` - 過去 14 天的彙總任務計數。
有效值:`ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS` 

 ** [MaxResults](#API_ListRestoreJobSummaries_RequestSyntax) **   <a name="Backup-ListRestoreJobSummaries-request-uri-MaxResults"></a>
此參數會設定要傳回的項目數量上限。  
值是整數。可接受值的範圍是從 1 到 500。  
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListRestoreJobSummaries_RequestSyntax) **   <a name="Backup-ListRestoreJobSummaries-request-uri-NextToken"></a>
所傳回資源部分清單之後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的資源，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。

 ** [ResourceType](#API_ListRestoreJobSummaries_RequestSyntax) **   <a name="Backup-ListRestoreJobSummaries-request-uri-ResourceType"></a>
傳回指定資源類型的任務計數。使用請求 `GetSupportedResourceTypes` 取得支援資源類型的字串。  
該值 ANY 會傳回所有資源類型的計數。  
 `AGGREGATE_ALL` 彙總所有資源類型的任務計數，並傳回總和。  
要備份 AWS 的資源類型；例如，Amazon Elastic Block Store (Amazon EBS) 磁碟區或 Amazon Relational Database Service (Amazon RDS) 資料庫。  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`

 ** [State](#API_ListRestoreJobSummaries_RequestSyntax) **   <a name="Backup-ListRestoreJobSummaries-request-uri-State"></a>
此參數會傳回具有指定狀態之任務的任務計數。  
該值 ANY 會傳回所有狀態的計數。  
 `AGGREGATE_ALL` 彙總所有狀態的任務計數，並傳回總和。  
有效值:`CREATED | PENDING | RUNNING | ABORTED | COMPLETED | FAILED | AGGREGATE_ALL | ANY` 

## 請求主體
<a name="API_ListRestoreJobSummaries_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListRestoreJobSummaries_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AggregationPeriod": "string",
   "NextToken": "string",
   "RestoreJobSummaries": [ 
      { 
         "AccountId": "string",
         "Count": number,
         "EndTime": number,
         "Region": "string",
         "ResourceType": "string",
         "StartTime": number,
         "State": "string"
      }
   ]
}
```

## 回應元素
<a name="API_ListRestoreJobSummaries_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [AggregationPeriod](#API_ListRestoreJobSummaries_ResponseSyntax) **   <a name="Backup-ListRestoreJobSummaries-response-AggregationPeriod"></a>
傳回結果的期間。  
+  `ONE_DAY` - 過去 14 天的每日任務計數。
+  `SEVEN_DAYS` - 過去 7 天的彙總任務計數。
+  `FOURTEEN_DAYS` - 過去 14 天的彙總任務計數。
類型：字串

 ** [NextToken](#API_ListRestoreJobSummaries_ResponseSyntax) **   <a name="Backup-ListRestoreJobSummaries-response-NextToken"></a>
所傳回資源部分清單之後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的資源，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。  
類型：字串

 ** [RestoreJobSummaries](#API_ListRestoreJobSummaries_ResponseSyntax) **   <a name="Backup-ListRestoreJobSummaries-response-RestoreJobSummaries"></a>
此傳回包含的摘要內含 Region、Account，State、ResourceType、MessageCategory、StartTime、EndTime 和包含任務的計數。  
類型：[RestoreJobSummary](API_RestoreJobSummary.md) 物件陣列

## 錯誤
<a name="API_ListRestoreJobSummaries_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListRestoreJobSummaries_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListRestoreJobSummaries) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListRestoreJobSummaries) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListRestoreJobSummaries) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRestoreJobSummaries) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListRestoreJobSummaries) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListRestoreJobSummaries) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListRestoreJobSummaries) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRestoreJobSummaries) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListRestoreJobSummaries) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListRestoreJobSummaries) 

# ListRestoreTestingPlans
<a name="API_ListRestoreTestingPlans"></a>

傳回還原測試計畫的清單。

## 請求語法
<a name="API_ListRestoreTestingPlans_RequestSyntax"></a>

```
GET /restore-testing/plans?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```

## URI 請求參數
<a name="API_ListRestoreTestingPlans_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [MaxResults](#API_ListRestoreTestingPlans_RequestSyntax) **   <a name="Backup-ListRestoreTestingPlans-request-uri-MaxResults"></a>
所要傳回的項目數量上限。  
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListRestoreTestingPlans_RequestSyntax) **   <a name="Backup-ListRestoreTestingPlans-request-uri-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回清單中的更多項目。

## 請求主體
<a name="API_ListRestoreTestingPlans_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListRestoreTestingPlans_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "RestoreTestingPlans": [ 
      { 
         "CreationTime": number,
         "LastExecutionTime": number,
         "LastUpdateTime": number,
         "RestoreTestingPlanArn": "string",
         "RestoreTestingPlanName": "string",
         "ScheduleExpression": "string",
         "ScheduleExpressionTimezone": "string",
         "StartWindowHours": number
      }
   ]
}
```

## 回應元素
<a name="API_ListRestoreTestingPlans_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [NextToken](#API_ListRestoreTestingPlans_ResponseSyntax) **   <a name="Backup-ListRestoreTestingPlans-response-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回清單中的更多項目。  
類型：字串

 ** [RestoreTestingPlans](#API_ListRestoreTestingPlans_ResponseSyntax) **   <a name="Backup-ListRestoreTestingPlans-response-RestoreTestingPlans"></a>
這是還原測試計畫的傳回清單。  
類型：[RestoreTestingPlanForList](API_RestoreTestingPlanForList.md) 物件陣列

## 錯誤
<a name="API_ListRestoreTestingPlans_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListRestoreTestingPlans_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListRestoreTestingPlans) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListRestoreTestingPlans) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListRestoreTestingPlans) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRestoreTestingPlans) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListRestoreTestingPlans) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListRestoreTestingPlans) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListRestoreTestingPlans) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRestoreTestingPlans) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListRestoreTestingPlans) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListRestoreTestingPlans) 

# ListRestoreTestingSelections
<a name="API_ListRestoreTestingSelections"></a>

傳回還原測試選擇的清單。可以使用 `MaxResults` 和 `RestoreTestingPlanName` 進行篩選。

## 請求語法
<a name="API_ListRestoreTestingSelections_RequestSyntax"></a>

```
GET /restore-testing/plans/RestoreTestingPlanName/selections?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```

## URI 請求參數
<a name="API_ListRestoreTestingSelections_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [MaxResults](#API_ListRestoreTestingSelections_RequestSyntax) **   <a name="Backup-ListRestoreTestingSelections-request-uri-MaxResults"></a>
所要傳回的項目數量上限。  
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListRestoreTestingSelections_RequestSyntax) **   <a name="Backup-ListRestoreTestingSelections-request-uri-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回清單中的更多項目。

 ** [RestoreTestingPlanName](#API_ListRestoreTestingSelections_RequestSyntax) **   <a name="Backup-ListRestoreTestingSelections-request-uri-RestoreTestingPlanName"></a>
依指定的還原測試計畫名稱傳回還原測試選擇。  
必要：是

## 請求主體
<a name="API_ListRestoreTestingSelections_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListRestoreTestingSelections_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "RestoreTestingSelections": [ 
      { 
         "CreationTime": number,
         "IamRoleArn": "string",
         "ProtectedResourceType": "string",
         "RestoreTestingPlanName": "string",
         "RestoreTestingSelectionName": "string",
         "ValidationWindowHours": number
      }
   ]
}
```

## 回應元素
<a name="API_ListRestoreTestingSelections_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [NextToken](#API_ListRestoreTestingSelections_ResponseSyntax) **   <a name="Backup-ListRestoreTestingSelections-response-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回清單中的更多項目。  
類型：字串

 ** [RestoreTestingSelections](#API_ListRestoreTestingSelections_ResponseSyntax) **   <a name="Backup-ListRestoreTestingSelections-response-RestoreTestingSelections"></a>
傳回與還原測試計畫相關聯的還原測試選擇。  
類型：[RestoreTestingSelectionForList](API_RestoreTestingSelectionForList.md) 物件陣列

## 錯誤
<a name="API_ListRestoreTestingSelections_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListRestoreTestingSelections_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListRestoreTestingSelections) 

# ListScanJobs
<a name="API_ListScanJobs"></a>

傳回過去 30 天內已驗證帳戶的現有掃描任務清單。

## 請求語法
<a name="API_ListScanJobs_RequestSyntax"></a>

```
GET /scan/jobs?ByAccountId=ByAccountId&ByBackupVaultName=ByBackupVaultName&ByCompleteAfter=ByCompleteAfter&ByCompleteBefore=ByCompleteBefore&ByMalwareScanner=ByMalwareScanner&ByRecoveryPointArn=ByRecoveryPointArn&ByResourceArn=ByResourceArn&ByResourceType=ByResourceType&ByScanResultStatus=ByScanResultStatus&ByState=ByState&MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```

## URI 請求參數
<a name="API_ListScanJobs_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [ByAccountId](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByAccountId"></a>
列出任務的帳戶 ID。僅傳回與特定帳戶 ID 相關聯的備份任務。  
如果從 AWS Organizations 管理帳戶使用，傳遞會`*`傳回整個組織的所有任務。  
模式：`^[0-9]{12}$`

 ** [ByBackupVaultName](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByBackupVaultName"></a>
僅傳回將存放在指定備份文件庫中的掃描任務。備份保存庫是由用於建立它們的帳戶及其建立 AWS 區域的唯一名稱所識別。  
模式：`^[a-zA-Z0-9\-\_\.]{2,50}$`

 ** [ByCompleteAfter](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByCompleteAfter"></a>
僅傳回以 Unix 格式和國際標準時間 (UTC) 表示的日期之後完成的掃描任務。

 ** [ByCompleteBefore](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByCompleteBefore"></a>
僅傳回以 Unix 格式和國際標準時間 (UTC) 所表示日期之前完成的備份任務。

 ** [ByMalwareScanner](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByMalwareScanner"></a>
僅傳回指定惡意軟體掃描器的掃描任務。目前僅支援 `GUARDDUTY`。  
有效值:`GUARDDUTY` 

 ** [ByRecoveryPointArn](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByRecoveryPointArn"></a>
僅傳回針對指定復原點執行的掃描任務。

 ** [ByResourceArn](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByResourceArn"></a>
僅傳回符合指定資源 Amazon Resource Name (ARN) 的掃描任務。

 ** [ByResourceType](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByResourceType"></a>
依指定的還原測試計畫名稱傳回還原測試選擇。  
+  `EBS`適用於 Amazon Elastic Block Store 的
+  `EC2`for Amazon Elastic Compute Cloud
+  `S3`for Amazon Simple Storage Service (Amazon S3)
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
有效值:`EBS | EC2 | S3` 

 ** [ByScanResultStatus](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByScanResultStatus"></a>
僅傳回指定掃描結果的掃描任務：  
+  `THREATS_FOUND` 
+  `NO_THREATS_FOUND` 
有效值:`NO_THREATS_FOUND | THREATS_FOUND` 

 ** [ByState](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByState"></a>
僅傳回指定掃描任務狀態的掃描任務。  
有效值:`CANCELED | COMPLETED | COMPLETED_WITH_ISSUES | CREATED | FAILED | RUNNING` 

 ** [MaxResults](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-MaxResults"></a>
所要傳回的項目數量上限。  
有效範圍：最小值為 1。最大值為 1000。  
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。

## 請求主體
<a name="API_ListScanJobs_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListScanJobs_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "ScanJobs": [ 
      { 
         "AccountId": "string",
         "BackupVaultArn": "string",
         "BackupVaultName": "string",
         "CompletionDate": number,
         "CreatedBy": { 
            "BackupPlanArn": "string",
            "BackupPlanId": "string",
            "BackupPlanVersion": "string",
            "BackupRuleId": "string"
         },
         "CreationDate": number,
         "IamRoleArn": "string",
         "MalwareScanner": "string",
         "RecoveryPointArn": "string",
         "ResourceArn": "string",
         "ResourceName": "string",
         "ResourceType": "string",
         "ScanBaseRecoveryPointArn": "string",
         "ScanId": "string",
         "ScanJobId": "string",
         "ScanMode": "string",
         "ScannerRoleArn": "string",
         "ScanResult": { 
            "ScanResultStatus": "string"
         },
         "State": "string",
         "StatusMessage": "string"
      }
   ]
}
```

## 回應元素
<a name="API_ListScanJobs_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [NextToken](#API_ListScanJobs_ResponseSyntax) **   <a name="Backup-ListScanJobs-response-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。  
類型：字串

 ** [ScanJobs](#API_ListScanJobs_ResponseSyntax) **   <a name="Backup-ListScanJobs-response-ScanJobs"></a>
結構陣列，其中包含以 JSON 格式傳回之掃描任務的中繼資料。  
類型：[ScanJob](API_ScanJob.md) 物件陣列

## 錯誤
<a name="API_ListScanJobs_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListScanJobs_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListScanJobs) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListScanJobs) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListScanJobs) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListScanJobs) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListScanJobs) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListScanJobs) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListScanJobs) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListScanJobs) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListScanJobs) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListScanJobs) 

# ListScanJobSummaries
<a name="API_ListScanJobSummaries"></a>

這是對最近 30 天內建立或執行的掃描任務摘要的請求。

## 請求語法
<a name="API_ListScanJobSummaries_RequestSyntax"></a>

```
GET /audit/scan-job-summaries?AccountId=AccountId&AggregationPeriod=AggregationPeriod&MalwareScanner=MalwareScanner&MaxResults=MaxResults&NextToken=NextToken&ResourceType=ResourceType&ScanResultStatus=ScanResultStatus&State=State HTTP/1.1
```

## URI 請求參數
<a name="API_ListScanJobSummaries_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [AccountId](#API_ListScanJobSummaries_RequestSyntax) **   <a name="Backup-ListScanJobSummaries-request-uri-AccountId"></a>
傳回指定帳戶的任務計數。  
如果請求是從成員帳戶或不屬於 AWS Organizations 的帳戶傳送，則會傳回請求者帳戶中的任務。  
根帳戶、管理員帳戶和委派管理員帳戶可以使用 值`ANY`，從組織中的每個帳戶傳回任務計數。  
 `AGGREGATE_ALL` 彙總已驗證組織內所有帳戶的任務計數，然後傳回總和。  
模式：`^[0-9]{12}$`

 ** [AggregationPeriod](#API_ListScanJobSummaries_RequestSyntax) **   <a name="Backup-ListScanJobSummaries-request-uri-AggregationPeriod"></a>
傳回結果的期間。  
+  `ONE_DAY`前 1 天的每日任務計數。
+  `SEVEN_DAYS`過去 7 天的每日任務計數。
+  `FOURTEEN_DAYS`過去 14 天的每日任務計數。
有效值:`ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS` 

 ** [MalwareScanner](#API_ListScanJobSummaries_RequestSyntax) **   <a name="Backup-ListScanJobSummaries-request-uri-MalwareScanner"></a>
僅傳回指定惡意軟體掃描器的掃描任務。目前唯一的 MalwareScanner 是 `GUARDDUTY`。但 欄位也支援 `ANY`、 和 `AGGREGATE_ALL`。  
有效值:`GUARDDUTY` 

 ** [MaxResults](#API_ListScanJobSummaries_RequestSyntax) **   <a name="Backup-ListScanJobSummaries-request-uri-MaxResults"></a>
所要傳回的項目數量上限。  
值是整數。可接受值的範圍是從 1 到 500。  
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListScanJobSummaries_RequestSyntax) **   <a name="Backup-ListScanJobSummaries-request-uri-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。

 ** [ResourceType](#API_ListScanJobSummaries_RequestSyntax) **   <a name="Backup-ListScanJobSummaries-request-uri-ResourceType"></a>
傳回指定資源類型的任務計數。使用請求 `GetSupportedResourceTypes` 取得支援資源類型的字串。  
此值`ANY`會傳回所有資源類型的計數。  
 `AGGREGATE_ALL` 彙總所有資源類型的任務計數，並傳回總和。  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`

 ** [ScanResultStatus](#API_ListScanJobSummaries_RequestSyntax) **   <a name="Backup-ListScanJobSummaries-request-uri-ScanResultStatus"></a>
僅傳回指定掃描結果的掃描任務。  
有效值:`NO_THREATS_FOUND | THREATS_FOUND` 

 ** [State](#API_ListScanJobSummaries_RequestSyntax) **   <a name="Backup-ListScanJobSummaries-request-uri-State"></a>
僅傳回指定掃描任務狀態的掃描任務。  
有效值:`CREATED | COMPLETED | COMPLETED_WITH_ISSUES | RUNNING | FAILED | CANCELED | AGGREGATE_ALL | ANY` 

## 請求主體
<a name="API_ListScanJobSummaries_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListScanJobSummaries_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AggregationPeriod": "string",
   "NextToken": "string",
   "ScanJobSummaries": [ 
      { 
         "AccountId": "string",
         "Count": number,
         "EndTime": number,
         "MalwareScanner": "string",
         "Region": "string",
         "ResourceType": "string",
         "ScanResultStatus": "string",
         "StartTime": number,
         "State": "string"
      }
   ]
}
```

## 回應元素
<a name="API_ListScanJobSummaries_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [AggregationPeriod](#API_ListScanJobSummaries_ResponseSyntax) **   <a name="Backup-ListScanJobSummaries-response-AggregationPeriod"></a>
傳回結果的期間。  
+  `ONE_DAY`前 1 天的每日任務計數。
+  `SEVEN_DAYS`過去 7 天的每日任務計數。
+  `FOURTEEN_DAYS`過去 14 天的每日任務計數。
有效值: `'ONE_DAY'` \$1 `'SEVEN_DAYS'` \$1 `'FOURTEEN_DAYS'`   
類型：字串

 ** [NextToken](#API_ListScanJobSummaries_ResponseSyntax) **   <a name="Backup-ListScanJobSummaries-response-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。  
類型：字串

 ** [ScanJobSummaries](#API_ListScanJobSummaries_ResponseSyntax) **   <a name="Backup-ListScanJobSummaries-response-ScanJobSummaries"></a>
摘要資訊。  
類型：[ScanJobSummary](API_ScanJobSummary.md) 物件陣列

## 錯誤
<a name="API_ListScanJobSummaries_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListScanJobSummaries_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListScanJobSummaries) 

# ListTags
<a name="API_ListTags"></a>

傳回指派給資源的標籤，例如目標復原點、備份計畫或備份文件庫。

此操作會根據 值中使用的資源類型傳回結果`resourceArn`。例如，具有進階設定的 Amazon DynamoDB 復原點具有開頭為 的 ARN (Amazon Resource Name)`arn:aws:backup`。未啟用進階設定的 DynamoDB 復原點 （備份） 具有開頭為 的 ARN`arn:aws:dynamodb`。

呼叫此操作時，當您包含具有 以外 ARN `resourceArn`的 值時`arn:aws:backup`，可能會傳回下列其中一個例外狀況。為了防止此例外狀況，請僅包含代表完全受管資源類型的值 AWS Backup。它們有一個開始的 ARN，`arn:aws:backup`它們會記錄在[資源表的功能可用性](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource)中。

## 請求語法
<a name="API_ListTags_RequestSyntax"></a>

```
GET /tags/resourceArn/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI 請求參數
<a name="API_ListTags_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [MaxResults](#API_ListTags_RequestSyntax) **   <a name="Backup-ListTags-request-uri-MaxResults"></a>
所要傳回的項目數量上限。  
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListTags_RequestSyntax) **   <a name="Backup-ListTags-request-uri-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。

 ** [resourceArn](#API_ListTags_RequestSyntax) **   <a name="Backup-ListTags-request-uri-ResourceArn"></a>
可唯一識別資源的 Amazon Resource Name (ARN)。ARN 的格式取決於資源類型。`ListTags` 的有效目標為復原點、備份計劃和備份保存庫。  
必要：是

## 請求主體
<a name="API_ListTags_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListTags_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## 回應元素
<a name="API_ListTags_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [NextToken](#API_ListTags_ResponseSyntax) **   <a name="Backup-ListTags-response-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。  
類型：字串

 ** [Tags](#API_ListTags_ResponseSyntax) **   <a name="Backup-ListTags-response-Tags"></a>
標籤的相關資訊。  
類型：字串到字串映射

## 錯誤
<a name="API_ListTags_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListTags_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListTags) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListTags) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListTags) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListTags) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListTags) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListTags) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListTags) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListTags) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListTags) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListTags) 

# ListTieringConfigurations
<a name="API_ListTieringConfigurations"></a>

傳回分層組態的清單。

## 請求語法
<a name="API_ListTieringConfigurations_RequestSyntax"></a>

```
GET /tiering-configurations/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI 請求參數
<a name="API_ListTieringConfigurations_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [MaxResults](#API_ListTieringConfigurations_RequestSyntax) **   <a name="Backup-ListTieringConfigurations-request-uri-MaxResults"></a>
所要傳回的項目數量上限。  
有效範圍：最小值為 1。最大值為 1000。

 ** [NextToken](#API_ListTieringConfigurations_RequestSyntax) **   <a name="Backup-ListTieringConfigurations-request-uri-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。

## 請求主體
<a name="API_ListTieringConfigurations_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_ListTieringConfigurations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "TieringConfigurations": [ 
      { 
         "BackupVaultName": "string",
         "CreationTime": number,
         "LastUpdatedTime": number,
         "TieringConfigurationArn": "string",
         "TieringConfigurationName": "string"
      }
   ]
}
```

## 回應元素
<a name="API_ListTieringConfigurations_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [NextToken](#API_ListTieringConfigurations_ResponseSyntax) **   <a name="Backup-ListTieringConfigurations-response-NextToken"></a>
傳回項目之部分列表後的下一個項目。例如，如果請求傳回 `MaxResults` 個數量的項目，則 `NextToken` 允許您從下一個字符指向的位置開始傳回列表中的更多項目。  
類型：字串

 ** [TieringConfigurations](#API_ListTieringConfigurations_ResponseSyntax) **   <a name="Backup-ListTieringConfigurations-response-TieringConfigurations"></a>
`ListTieringConfigurations` 呼叫傳回的分層組態陣列。  
類型：[TieringConfigurationsListMember](API_TieringConfigurationsListMember.md) 物件陣列

## 錯誤
<a name="API_ListTieringConfigurations_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_ListTieringConfigurations_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListTieringConfigurations) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListTieringConfigurations) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListTieringConfigurations) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListTieringConfigurations) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListTieringConfigurations) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListTieringConfigurations) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListTieringConfigurations) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListTieringConfigurations) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListTieringConfigurations) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListTieringConfigurations) 

# PutBackupVaultAccessPolicy
<a name="API_PutBackupVaultAccessPolicy"></a>

設定以資源為基礎的政策，用於管理目標備份保存庫的存取許可。需要備份保存庫名稱和 JSON 格式的存取政策文件。

## 請求語法
<a name="API_PutBackupVaultAccessPolicy_RequestSyntax"></a>

```
PUT /backup-vaults/backupVaultName/access-policy HTTP/1.1
Content-type: application/json

{
   "Policy": "string"
}
```

## URI 請求參數
<a name="API_PutBackupVaultAccessPolicy_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [backupVaultName](#API_PutBackupVaultAccessPolicy_RequestSyntax) **   <a name="Backup-PutBackupVaultAccessPolicy-request-uri-BackupVaultName"></a>
存放備份的邏輯容器名稱。備份文件庫依名稱識別，這些名稱對建立文件庫的帳戶和 AWS 區域來說是唯一的。  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必要：是

## 請求主體
<a name="API_PutBackupVaultAccessPolicy_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [Policy](#API_PutBackupVaultAccessPolicy_RequestSyntax) **   <a name="Backup-PutBackupVaultAccessPolicy-request-Policy"></a>
JSON 格式的備份保存庫存取政策文件。  
類型：字串  
必要：否

## 回應語法
<a name="API_PutBackupVaultAccessPolicy_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_PutBackupVaultAccessPolicy_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_PutBackupVaultAccessPolicy_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_PutBackupVaultAccessPolicy_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/PutBackupVaultAccessPolicy) 

# PutBackupVaultLockConfiguration
<a name="API_PutBackupVaultLockConfiguration"></a>

將 AWS Backup 保存庫鎖定套用至備份保存庫，防止 嘗試刪除存放在備份保存庫中或建立於備份保存庫中的任何復原點。Vault Lock 也可防止嘗試更新生命週期政策，該政策控制目前儲存在備份保存庫中的任意復原點的保留期間。如果已指定，Vault Lock 會對以備份保存庫為目標的未來備份和複製任務，強制執行最短和最長保留期。

**注意**  
 AWS Backup Cohasset Associates 已評估保存庫鎖定，可用於符合 SEC 17a-4、CFTC 和 FINRA 法規的環境。如需 Vault Lock AWS Backup 如何與這些法規相關的詳細資訊，請參閱 [Cohasset Associates 合規評估。](https://docs.aws.amazon.com/aws-backup/latest/devguide/samples/cohassetreport.zip)

如需詳細資訊，請參閱 [AWS Backup Vault Lock ](https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html)。

## 請求語法
<a name="API_PutBackupVaultLockConfiguration_RequestSyntax"></a>

```
PUT /backup-vaults/backupVaultName/vault-lock HTTP/1.1
Content-type: application/json

{
   "ChangeableForDays": number,
   "MaxRetentionDays": number,
   "MinRetentionDays": number
}
```

## URI 請求參數
<a name="API_PutBackupVaultLockConfiguration_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [backupVaultName](#API_PutBackupVaultLockConfiguration_RequestSyntax) **   <a name="Backup-PutBackupVaultLockConfiguration-request-uri-BackupVaultName"></a>
指定其保護之備份保存庫名稱的 AWS Backup 保存庫鎖定組態。  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必要：是

## 請求主體
<a name="API_PutBackupVaultLockConfiguration_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [ChangeableForDays](#API_PutBackupVaultLockConfiguration_RequestSyntax) **   <a name="Backup-PutBackupVaultLockConfiguration-request-ChangeableForDays"></a>
指定鎖定日期前天數的 AWS Backup 保存庫鎖定組態。例如，若於 UTC 時間 2022 年 1 月 1 日將 `ChangeableForDays` 設定為 30，則會將鎖定日期設定為 UTC 時間 2022 年 1 月 31 日晚上 8 點。  
 AWS Backup 在保存庫鎖定生效並變得不可變之前， 會強制執行 72 小時的冷靜期。因此，您必須將 `ChangeableForDays` 設定為 3 或以上。  
您可以指定的最大值為 36，500 天 （約 100 年）。  
在鎖定日期之前，您可使用 `DeleteBackupVaultLockConfiguration` 從文件庫中刪除 Vault Lock，或使用 `PutBackupVaultLockConfiguration` 變更 Vault Lock 組態。在鎖定日期當天和其後，Vault Lock 會轉為不可變狀態，且無法變更或刪除。  
若未指定此參數，您可隨時使用 `DeleteBackupVaultLockConfiguration` 從文件庫中刪除 Vault Lock，或使用 `PutBackupVaultLockConfiguration` 變更 Vault Lock 組態。  
類型：Long  
必要：否

 ** [MaxRetentionDays](#API_PutBackupVaultLockConfiguration_RequestSyntax) **   <a name="Backup-PutBackupVaultLockConfiguration-request-MaxRetentionDays"></a>
保存 AWS Backup 庫鎖定組態，指定保存庫保留其復原點的最長保留期間。例如，若組織的政策要求您在保留某些資料四年 (1460 天) 後將其銷毀，此設定會很實用。  
若未包含此參數，Vault Lock 不會對文件庫中的復原點強制執行最長保留期間。若包含此參數時沒有值，Vault Lock 將不會強制執行最長保留期間。  
若指定此參數，則文件庫的所有備份或複製任務皆必須具有生命週期政策，其保留期間等於或短於最長保留期間。若任務的保留期間超過該最長保留期間，則文件庫的備份或複製任務會失敗，您應修改生命週期設定或使用不同的文件庫。您可以指定的最長保留期間為 36500 天 (約 100 年)。在執行 Vault Lock 之前已儲存於文件庫的復原點不會受到影響。  
類型：Long  
必要：否

 ** [MinRetentionDays](#API_PutBackupVaultLockConfiguration_RequestSyntax) **   <a name="Backup-PutBackupVaultLockConfiguration-request-MinRetentionDays"></a>
保存 AWS Backup 庫鎖定組態，指定保存庫保留其復原點的最短保留期間。例如，若組織的政策要求您保留某些資料至少七年 (2555 天)，此設定會很實用。  
透過 建立保存庫鎖定時，需要此參數 AWS CloudFormation；否則，此參數為選用。若未指定此參數，Vault Lock 將不會強制執行最短保留期間。  
若指定此參數，則文件庫的所有備份或複製任務皆必須具有生命週期政策，其保留期間等於或超過最短保留期間。若任務的保留期間未達最短保留期間，則文件庫的備份或複製任務會失敗，您應修改生命週期設定或使用不同的文件庫。您可以指定的最短保留期間為 1 天。在執行 Vault Lock 之前已儲存於文件庫的復原點不會受到影響。  
類型：Long  
必要：否

## 回應語法
<a name="API_PutBackupVaultLockConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_PutBackupVaultLockConfiguration_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_PutBackupVaultLockConfiguration_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_PutBackupVaultLockConfiguration_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/PutBackupVaultLockConfiguration) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/PutBackupVaultLockConfiguration) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/PutBackupVaultLockConfiguration) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/PutBackupVaultLockConfiguration) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/PutBackupVaultLockConfiguration) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/PutBackupVaultLockConfiguration) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/PutBackupVaultLockConfiguration) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/PutBackupVaultLockConfiguration) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/PutBackupVaultLockConfiguration) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/PutBackupVaultLockConfiguration) 

# PutBackupVaultNotifications
<a name="API_PutBackupVaultNotifications"></a>

開啟指定主題與事件的備份保存庫通知。

## 請求語法
<a name="API_PutBackupVaultNotifications_RequestSyntax"></a>

```
PUT /backup-vaults/backupVaultName/notification-configuration HTTP/1.1
Content-type: application/json

{
   "BackupVaultEvents": [ "string" ],
   "SNSTopicArn": "string"
}
```

## URI 請求參數
<a name="API_PutBackupVaultNotifications_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [backupVaultName](#API_PutBackupVaultNotifications_RequestSyntax) **   <a name="Backup-PutBackupVaultNotifications-request-uri-BackupVaultName"></a>
存放備份的邏輯容器名稱。備份文件庫依名稱識別，這些名稱對建立文件庫的帳戶和 AWS 區域來說是唯一的。  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必要：是

## 請求主體
<a name="API_PutBackupVaultNotifications_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [BackupVaultEvents](#API_PutBackupVaultNotifications_RequestSyntax) **   <a name="Backup-PutBackupVaultNotifications-request-BackupVaultEvents"></a>
事件陣列，指示將資源備份到備份文件庫的任務狀態。如需支援的事件清單、常用案例和程式碼範例，請參閱[使用 通知選項 AWS Backup](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-notifications.html)。  
以下清單包含支援的事件和不再使用的已棄用事件 （以供參考）。已棄用的事件不會傳回狀態或通知。
類型：字串陣列  
有效值:`BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED | BACKUP_JOB_SUCCESSFUL | BACKUP_JOB_FAILED | BACKUP_JOB_EXPIRED | RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RESTORE_JOB_SUCCESSFUL | RESTORE_JOB_FAILED | COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED | RECOVERY_POINT_MODIFIED | BACKUP_PLAN_CREATED | BACKUP_PLAN_MODIFIED | S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED | CONTINUOUS_BACKUP_INTERRUPTED | RECOVERY_POINT_INDEX_COMPLETED | RECOVERY_POINT_INDEX_DELETED | RECOVERY_POINT_INDEXING_FAILED`   
必要：是

 ** [SNSTopicArn](#API_PutBackupVaultNotifications_RequestSyntax) **   <a name="Backup-PutBackupVaultNotifications-request-SNSTopicArn"></a>
可指定備份保存庫事件主題的 Amazon Resource Name (ARN)，例如 `arn:aws:sns:us-west-2:111122223333:MyVaultTopic`。  
類型：字串  
必要：是

## 回應語法
<a name="API_PutBackupVaultNotifications_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_PutBackupVaultNotifications_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_PutBackupVaultNotifications_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_PutBackupVaultNotifications_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/PutBackupVaultNotifications) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/PutBackupVaultNotifications) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/PutBackupVaultNotifications) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/PutBackupVaultNotifications) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/PutBackupVaultNotifications) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/PutBackupVaultNotifications) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/PutBackupVaultNotifications) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/PutBackupVaultNotifications) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/PutBackupVaultNotifications) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/PutBackupVaultNotifications) 

# PutRestoreValidationResult
<a name="API_PutRestoreValidationResult"></a>

此請求可讓您傳送獨立自行執行還原測試驗證結果。`RestoreJobId` 和 `ValidationStatus` 是必要項目。您也可以選擇性地輸入 `ValidationStatusMessage`。

## 請求語法
<a name="API_PutRestoreValidationResult_RequestSyntax"></a>

```
PUT /restore-jobs/restoreJobId/validations HTTP/1.1
Content-type: application/json

{
   "ValidationStatus": "string",
   "ValidationStatusMessage": "string"
}
```

## URI 請求參數
<a name="API_PutRestoreValidationResult_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [restoreJobId](#API_PutRestoreValidationResult_RequestSyntax) **   <a name="Backup-PutRestoreValidationResult-request-uri-RestoreJobId"></a>
這是其中還原任務的唯一識別符 AWS Backup。  
必要：是

## 請求主體
<a name="API_PutRestoreValidationResult_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [ValidationStatus](#API_PutRestoreValidationResult_RequestSyntax) **   <a name="Backup-PutRestoreValidationResult-request-ValidationStatus"></a>
還原驗證的狀態。  
類型：字串  
有效值:`FAILED | SUCCESSFUL | TIMED_OUT | VALIDATING`   
必要：是

 ** [ValidationStatusMessage](#API_PutRestoreValidationResult_RequestSyntax) **   <a name="Backup-PutRestoreValidationResult-request-ValidationStatusMessage"></a>
這是選用的訊息字串，您可以輸入此字串以描述還原測試驗證的驗證狀態。  
類型：字串  
必要：否

## 回應語法
<a name="API_PutRestoreValidationResult_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## 回應元素
<a name="API_PutRestoreValidationResult_ResponseElements"></a>

如果動作成功，則服務會送回具有空 HTTP 主體的 HTTP 204 回應。

## 錯誤
<a name="API_PutRestoreValidationResult_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_PutRestoreValidationResult_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/PutRestoreValidationResult) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/PutRestoreValidationResult) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/PutRestoreValidationResult) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/PutRestoreValidationResult) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/PutRestoreValidationResult) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/PutRestoreValidationResult) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/PutRestoreValidationResult) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/PutRestoreValidationResult) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/PutRestoreValidationResult) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/PutRestoreValidationResult) 

# RevokeRestoreAccessBackupVault
<a name="API_RevokeRestoreAccessBackupVault"></a>

撤銷還原存取備份保存庫的存取權，移除從復原點還原和永久刪除保存庫的功能。

## 請求語法
<a name="API_RevokeRestoreAccessBackupVault_RequestSyntax"></a>

```
DELETE /logically-air-gapped-backup-vaults/backupVaultName/restore-access-backup-vaults/restoreAccessBackupVaultArn?requesterComment=RequesterComment HTTP/1.1
```

## URI 請求參數
<a name="API_RevokeRestoreAccessBackupVault_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [backupVaultName](#API_RevokeRestoreAccessBackupVault_RequestSyntax) **   <a name="Backup-RevokeRestoreAccessBackupVault-request-uri-BackupVaultName"></a>
與要撤銷的還原存取備份保存庫相關聯的來源備份保存庫名稱。  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必要：是

 ** [RequesterComment](#API_RevokeRestoreAccessBackupVault_RequestSyntax) **   <a name="Backup-RevokeRestoreAccessBackupVault-request-uri-RequesterComment"></a>
註解，說明撤銷還原存取備份文件庫存取權的原因。

 ** [restoreAccessBackupVaultArn](#API_RevokeRestoreAccessBackupVault_RequestSyntax) **   <a name="Backup-RevokeRestoreAccessBackupVault-request-uri-RestoreAccessBackupVaultArn"></a>
要撤銷之還原存取備份文件庫的 ARN。  
必要：是

## 請求主體
<a name="API_RevokeRestoreAccessBackupVault_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_RevokeRestoreAccessBackupVault_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_RevokeRestoreAccessBackupVault_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_RevokeRestoreAccessBackupVault_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_RevokeRestoreAccessBackupVault_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RevokeRestoreAccessBackupVault) 

# StartBackupJob
<a name="API_StartBackupJob"></a>

啟動指定資源的隨需備份任務。

## 請求語法
<a name="API_StartBackupJob_RequestSyntax"></a>

```
PUT /backup-jobs HTTP/1.1
Content-type: application/json

{
   "BackupOptions": { 
      "string" : "string" 
   },
   "BackupVaultName": "string",
   "CompleteWindowMinutes": number,
   "IamRoleArn": "string",
   "IdempotencyToken": "string",
   "Index": "string",
   "Lifecycle": { 
      "DeleteAfterDays": number,
      "DeleteAfterEvent": "string",
      "MoveToColdStorageAfterDays": number,
      "OptInToArchiveForSupportedResources": boolean
   },
   "LogicallyAirGappedBackupVaultArn": "string",
   "RecoveryPointTags": { 
      "string" : "string" 
   },
   "ResourceArn": "string",
   "StartWindowMinutes": number
}
```

## URI 請求參數
<a name="API_StartBackupJob_RequestParameters"></a>

請求不會使用任何 URI 參數。

## 請求主體
<a name="API_StartBackupJob_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [BackupOptions](#API_StartBackupJob_RequestSyntax) **   <a name="Backup-StartBackupJob-request-BackupOptions"></a>
所選資源的備份選項。此選項僅適用於 Windows 磁碟區陰影複製服務 (VSS) 備份作業。  
有效值：設定為 `"WindowsVSS":"enabled"` 即可啟用 `WindowsVSS` 備份選項，並建立 Windows VSS 備份。設定為 `"WindowsVSS""disabled"` 即可建立一般備份。`WindowsVSS` 選項預設為停用。  
類型：字串到字串映射  
金鑰模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
值模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
必要：否

 ** [BackupVaultName](#API_StartBackupJob_RequestSyntax) **   <a name="Backup-StartBackupJob-request-BackupVaultName"></a>
存放備份的邏輯容器名稱。備份文件庫依名稱識別，這些名稱對建立文件庫的帳戶和 AWS 區域來說是唯一的。  
類型：字串  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必要：是

 ** [CompleteWindowMinutes](#API_StartBackupJob_RequestSyntax) **   <a name="Backup-StartBackupJob-request-CompleteWindowMinutes"></a>
一個分鐘值，成功啟動的備份必須在此期間完成，否則 AWS Backup 將取消任務。此值是選用的。此值會從排程備份的時間開始倒數。其不會為 `StartWindowMinutes` 增加額外的時間，也不會因為備份比排程晚開始而增加時間。  
就像 `StartWindowMinutes`，這項參數的最大值為 100 年 (52,560,000 分鐘)。  
類型：Long  
必要：否

 ** [IamRoleArn](#API_StartBackupJob_RequestSyntax) **   <a name="Backup-StartBackupJob-request-IamRoleArn"></a>
指定用來建立目標復原點的 IAM 角色 ARN；例如 `arn:aws:iam::123456789012:role/S3Access`。  
類型：字串  
必要：是

 ** [IdempotencyToken](#API_StartBackupJob_RequestSyntax) **   <a name="Backup-StartBackupJob-request-IdempotencyToken"></a>
客戶所選擇的字串，可用來區分在其他方面相同的 `StartBackupJob` 呼叫。重試具有相同等冪性字符的成功請求會導致出現成功消息，但未執行任何動作。  
類型：字串  
必要：否

 ** [Index](#API_StartBackupJob_RequestSyntax) **   <a name="Backup-StartBackupJob-request-Index"></a>
如果您的備份任務具有支援備份索引的資源類型，請包含此參數以啟用索引建立。  
支援備份索引的資源類型包括：  
+  `EBS` 代表 Amazon Elastic Block Store
+  `S3` for Amazon Simple Storage Service (Amazon S3)
索引可以有 2 個可能值中的 1 個，可以是 `ENABLED`或 `DISABLED`。  
若要為尚未擁有備份索引的合格`ACTIVE`復原點建立備份索引，請將值設定為 `ENABLED`。  
若要刪除備份索引，請將值設定為 `DISABLED`。  
類型：字串  
有效值:`ENABLED | DISABLED`   
必要：否

 ** [Lifecycle](#API_StartBackupJob_RequestSyntax) **   <a name="Backup-StartBackupJob-request-Lifecycle"></a>
生命週期會定義受保護資源何時轉換為冷儲存，以及何時過期。 AWS Backup 會根據您定義的生命週期自動轉換和過期備份。  
轉移至冷儲存的備份必須在冷儲存中存放至少 90 天之久。因此，「保留」設定必須比「轉移至冷儲存前所需天數」設定大上 90 天。備份已轉換至冷儲存後，就無法變更「經過此天數後轉換為冷儲存」設定。  
可轉換為冷儲存的資源類型會列在[資源資料表的功能可用性](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource)中。 會 AWS Backup 忽略其他資源類型的此表達式。  
這項參數的最大值為 100 年 (36,500 天)。  
類型：[Lifecycle](API_Lifecycle.md) 物件  
必要：否

 ** [LogicallyAirGappedBackupVaultArn](#API_StartBackupJob_RequestSyntax) **   <a name="Backup-StartBackupJob-request-LogicallyAirGappedBackupVaultArn"></a>
邏輯氣隙隔離保存庫的 ARN。ARN 必須位於相同的帳戶和區域。如果提供，支援的全受管資源會直接備份到邏輯氣隙隔離保存庫，而其他支援的資源則會在備份保存庫中建立暫時 （計費） 快照，然後將其複製到邏輯氣隙隔離保存庫。不支援的資源只會備份到指定的備份保存庫。  
類型：字串  
必要：否

 ** [RecoveryPointTags](#API_StartBackupJob_RequestSyntax) **   <a name="Backup-StartBackupJob-request-RecoveryPointTags"></a>
要指派給資源的標籤。  
類型：字串到字串映射  
必要：否

 ** [ResourceArn](#API_StartBackupJob_RequestSyntax) **   <a name="Backup-StartBackupJob-request-ResourceArn"></a>
可唯一識別資源的 Amazon Resource Name (ARN)。ARN 的格式取決於資源類型。  
類型：字串  
必要：是

 ** [StartWindowMinutes](#API_StartBackupJob_RequestSyntax) **   <a name="Backup-StartBackupJob-request-StartWindowMinutes"></a>
從排程備份到取消任務 (如未成功啟動) 的分鐘值。此為選用值，預設為 8 小時。若包含此值，則其必須至少為 60 分鐘以避免發生錯誤。  
此參數的最大值為 100 年 (52,560,000 分鐘)。  
在啟動時段期間，備份任務狀態會保持在 `CREATED` 狀態，直到順利開始或啟動時段時間用完為止。如果在開始時段內 AWS Backup 收到允許重試任務的錯誤， AWS Backup 將至少每 10 分鐘自動重試一次開始任務，直到備份成功開始 （任務狀態變更為 `RUNNING`) 或任務狀態變更為 `EXPIRED`（預期會在開始時段時間結束時發生）。  
類型：Long  
必要：否

## 回應語法
<a name="API_StartBackupJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "BackupJobId": "string",
   "CreationDate": number,
   "IsParent": boolean,
   "RecoveryPointArn": "string"
}
```

## 回應元素
<a name="API_StartBackupJob_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [BackupJobId](#API_StartBackupJob_ResponseSyntax) **   <a name="Backup-StartBackupJob-response-BackupJobId"></a>
唯一識別 AWS Backup 對 備份資源的請求。  
類型：字串

 ** [CreationDate](#API_StartBackupJob_ResponseSyntax) **   <a name="Backup-StartBackupJob-response-CreationDate"></a>
建立備份作業時的日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。`CreationDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [IsParent](#API_StartBackupJob_ResponseSyntax) **   <a name="Backup-StartBackupJob-response-IsParent"></a>
此為傳回的布林值，表示這是父系 (複合) 備份作業。  
類型：布林值

 ** [RecoveryPointArn](#API_StartBackupJob_ResponseSyntax) **   <a name="Backup-StartBackupJob-response-RecoveryPointArn"></a>
 *附註：只有 Amazon EFS 和進階 DynamoDB 資源才會傳回此欄位。*  
可唯一識別復原點的 ARN；例如 `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`。  
類型：字串

## 錯誤
<a name="API_StartBackupJob_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** InvalidRequestException **   
表示請求的輸入出現問題。例如，參數的類型錯誤。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** LimitExceededException **   
請求已超過限制；例如，請求中允許的最大項目數量。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_StartBackupJob_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/StartBackupJob) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/StartBackupJob) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/StartBackupJob) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/StartBackupJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/StartBackupJob) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/StartBackupJob) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/StartBackupJob) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/StartBackupJob) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/StartBackupJob) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/StartBackupJob) 

# StartCopyJob
<a name="API_StartCopyJob"></a>

啟動任務以建立指定資源的一次性複本。

不支援連續備份。

如需如何[重試複製任務](https://docs.aws.amazon.com/aws-backup/latest/devguide/recov-point-create-a-copy.html#backup-copy-retry)操作的資訊，請參閱複製任務 AWS Backup 重試。

## 請求語法
<a name="API_StartCopyJob_RequestSyntax"></a>

```
PUT /copy-jobs HTTP/1.1
Content-type: application/json

{
   "DestinationBackupVaultArn": "string",
   "IamRoleArn": "string",
   "IdempotencyToken": "string",
   "Lifecycle": { 
      "DeleteAfterDays": number,
      "DeleteAfterEvent": "string",
      "MoveToColdStorageAfterDays": number,
      "OptInToArchiveForSupportedResources": boolean
   },
   "RecoveryPointArn": "string",
   "SourceBackupVaultName": "string"
}
```

## URI 請求參數
<a name="API_StartCopyJob_RequestParameters"></a>

請求不會使用任何 URI 參數。

## 請求主體
<a name="API_StartCopyJob_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [DestinationBackupVaultArn](#API_StartCopyJob_RequestSyntax) **   <a name="Backup-StartCopyJob-request-DestinationBackupVaultArn"></a>
可唯一識別要複製之目的地備份保存庫的 Amazon Resource Name (ARN)，例如 `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`。  
類型：字串  
必要：是

 ** [IamRoleArn](#API_StartCopyJob_RequestSyntax) **   <a name="Backup-StartCopyJob-request-IamRoleArn"></a>
指定用於複製目標復原點的 IAM 角色 ARN；例如 `arn:aws:iam::123456789012:role/S3Access`。  
類型：字串  
必要：是

 ** [IdempotencyToken](#API_StartCopyJob_RequestSyntax) **   <a name="Backup-StartCopyJob-request-IdempotencyToken"></a>
客戶所選擇的字串，可用來區分在其他方面相同的 `StartCopyJob` 呼叫。重試具有相同等冪性字符的成功請求會導致出現成功消息，但未執行任何動作。  
類型：字串  
必要：否

 ** [Lifecycle](#API_StartCopyJob_RequestSyntax) **   <a name="Backup-StartCopyJob-request-Lifecycle"></a>
指定復原點轉換為冷儲存或刪除之前的期間，以天為單位。  
轉移至冷儲存的備份必須在冷儲存中存放至少 90 天之久。因此，在 主控台上，保留設定必須比轉換至冷的超過 90 天。備份轉換為冷後，就無法變更轉換為冷。  
可轉換為冷儲存的資源類型會列在[資源資料表的功能可用性](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource)中。 會 AWS Backup 忽略其他資源類型的此表達式。  
若要移除現有的生命週期和保留期間並無限期保留復原點，請為 `MoveToColdStorageAfterDays`和 指定 -1`DeleteAfterDays`。  
類型：[Lifecycle](API_Lifecycle.md) 物件  
必要：否

 ** [RecoveryPointArn](#API_StartCopyJob_RequestSyntax) **   <a name="Backup-StartCopyJob-request-RecoveryPointArn"></a>
可唯一識別要用於複製任務之復原點的 ARN；例如，arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45。  
類型：字串  
必要：是

 ** [SourceBackupVaultName](#API_StartCopyJob_RequestSyntax) **   <a name="Backup-StartCopyJob-request-SourceBackupVaultName"></a>
存放備份的邏輯來源容器名稱。備份保存庫是由用於建立它們的帳戶及其建立 AWS 區域的唯一名稱所識別。  
類型：字串  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必要：是

## 回應語法
<a name="API_StartCopyJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CopyJobId": "string",
   "CreationDate": number,
   "IsParent": boolean
}
```

## 回應元素
<a name="API_StartCopyJob_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [CopyJobId](#API_StartCopyJob_ResponseSyntax) **   <a name="Backup-StartCopyJob-response-CopyJobId"></a>
可唯一識別複製作業。  
類型：字串

 ** [CreationDate](#API_StartCopyJob_ResponseSyntax) **   <a name="Backup-StartCopyJob-response-CreationDate"></a>
建立複製作業時的日期和時間，以 Unix 時間格式和國際標準時間 (UTC) 顯示。`CreationDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [IsParent](#API_StartCopyJob_ResponseSyntax) **   <a name="Backup-StartCopyJob-response-IsParent"></a>
這是一項傳回的布林值，表示這是一個父系 (複合) 複製任務。  
類型：布林值

## 錯誤
<a name="API_StartCopyJob_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** InvalidRequestException **   
表示請求的輸入出現問題。例如，參數的類型錯誤。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** LimitExceededException **   
請求已超過限制；例如，請求中允許的最大項目數量。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_StartCopyJob_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/StartCopyJob) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/StartCopyJob) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/StartCopyJob) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/StartCopyJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/StartCopyJob) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/StartCopyJob) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/StartCopyJob) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/StartCopyJob) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/StartCopyJob) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/StartCopyJob) 

# StartReportJob
<a name="API_StartReportJob"></a>

啟動指定報告計劃的隨需報告任務。

## 請求語法
<a name="API_StartReportJob_RequestSyntax"></a>

```
POST /audit/report-jobs/reportPlanName HTTP/1.1
Content-type: application/json

{
   "IdempotencyToken": "string"
}
```

## URI 請求參數
<a name="API_StartReportJob_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [reportPlanName](#API_StartReportJob_RequestSyntax) **   <a name="Backup-StartReportJob-request-uri-ReportPlanName"></a>
報告計畫的唯一名稱。  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z][_a-zA-Z0-9]*`  
必要：是

## 請求主體
<a name="API_StartReportJob_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [IdempotencyToken](#API_StartReportJob_RequestSyntax) **   <a name="Backup-StartReportJob-request-IdempotencyToken"></a>
客戶所選擇的字串，可用來區分在其他方面相同的 `StartReportJobInput` 呼叫。重試具有相同等冪性字符的成功請求會導致出現成功消息，但未執行任何動作。  
類型：字串  
必要：否

## 回應語法
<a name="API_StartReportJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ReportJobId": "string"
}
```

## 回應元素
<a name="API_StartReportJob_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [ReportJobId](#API_StartReportJob_ResponseSyntax) **   <a name="Backup-StartReportJob-response-ReportJobId"></a>
報告任務的識別符。唯一隨機產生的 Unicode、UTF-8 編碼字串，最長 1,024 個位元組。無法編輯報告任務 ID。  
類型：字串

## 錯誤
<a name="API_StartReportJob_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_StartReportJob_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/StartReportJob) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/StartReportJob) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/StartReportJob) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/StartReportJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/StartReportJob) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/StartReportJob) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/StartReportJob) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/StartReportJob) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/StartReportJob) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/StartReportJob) 

# StartRestoreJob
<a name="API_StartRestoreJob"></a>

復原 Amazon Resource Name (ARN) 所識別的已儲存資源。

## 請求語法
<a name="API_StartRestoreJob_RequestSyntax"></a>

```
PUT /restore-jobs HTTP/1.1
Content-type: application/json

{
   "CopySourceTagsToRestoredResource": boolean,
   "IamRoleArn": "string",
   "IdempotencyToken": "string",
   "Metadata": { 
      "string" : "string" 
   },
   "RecoveryPointArn": "string",
   "ResourceType": "string"
}
```

## URI 請求參數
<a name="API_StartRestoreJob_RequestParameters"></a>

請求不會使用任何 URI 參數。

## 請求主體
<a name="API_StartRestoreJob_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [CopySourceTagsToRestoredResource](#API_StartRestoreJob_RequestSyntax) **   <a name="Backup-StartRestoreJob-request-CopySourceTagsToRestoredResource"></a>
這是選擇性的參數。如果此參數等於 `True`，則備份中包含的標籤將複製到還原的資源。  
這只能套用至透過 建立的備份 AWS Backup。  
類型：布林值  
必要：否

 ** [IamRoleArn](#API_StartRestoreJob_RequestSyntax) **   <a name="Backup-StartRestoreJob-request-IamRoleArn"></a>
 AWS Backup 用於建立目標資源之 IAM 角色的 Amazon Resource Name (ARN)；例如：`arn:aws:iam::123456789012:role/S3Access`。  
類型：字串  
必要：否

 ** [IdempotencyToken](#API_StartRestoreJob_RequestSyntax) **   <a name="Backup-StartRestoreJob-request-IdempotencyToken"></a>
客戶所選擇的字串，可用來區分在其他方面相同的 `StartRestoreJob` 呼叫。重試具有相同等冪性字符的成功請求會導致出現成功消息，但未執行任何動作。  
類型：字串  
必要：否

 ** [Metadata](#API_StartRestoreJob_RequestSyntax) **   <a name="Backup-StartRestoreJob-request-Metadata"></a>
一組中繼資料鍵值對。  
您可以在備份資源時，透過呼叫 `GetRecoveryPointRestoreMetadata` 取得有關資源的組態中繼資料。但是，除了 `GetRecoveryPointRestoreMetadata` 提供的值之外，還可能需要還原資源。例如，如果原始資源已存在，您可能需要提供新資源名稱。  
如需每個資源中繼資料的詳細資訊，請參閱下列內容：  
+  [Amazon Aurora 的中繼資料](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-aur.html#aur-restore-cli) 
+  [Amazon DocumentDB 的中繼資料](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-docdb.html#docdb-restore-cli) 
+  [的中繼資料 AWS CloudFormation](https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-application-stacks.html#restoring-cfn-cli) 
+  [Amazon DynamoDB 的中繼資料](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-dynamodb.html#ddb-restore-cli) 
+  [ Amazon EBS 的中繼資料](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-ebs.html#ebs-restore-cli) 
+  [Amazon EC2 的中繼資料](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-ec2.html#restoring-ec2-cli) 
+  [Amazon EFS 的中繼資料](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-efs.html#efs-restore-cli) 
+  [Amazon EKS 的中繼資料](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-eks.html#eks-restore-backup-section) 
+  [Amazon FSx 的中繼資料](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-fsx.html#fsx-restore-cli) 
+  [Amazon Neptune 的中繼資料](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-nep.html#nep-restore-cli) 
+  [Amazon RDS 的中繼資料](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-rds.html#rds-restore-cli) 
+  [Amazon Redshift 的中繼資料](https://docs.aws.amazon.com/aws-backup/latest/devguide/redshift-restores.html#redshift-restore-api) 
+  [的中繼資料 AWS Storage Gateway](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-storage-gateway.html#restoring-sgw-cli) 
+  [Amazon S3 的中繼資料](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-s3.html#s3-restore-cli) 
+  [Amazon Timestream 的中繼資料](https://docs.aws.amazon.com/aws-backup/latest/devguide/timestream-restore.html#timestream-restore-api) 
+  [虛擬機器的中繼資料](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-vm.html#vm-restore-cli) 
類型：字串到字串映射  
必要：是

 ** [RecoveryPointArn](#API_StartRestoreJob_RequestSyntax) **   <a name="Backup-StartRestoreJob-request-RecoveryPointArn"></a>
唯一識別復原點的 ARN；例如，`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`。  
類型：字串  
必要：是

 ** [ResourceType](#API_StartRestoreJob_RequestSyntax) **   <a name="Backup-StartRestoreJob-request-ResourceType"></a>
請開始作業以還原下列其中一個資源的復原點：  
+  `Aurora` - Amazon Aurora
+  `DocumentDB` - Amazon DocumentDB
+  `CloudFormation` - AWS CloudFormation 
+  `DynamoDB` - Amazon DynamoDB
+  `EBS` - Amazon Elastic Block Store
+  `EC2` - Amazon Elastic Compute Cloud
+  `EFS` - Amazon Elastic File System
+  `EKS` - Amazon Elastic Kubernetes Service
+  `FSx` - Amazon FSx
+  `Neptune` - Amazon Neptune
+  `RDS` - Amazon Relational Database Service
+  `Redshift` - Amazon Redshift
+  `Storage Gateway` - AWS Storage Gateway 
+  `S3` - Amazon Simple Storage Service
+  `Timestream` - Amazon Timestream
+  `VirtualMachine` - 虛擬機器
類型：字串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
必要：否

## 回應語法
<a name="API_StartRestoreJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "RestoreJobId": "string"
}
```

## 回應元素
<a name="API_StartRestoreJob_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [RestoreJobId](#API_StartRestoreJob_ResponseSyntax) **   <a name="Backup-StartRestoreJob-response-RestoreJobId"></a>
唯一識別還原復原點的作業。  
類型：字串

## 錯誤
<a name="API_StartRestoreJob_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_StartRestoreJob_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/StartRestoreJob) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/StartRestoreJob) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/StartRestoreJob) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/StartRestoreJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/StartRestoreJob) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/StartRestoreJob) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/StartRestoreJob) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/StartRestoreJob) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/StartRestoreJob) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/StartRestoreJob) 

# StartScanJob
<a name="API_StartScanJob"></a>

開始掃描特定資源的任務。

## 請求語法
<a name="API_StartScanJob_RequestSyntax"></a>

```
PUT /scan/job HTTP/1.1
Content-type: application/json

{
   "BackupVaultName": "string",
   "IamRoleArn": "string",
   "IdempotencyToken": "string",
   "MalwareScanner": "string",
   "RecoveryPointArn": "string",
   "ScanBaseRecoveryPointArn": "string",
   "ScanMode": "string",
   "ScannerRoleArn": "string"
}
```

## URI 請求參數
<a name="API_StartScanJob_RequestParameters"></a>

請求不會使用任何 URI 參數。

## 請求主體
<a name="API_StartScanJob_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [BackupVaultName](#API_StartScanJob_RequestSyntax) **   <a name="Backup-StartScanJob-request-BackupVaultName"></a>
存放備份的邏輯容器名稱。備份保存庫是由用於建立它們的帳戶及其建立 AWS 區域的唯一名稱所識別。  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
類型：字串  
必要：是

 ** [IamRoleArn](#API_StartScanJob_RequestSyntax) **   <a name="Backup-StartScanJob-request-IamRoleArn"></a>
指定用來建立目標復原點的 IAM 角色 ARN；例如 `arn:aws:iam::123456789012:role/S3Access`。  
類型：字串  
必要：是

 ** [IdempotencyToken](#API_StartScanJob_RequestSyntax) **   <a name="Backup-StartScanJob-request-IdempotencyToken"></a>
客戶所選擇的字串，可用來區分在其他方面相同的 `StartScanJob` 呼叫。重試具有相同等冪性字符的成功請求會導致出現成功消息，但未執行任何動作。  
類型：字串  
必要：否

 ** [MalwareScanner](#API_StartScanJob_RequestSyntax) **   <a name="Backup-StartScanJob-request-MalwareScanner"></a>
指定掃描任務期間使用的惡意軟體掃描器。目前僅支援 `GUARDDUTY`。  
類型：字串  
有效值:`GUARDDUTY`   
必要：是

 ** [RecoveryPointArn](#API_StartScanJob_RequestSyntax) **   <a name="Backup-StartScanJob-request-RecoveryPointArn"></a>
唯一識別復原點的 Amazon Resource Name (ARN)。這是完整掃描的目標復原點。如果您正在執行增量掃描，這將是您的基本復原點選擇之後建立的復原點。  
類型：字串  
必要：是

 ** [ScanBaseRecoveryPointArn](#API_StartScanJob_RequestSyntax) **   <a name="Backup-StartScanJob-request-ScanBaseRecoveryPointArn"></a>
唯一識別用於增量掃描之基本復原點的 ARN。  
類型：字串  
必要：否

 ** [ScanMode](#API_StartScanJob_RequestSyntax) **   <a name="Backup-StartScanJob-request-ScanMode"></a>
指定掃描任務使用的掃描類型。  
包括：  
+  `FULL_SCAN` 會掃描備份中的整個資料歷程。
+  `INCREMENTAL_SCAN` 會掃描目標復原點和基本復原點 ARN 之間的資料差異。
類型：字串  
有效值:`FULL_SCAN | INCREMENTAL_SCAN`   
必要：是

 ** [ScannerRoleArn](#API_StartScanJob_RequestSyntax) **   <a name="Backup-StartScanJob-request-ScannerRoleArn"></a>
指定 IAM 掃描器角色 ARN。  
類型：字串  
必要：是

## 回應語法
<a name="API_StartScanJob_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "CreationDate": number,
   "ScanJobId": "string"
}
```

## 回應元素
<a name="API_StartScanJob_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 201 回應。

服務會傳回下列 JSON 格式的資料。

 ** [CreationDate](#API_StartScanJob_ResponseSyntax) **   <a name="Backup-StartScanJob-response-CreationDate"></a>
建立備份任務時的日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。`CreationDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [ScanJobId](#API_StartScanJob_ResponseSyntax) **   <a name="Backup-StartScanJob-response-ScanJobId"></a>
唯一識別 AWS Backup 對 備份資源的請求。  
類型：字串

## 錯誤
<a name="API_StartScanJob_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** InvalidRequestException **   
表示請求的輸入出現問題。例如，參數的類型錯誤。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** LimitExceededException **   
請求已超過限制；例如，請求中允許的最大項目數量。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_StartScanJob_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/StartScanJob) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/StartScanJob) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/StartScanJob) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/StartScanJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/StartScanJob) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/StartScanJob) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/StartScanJob) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/StartScanJob) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/StartScanJob) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/StartScanJob) 

# StopBackupJob
<a name="API_StopBackupJob"></a>

嘗試取消任務，以建立資源的一次性備份。

下列服務不支援此動作：
+ Amazon Aurora
+ Amazon DocumentDB (with MongoDB compatibility)
+ Amazon FSx for Lustre
+ Amazon FSx for NetApp ONTAP
+ Amazon FSx for OpenZFS
+ Amazon FSx for Windows File Server
+ Amazon Neptune
+ Amazon EC2 執行個體上的 SAP HANA 資料庫
+ Amazon RDS

## 請求語法
<a name="API_StopBackupJob_RequestSyntax"></a>

```
POST /backup-jobs/backupJobId HTTP/1.1
```

## URI 請求參數
<a name="API_StopBackupJob_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [backupJobId](#API_StopBackupJob_RequestSyntax) **   <a name="Backup-StopBackupJob-request-uri-BackupJobId"></a>
唯一識別 AWS Backup 對 備份資源的請求。  
必要：是

## 請求主體
<a name="API_StopBackupJob_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_StopBackupJob_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_StopBackupJob_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_StopBackupJob_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_StopBackupJob_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/StopBackupJob) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/StopBackupJob) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/StopBackupJob) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/StopBackupJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/StopBackupJob) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/StopBackupJob) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/StopBackupJob) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/StopBackupJob) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/StopBackupJob) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/StopBackupJob) 

# TagResource
<a name="API_TagResource"></a>

將一組鍵/值對指派給資源。

## 請求語法
<a name="API_TagResource_RequestSyntax"></a>

```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json

{
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI 請求參數
<a name="API_TagResource_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [resourceArn](#API_TagResource_RequestSyntax) **   <a name="Backup-TagResource-request-uri-ResourceArn"></a>
唯一識別資源的 ARN。  
必要：是

## 請求主體
<a name="API_TagResource_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [Tags](#API_TagResource_RequestSyntax) **   <a name="Backup-TagResource-request-Tags"></a>
用於協助組織資源的鍵值對。您可以將自己的中繼資料指派給所建立的資源。為了清楚起見，下列是指派標籤的結構：`[{"Key":"string","Value":"string"}]`。  
類型：字串到字串映射  
必要：是

## 回應語法
<a name="API_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_TagResource_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_TagResource_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** LimitExceededException **   
請求已超過限制；例如，請求中允許的最大項目數量。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_TagResource_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/TagResource) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/TagResource) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/TagResource) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/TagResource) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/TagResource) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/TagResource) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/TagResource) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/TagResource) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/TagResource) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

從透過 Amazon Resource Name (ARN) 識別的復原點、備份計劃或備份保存庫移除一組鍵值對

此 API 不支援資源類型的復原點，包括 Aurora、Amazon DocumentDB。Amazon EBS、Amazon FSx、Neptune 和 Amazon RDS。

## 請求語法
<a name="API_UntagResource_RequestSyntax"></a>

```
POST /untag/resourceArn HTTP/1.1
Content-type: application/json

{
   "TagKeyList": [ "string" ]
}
```

## URI 請求參數
<a name="API_UntagResource_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [resourceArn](#API_UntagResource_RequestSyntax) **   <a name="Backup-UntagResource-request-uri-ResourceArn"></a>
可唯一識別資源的 ARN。ARN 的格式取決於標籤資源類型。  
不包含 ARNs 與標記`backup`不相容。`TagResource``UntagResource`使用無效的 ARNs 會導致錯誤。可接受的 ARN 內容可包含 `arn:aws:backup:us-east`。無效的 ARN 內容可能看起來像 `arn:aws:ec2:us-east`。  
必要：是

## 請求主體
<a name="API_UntagResource_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [TagKeyList](#API_UntagResource_RequestSyntax) **   <a name="Backup-UntagResource-request-TagKeyList"></a>
用於識別要從資源中移除哪些索引鍵值標籤的索引鍵。  
類型：字串陣列  
必要：是

## 回應語法
<a name="API_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_UntagResource_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_UntagResource_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_UntagResource_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UntagResource) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UntagResource) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UntagResource) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UntagResource) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UntagResource) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UntagResource) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UntagResource) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UntagResource) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UntagResource) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/UntagResource) 

# UpdateBackupPlan
<a name="API_UpdateBackupPlan"></a>

更新指定的備份計畫。新版本由其 ID 唯一識別。

## 請求語法
<a name="API_UpdateBackupPlan_RequestSyntax"></a>

```
POST /backup/plans/backupPlanId HTTP/1.1
Content-type: application/json

{
   "BackupPlan": { 
      "AdvancedBackupSettings": [ 
         { 
            "BackupOptions": { 
               "string" : "string" 
            },
            "ResourceType": "string"
         }
      ],
      "BackupPlanName": "string",
      "Rules": [ 
         { 
            "CompletionWindowMinutes": number,
            "CopyActions": [ 
               { 
                  "DestinationBackupVaultArn": "string",
                  "Lifecycle": { 
                     "DeleteAfterDays": number,
                     "DeleteAfterEvent": "string",
                     "MoveToColdStorageAfterDays": number,
                     "OptInToArchiveForSupportedResources": boolean
                  }
               }
            ],
            "EnableContinuousBackup": boolean,
            "IndexActions": [ 
               { 
                  "ResourceTypes": [ "string" ]
               }
            ],
            "Lifecycle": { 
               "DeleteAfterDays": number,
               "DeleteAfterEvent": "string",
               "MoveToColdStorageAfterDays": number,
               "OptInToArchiveForSupportedResources": boolean
            },
            "RecoveryPointTags": { 
               "string" : "string" 
            },
            "RuleName": "string",
            "ScanActions": [ 
               { 
                  "MalwareScanner": "string",
                  "ScanMode": "string"
               }
            ],
            "ScheduleExpression": "string",
            "ScheduleExpressionTimezone": "string",
            "StartWindowMinutes": number,
            "TargetBackupVaultName": "string",
            "TargetLogicallyAirGappedBackupVaultArn": "string"
         }
      ],
      "ScanSettings": [ 
         { 
            "MalwareScanner": "string",
            "ResourceTypes": [ "string" ],
            "ScannerRoleArn": "string"
         }
      ]
   }
}
```

## URI 請求參數
<a name="API_UpdateBackupPlan_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [backupPlanId](#API_UpdateBackupPlan_RequestSyntax) **   <a name="Backup-UpdateBackupPlan-request-uri-BackupPlanId"></a>
備份計畫的 ID。  
必要：是

## 請求主體
<a name="API_UpdateBackupPlan_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [BackupPlan](#API_UpdateBackupPlan_RequestSyntax) **   <a name="Backup-UpdateBackupPlan-request-BackupPlan"></a>
備份計畫的內文。包括一個 `BackupPlanName` 和一或多組 `Rules`。  
類型：[BackupPlanInput](API_BackupPlanInput.md) 物件  
必要：是

## 回應語法
<a name="API_UpdateBackupPlan_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AdvancedBackupSettings": [ 
      { 
         "BackupOptions": { 
            "string" : "string" 
         },
         "ResourceType": "string"
      }
   ],
   "BackupPlanArn": "string",
   "BackupPlanId": "string",
   "CreationDate": number,
   "ScanSettings": [ 
      { 
         "MalwareScanner": "string",
         "ResourceTypes": [ "string" ],
         "ScannerRoleArn": "string"
      }
   ],
   "VersionId": "string"
}
```

## 回應元素
<a name="API_UpdateBackupPlan_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [AdvancedBackupSettings](#API_UpdateBackupPlan_ResponseSyntax) **   <a name="Backup-UpdateBackupPlan-response-AdvancedBackupSettings"></a>
包含每種資源類型的 `BackupOptions` 清單。  
類型：[AdvancedBackupSetting](API_AdvancedBackupSetting.md) 物件陣列

 ** [BackupPlanArn](#API_UpdateBackupPlan_ResponseSyntax) **   <a name="Backup-UpdateBackupPlan-response-BackupPlanArn"></a>
可唯一識別備份計畫的 Amazon Resource Name (ARN)，例如 `arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50`。  
類型：字串

 ** [BackupPlanId](#API_UpdateBackupPlan_ResponseSyntax) **   <a name="Backup-UpdateBackupPlan-response-BackupPlanId"></a>
唯一識別備份計畫。  
類型：字串

 ** [CreationDate](#API_UpdateBackupPlan_ResponseSyntax) **   <a name="Backup-UpdateBackupPlan-response-CreationDate"></a>
建立備份計劃時的日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。`CreationDate` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [ScanSettings](#API_UpdateBackupPlan_ResponseSyntax) **   <a name="Backup-UpdateBackupPlan-response-ScanSettings"></a>
包含備份計劃的掃描組態，並包含惡意軟體掃描器、您選取的資源和掃描器角色。  
類型：[ScanSetting](API_ScanSetting.md) 物件陣列

 ** [VersionId](#API_UpdateBackupPlan_ResponseSyntax) **   <a name="Backup-UpdateBackupPlan-response-VersionId"></a>
唯一隨機產生的 Unicode、UTF-8 編碼字串，最長 1,024 個位元組。版本 ID 不能編輯。  
類型：字串

## 錯誤
<a name="API_UpdateBackupPlan_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_UpdateBackupPlan_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/UpdateBackupPlan) 

# UpdateFramework
<a name="API_UpdateFramework"></a>

更新指定的架構。

## 請求語法
<a name="API_UpdateFramework_RequestSyntax"></a>

```
PUT /audit/frameworks/frameworkName HTTP/1.1
Content-type: application/json

{
   "FrameworkControls": [ 
      { 
         "ControlInputParameters": [ 
            { 
               "ParameterName": "string",
               "ParameterValue": "string"
            }
         ],
         "ControlName": "string",
         "ControlScope": { 
            "ComplianceResourceIds": [ "string" ],
            "ComplianceResourceTypes": [ "string" ],
            "Tags": { 
               "string" : "string" 
            }
         }
      }
   ],
   "FrameworkDescription": "string",
   "IdempotencyToken": "string"
}
```

## URI 請求參數
<a name="API_UpdateFramework_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [frameworkName](#API_UpdateFramework_RequestSyntax) **   <a name="Backup-UpdateFramework-request-uri-FrameworkName"></a>
架構的唯一名稱。此名稱的長度必須介於 1 到 256 個字元，且開頭要為英文字母，由英文字母 (a-z、A-Z)、數字 (0-9) 和底線 (\$1) 組成。  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z][_a-zA-Z0-9]*`  
必要：是

## 請求主體
<a name="API_UpdateFramework_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [FrameworkControls](#API_UpdateFramework_RequestSyntax) **   <a name="Backup-UpdateFramework-request-FrameworkControls"></a>
構成架構的控制項。清單中的每個控制項都具有名稱、輸入參數和範圍。  
類型：[FrameworkControl](API_FrameworkControl.md) 物件陣列  
必要：否

 ** [FrameworkDescription](#API_UpdateFramework_RequestSyntax) **   <a name="Backup-UpdateFramework-request-FrameworkDescription"></a>
架構的選用描述，最多包含 1,024 個字元。  
類型：字串  
長度限制：長度下限為 0。長度上限為 1024。  
模式：`.*\S.*`  
必要：否

 ** [IdempotencyToken](#API_UpdateFramework_RequestSyntax) **   <a name="Backup-UpdateFramework-request-IdempotencyToken"></a>
客戶所選擇的字串，可用來區分在其他方面相同的 `UpdateFrameworkInput` 呼叫。重試具有相同等冪性字符的成功請求會導致出現成功消息，但未執行任何動作。  
類型：字串  
必要：否

## 回應語法
<a name="API_UpdateFramework_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreationTime": number,
   "FrameworkArn": "string",
   "FrameworkName": "string"
}
```

## 回應元素
<a name="API_UpdateFramework_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [CreationTime](#API_UpdateFramework_ResponseSyntax) **   <a name="Backup-UpdateFramework-response-CreationTime"></a>
架構建立時的日期和時間，採用 ISO 8601 表示法。`CreationTime` 的值精確到毫秒。舉例來說，2020-07-10T15:00:00.000-08:00 代表 2020 年 7 月 10 日下午 3 點，比國際標準時間晚 8 小時。  
類型：Timestamp

 ** [FrameworkArn](#API_UpdateFramework_ResponseSyntax) **   <a name="Backup-UpdateFramework-response-FrameworkArn"></a>
可唯一識別資源的 Amazon Resource Name (ARN)。ARN 的格式取決於資源類型。  
類型：字串

 ** [FrameworkName](#API_UpdateFramework_ResponseSyntax) **   <a name="Backup-UpdateFramework-response-FrameworkName"></a>
架構的唯一名稱。此名稱的長度必須介於 1 到 256 個字元，且開頭要為英文字母，由英文字母 (a-z、A-Z)、數字 (0-9) 和底線 (\$1) 組成。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z][_a-zA-Z0-9]*`

## 錯誤
<a name="API_UpdateFramework_Errors"></a>

如需所有動作常見的錯誤資訊，請參閱《[常見錯誤類型](CommonErrors.md)》。

 ** AlreadyExistsException **   
所需資源已存在。    
 ** Arn **   
  
 ** Context **   
  
 ** CreatorRequestId **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ConflictException **   
 AWS Backup 在完成執行先前的動作之前， 無法執行您請求的動作。請稍後再試。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** LimitExceededException **   
請求已超過限制；例如，請求中允許的最大項目數量。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_UpdateFramework_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UpdateFramework) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateFramework) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateFramework) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateFramework) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateFramework) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateFramework) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateFramework) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateFramework) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateFramework) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/UpdateFramework) 

# UpdateGlobalSettings
<a name="API_UpdateGlobalSettings"></a>

更新 AWS 帳戶是否已啟用不同的跨帳戶管理選項，包括跨帳戶備份、多方核准和委派管理員。如果帳戶不是「Organizations」管理帳戶，則傳回錯誤。使用 `DescribeGlobalSettings` API 判斷目前的設定。

## 請求語法
<a name="API_UpdateGlobalSettings_RequestSyntax"></a>

```
PUT /global-settings HTTP/1.1
Content-type: application/json

{
   "GlobalSettings": { 
      "string" : "string" 
   }
}
```

## URI 請求參數
<a name="API_UpdateGlobalSettings_RequestParameters"></a>

請求不會使用任何 URI 參數。

## 請求主體
<a name="API_UpdateGlobalSettings_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [GlobalSettings](#API_UpdateGlobalSettings_RequestSyntax) **   <a name="Backup-UpdateGlobalSettings-request-GlobalSettings"></a>
輸入可以包括：  
的值`isCrossAccountBackupEnabled`。值可以是 true 或 false。範例：`update-global-settings --global-settings isCrossAccountBackupEnabled=false`。  
多方核准的值，樣式為 `isMpaEnabled`。值可以是 true 或 false。範例：`update-global-settings --global-settings isMpaEnabled=false`。  
備份服務連結角色建立的值，樣式為 `isDelegatedAdministratorEnabled`。值可以是 true 或 false。範例：`update-global-settings --global-settings isDelegatedAdministratorEnabled=false`。  
類型：字串到字串映射  
必要：否

## 回應語法
<a name="API_UpdateGlobalSettings_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_UpdateGlobalSettings_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_UpdateGlobalSettings_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** InvalidRequestException **   
表示請求的輸入出現問題。例如，參數的類型錯誤。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_UpdateGlobalSettings_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UpdateGlobalSettings) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateGlobalSettings) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateGlobalSettings) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateGlobalSettings) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateGlobalSettings) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateGlobalSettings) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateGlobalSettings) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateGlobalSettings) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateGlobalSettings) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/UpdateGlobalSettings) 

# 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) 

# UpdateRecoveryPointLifecycle
<a name="API_UpdateRecoveryPointLifecycle"></a>

設定復原點的轉移生命週期。

生命週期會定義受保護資源何時轉換為冷儲存，以及何時過期。 會根據您定義的生命週期自動 AWS Backup 轉換和過期備份。

可轉換為冷儲存的資源類型會列在[資源資料表的功能可用性](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource)中。 會 AWS Backup 忽略其他資源類型的此表達式。

轉移至冷儲存的備份必須在冷儲存中存放至少 90 天之久。因此，「保留」設定必須比「轉移至冷儲存前所需天數」設定大上 90 天。備份已轉換至冷儲存後，就無法變更「經過此天數後轉換為冷儲存」設定。

**重要**  
如果您的生命週期目前使用參數 `DeleteAfterDays`和 `MoveToColdStorageAfterDays`，請在呼叫此操作時包含這些參數及其值。未包含它們可能會導致您的計劃更新為 null 值。

此操作不支援連續備份。

## 請求語法
<a name="API_UpdateRecoveryPointLifecycle_RequestSyntax"></a>

```
POST /backup-vaults/backupVaultName/recovery-points/recoveryPointArn HTTP/1.1
Content-type: application/json

{
   "Lifecycle": { 
      "DeleteAfterDays": number,
      "DeleteAfterEvent": "string",
      "MoveToColdStorageAfterDays": number,
      "OptInToArchiveForSupportedResources": boolean
   }
}
```

## URI 請求參數
<a name="API_UpdateRecoveryPointLifecycle_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [backupVaultName](#API_UpdateRecoveryPointLifecycle_RequestSyntax) **   <a name="Backup-UpdateRecoveryPointLifecycle-request-uri-BackupVaultName"></a>
存放備份的邏輯容器名稱。備份文件庫依名稱識別，這些名稱對建立文件庫的帳戶和 AWS 區域來說是唯一的。  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必要：是

 ** [recoveryPointArn](#API_UpdateRecoveryPointLifecycle_RequestSyntax) **   <a name="Backup-UpdateRecoveryPointLifecycle-request-uri-RecoveryPointArn"></a>
可唯一識別復原點的 Amazon Resource Name (ARN)，例如 `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`。  
必要：是

## 請求主體
<a name="API_UpdateRecoveryPointLifecycle_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [Lifecycle](#API_UpdateRecoveryPointLifecycle_RequestSyntax) **   <a name="Backup-UpdateRecoveryPointLifecycle-request-Lifecycle"></a>
生命週期會定義受保護資源何時轉換為冷儲存，以及何時過期。 會根據您定義的生命週期自動 AWS Backup 轉換和過期備份。  
轉移至冷儲存的備份必須在冷儲存中存放至少 90 天之久。因此，「保留」設定必須比「轉移至冷儲存前所需天數」設定大上 90 天。備份已轉換至冷儲存後，就無法變更「經過此天數後轉換為冷儲存」設定。  
類型：[Lifecycle](API_Lifecycle.md) 物件  
必要：否

## 回應語法
<a name="API_UpdateRecoveryPointLifecycle_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "BackupVaultArn": "string",
   "CalculatedLifecycle": { 
      "DeleteAt": number,
      "MoveToColdStorageAt": number
   },
   "Lifecycle": { 
      "DeleteAfterDays": number,
      "DeleteAfterEvent": "string",
      "MoveToColdStorageAfterDays": number,
      "OptInToArchiveForSupportedResources": boolean
   },
   "RecoveryPointArn": "string"
}
```

## 回應元素
<a name="API_UpdateRecoveryPointLifecycle_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [BackupVaultArn](#API_UpdateRecoveryPointLifecycle_ResponseSyntax) **   <a name="Backup-UpdateRecoveryPointLifecycle-response-BackupVaultArn"></a>
可唯一識別備份保存庫的 ARN，例如 `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`。  
類型：字串

 ** [CalculatedLifecycle](#API_UpdateRecoveryPointLifecycle_ResponseSyntax) **   <a name="Backup-UpdateRecoveryPointLifecycle-response-CalculatedLifecycle"></a>
包含 `DeleteAt` 和 `MoveToColdStorageAt` 時間戳記的 `CalculatedLifecycle` 物件。  
類型：[CalculatedLifecycle](API_CalculatedLifecycle.md) 物件

 ** [Lifecycle](#API_UpdateRecoveryPointLifecycle_ResponseSyntax) **   <a name="Backup-UpdateRecoveryPointLifecycle-response-Lifecycle"></a>
生命週期會定義受保護資源何時轉換為冷儲存，以及何時過期。 會根據您定義的生命週期自動 AWS Backup 轉換和過期備份。  
轉移至冷儲存的備份必須在冷儲存中存放至少 90 天之久。因此，「保留」設定必須比「轉移至冷儲存前所需天數」設定大上 90 天。備份已轉換至冷儲存後，就無法變更「經過此天數後轉換為冷儲存」設定。  
可轉換為冷儲存的資源類型會列在[資源資料表的功能可用性](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource)中。 會 AWS Backup 忽略其他資源類型的此表達式。  
類型：[Lifecycle](API_Lifecycle.md) 物件

 ** [RecoveryPointArn](#API_UpdateRecoveryPointLifecycle_ResponseSyntax) **   <a name="Backup-UpdateRecoveryPointLifecycle-response-RecoveryPointArn"></a>
可唯一識別復原點的 Amazon Resource Name (ARN)，例如 `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`。  
類型：字串

## 錯誤
<a name="API_UpdateRecoveryPointLifecycle_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_UpdateRecoveryPointLifecycle_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/UpdateRecoveryPointLifecycle) 

# UpdateRegionSettings
<a name="API_UpdateRegionSettings"></a>

更新「區域」的目前服務選擇加入設定。

使用 `DescribeRegionSettings` API 來判斷支援的資源類型。

## 請求語法
<a name="API_UpdateRegionSettings_RequestSyntax"></a>

```
PUT /account-settings HTTP/1.1
Content-type: application/json

{
   "ResourceTypeManagementPreference": { 
      "string" : boolean 
   },
   "ResourceTypeOptInPreference": { 
      "string" : boolean 
   }
}
```

## URI 請求參數
<a name="API_UpdateRegionSettings_RequestParameters"></a>

請求不會使用任何 URI 參數。

## 請求主體
<a name="API_UpdateRegionSettings_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [ResourceTypeManagementPreference](#API_UpdateRegionSettings_RequestSyntax) **   <a name="Backup-UpdateRegionSettings-request-ResourceTypeManagementPreference"></a>
啟用或停用資源類型備份的完整 AWS Backup 管理。若要啟用 DynamoDB 的完整 AWS Backup 管理以及 [AWS Backup的進階 DynamoDB 備份功能](https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html)，請依照程序以[程式設計方式啟用進階 DynamoDB 備份](https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html#advanced-ddb-backup-enable-cli)。  
類型：字串到布林值映射  
金鑰模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
必要：否

 ** [ResourceTypeOptInPreference](#API_UpdateRegionSettings_RequestSyntax) **   <a name="Backup-UpdateRegionSettings-request-ResourceTypeOptInPreference"></a>
更新服務清單及「區域」的選擇加入偏好設定。  
如果資源指派僅以標籤為基礎，則會套用選擇加入服務設定。如果將資源類型明確指派給備份計畫 (例如 Amazon S3、Amazon EC2 或 Amazon RDS)，即使該特定服務未啟用選擇加入，該資源類型也會包含在備份中。如果在資源指派中同時指定了資源類型和標籤，則備份計畫中指定的資源類型將優先於標籤條件。在此情況下，會忽略選擇加入服務設定。  
類型：字串到布林值映射  
金鑰模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
必要：否

## 回應語法
<a name="API_UpdateRegionSettings_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 回應元素
<a name="API_UpdateRegionSettings_ResponseElements"></a>

如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。

## 錯誤
<a name="API_UpdateRegionSettings_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_UpdateRegionSettings_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/UpdateRegionSettings) 

# UpdateReportPlan
<a name="API_UpdateReportPlan"></a>

更新指定的報告計畫。

## 請求語法
<a name="API_UpdateReportPlan_RequestSyntax"></a>

```
PUT /audit/report-plans/reportPlanName HTTP/1.1
Content-type: application/json

{
   "IdempotencyToken": "string",
   "ReportDeliveryChannel": { 
      "Formats": [ "string" ],
      "S3BucketName": "string",
      "S3KeyPrefix": "string"
   },
   "ReportPlanDescription": "string",
   "ReportSetting": { 
      "Accounts": [ "string" ],
      "FrameworkArns": [ "string" ],
      "NumberOfFrameworks": number,
      "OrganizationUnits": [ "string" ],
      "Regions": [ "string" ],
      "ReportTemplate": "string"
   }
}
```

## URI 請求參數
<a name="API_UpdateReportPlan_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [reportPlanName](#API_UpdateReportPlan_RequestSyntax) **   <a name="Backup-UpdateReportPlan-request-uri-ReportPlanName"></a>
報告計畫的唯一名稱。此名稱的長度必須介於 1 到 256 個字元，且開頭要為英文字母，由英文字母 (a-z、A-Z)、數字 (0-9) 和底線 (\$1) 組成。  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z][_a-zA-Z0-9]*`  
必要：是

## 請求主體
<a name="API_UpdateReportPlan_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [IdempotencyToken](#API_UpdateReportPlan_RequestSyntax) **   <a name="Backup-UpdateReportPlan-request-IdempotencyToken"></a>
客戶所選擇的字串，可用來區分在其他方面相同的 `UpdateReportPlanInput` 呼叫。重試具有相同等冪性字符的成功請求會導致出現成功消息，但未執行任何動作。  
類型：字串  
必要：否

 ** [ReportDeliveryChannel](#API_UpdateReportPlan_RequestSyntax) **   <a name="Backup-UpdateReportPlan-request-ReportDeliveryChannel"></a>
有關在何處交付報告的資訊，特別是您的 Amazon S3 儲存貯體名稱、S3 金鑰字首和報告格式。  
類型：[ReportDeliveryChannel](API_ReportDeliveryChannel.md) 物件  
必要：否

 ** [ReportPlanDescription](#API_UpdateReportPlan_RequestSyntax) **   <a name="Backup-UpdateReportPlan-request-ReportPlanDescription"></a>
報告計劃的選用描述，最多可包含 1,024 個字元。  
類型：字串  
長度限制：長度下限為 0。長度上限為 1024。  
模式：`.*\S.*`  
必要：否

 ** [ReportSetting](#API_UpdateReportPlan_RequestSyntax) **   <a name="Backup-UpdateReportPlan-request-ReportSetting"></a>
報告的報告範本。使用報告範本建立的報告。報告範本包括：  
 `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT`   
如果報告範本是 `RESOURCE_COMPLIANCE_REPORT`或 `CONTROL_COMPLIANCE_REPORT`，此 API 資源也會描述 AWS 區域 和 架構的報告涵蓋範圍。  
類型：[ReportSetting](API_ReportSetting.md) 物件  
必要：否

## 回應語法
<a name="API_UpdateReportPlan_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreationTime": number,
   "ReportPlanArn": "string",
   "ReportPlanName": "string"
}
```

## 回應元素
<a name="API_UpdateReportPlan_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [CreationTime](#API_UpdateReportPlan_ResponseSyntax) **   <a name="Backup-UpdateReportPlan-response-CreationTime"></a>
建立報告計劃時的日期和時間，以 Unix 格式和國際標準時間 (UTC) 顯示。`CreationTime` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [ReportPlanArn](#API_UpdateReportPlan_ResponseSyntax) **   <a name="Backup-UpdateReportPlan-response-ReportPlanArn"></a>
可唯一識別資源的 Amazon Resource Name (ARN)。ARN 的格式取決於資源類型。  
類型：字串

 ** [ReportPlanName](#API_UpdateReportPlan_ResponseSyntax) **   <a name="Backup-UpdateReportPlan-response-ReportPlanName"></a>
報告計畫的唯一名稱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`[a-zA-Z][_a-zA-Z0-9]*`

## 錯誤
<a name="API_UpdateReportPlan_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** ConflictException **   
 AWS Backup 在完成執行先前的動作之前， 無法執行您請求的動作。請稍後再試。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_UpdateReportPlan_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UpdateReportPlan) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateReportPlan) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateReportPlan) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateReportPlan) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateReportPlan) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateReportPlan) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateReportPlan) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateReportPlan) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateReportPlan) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/UpdateReportPlan) 

# UpdateRestoreTestingPlan
<a name="API_UpdateRestoreTestingPlan"></a>

此請求會將變更傳送至指定的還原測試計畫。`RestoreTestingPlanName` 建立後就無法更新。

 `RecoveryPointSelection` 可能包含：
+  `Algorithm` 
+  `ExcludeVaults` 
+  `IncludeVaults` 
+  `RecoveryPointTypes` 
+  `SelectionWindowDays` 

## 請求語法
<a name="API_UpdateRestoreTestingPlan_RequestSyntax"></a>

```
PUT /restore-testing/plans/RestoreTestingPlanName HTTP/1.1
Content-type: application/json

{
   "RestoreTestingPlan": { 
      "RecoveryPointSelection": { 
         "Algorithm": "string",
         "ExcludeVaults": [ "string" ],
         "IncludeVaults": [ "string" ],
         "RecoveryPointTypes": [ "string" ],
         "SelectionWindowDays": number
      },
      "ScheduleExpression": "string",
      "ScheduleExpressionTimezone": "string",
      "StartWindowHours": number
   }
}
```

## URI 請求參數
<a name="API_UpdateRestoreTestingPlan_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [RestoreTestingPlanName](#API_UpdateRestoreTestingPlan_RequestSyntax) **   <a name="Backup-UpdateRestoreTestingPlan-request-uri-RestoreTestingPlanName"></a>
還原測試計劃名稱的名稱。  
必要：是

## 請求主體
<a name="API_UpdateRestoreTestingPlan_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [RestoreTestingPlan](#API_UpdateRestoreTestingPlan_RequestSyntax) **   <a name="Backup-UpdateRestoreTestingPlan-request-RestoreTestingPlan"></a>
指定還原測試計畫的內文。  
類型：[RestoreTestingPlanForUpdate](API_RestoreTestingPlanForUpdate.md) 物件  
必要：是

## 回應語法
<a name="API_UpdateRestoreTestingPlan_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreationTime": number,
   "RestoreTestingPlanArn": "string",
   "RestoreTestingPlanName": "string",
   "UpdateTime": number
}
```

## 回應元素
<a name="API_UpdateRestoreTestingPlan_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [CreationTime](#API_UpdateRestoreTestingPlan_ResponseSyntax) **   <a name="Backup-UpdateRestoreTestingPlan-response-CreationTime"></a>
資源測試計畫的建立時間。  
類型：Timestamp

 ** [RestoreTestingPlanArn](#API_UpdateRestoreTestingPlan_ResponseSyntax) **   <a name="Backup-UpdateRestoreTestingPlan-response-RestoreTestingPlanArn"></a>
還原測試計畫的不重複 ARN (Amazon Resource Name)。  
類型：字串

 ** [RestoreTestingPlanName](#API_UpdateRestoreTestingPlan_ResponseSyntax) **   <a name="Backup-UpdateRestoreTestingPlan-response-RestoreTestingPlanName"></a>
此名稱建立後就不可變更。此名稱僅包含英數字元和底線。長度上限為 50。  
類型：字串

 ** [UpdateTime](#API_UpdateRestoreTestingPlan_ResponseSyntax) **   <a name="Backup-UpdateRestoreTestingPlan-response-UpdateTime"></a>
還原測試計劃的更新完成時間。  
類型：Timestamp

## 錯誤
<a name="API_UpdateRestoreTestingPlan_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** ConflictException **   
 AWS Backup 在完成執行先前的動作之前， 無法執行您請求的動作。請稍後再試。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_UpdateRestoreTestingPlan_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/UpdateRestoreTestingPlan) 

# UpdateRestoreTestingSelection
<a name="API_UpdateRestoreTestingSelection"></a>

更新指定的還原測試選擇。

您可以使用此請求更新 `RestoreTestingSelectionName` 以外的大多數元素。

您可以使用受保護的資源 ARNs或條件，但不能同時使用兩者。

## 請求語法
<a name="API_UpdateRestoreTestingSelection_RequestSyntax"></a>

```
PUT /restore-testing/plans/RestoreTestingPlanName/selections/RestoreTestingSelectionName HTTP/1.1
Content-type: application/json

{
   "RestoreTestingSelection": { 
      "IamRoleArn": "string",
      "ProtectedResourceArns": [ "string" ],
      "ProtectedResourceConditions": { 
         "StringEquals": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "StringNotEquals": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ]
      },
      "RestoreMetadataOverrides": { 
         "string" : "string" 
      },
      "ValidationWindowHours": number
   }
}
```

## URI 請求參數
<a name="API_UpdateRestoreTestingSelection_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [RestoreTestingPlanName](#API_UpdateRestoreTestingSelection_RequestSyntax) **   <a name="Backup-UpdateRestoreTestingSelection-request-uri-RestoreTestingPlanName"></a>
需要還原測試計畫名稱，才能更新指定的測試計畫。  
必要：是

 ** [RestoreTestingSelectionName](#API_UpdateRestoreTestingSelection_RequestSyntax) **   <a name="Backup-UpdateRestoreTestingSelection-request-uri-RestoreTestingSelectionName"></a>
您要更新的還原測試選取項目所需的還原測試選取項目名稱。  
必要：是

## 請求主體
<a name="API_UpdateRestoreTestingSelection_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [RestoreTestingSelection](#API_UpdateRestoreTestingSelection_RequestSyntax) **   <a name="Backup-UpdateRestoreTestingSelection-request-RestoreTestingSelection"></a>
若要更新還原測試選擇，您可以使用受保護的資源 ARN 或條件，但不能同時使用兩者。也就是說，如果您選擇 `ProtectedResourceArns`，就無法順利使用參數 `ProtectedResourceConditions` 請求更新。  
類型：[RestoreTestingSelectionForUpdate](API_RestoreTestingSelectionForUpdate.md) 物件  
必要：是

## 回應語法
<a name="API_UpdateRestoreTestingSelection_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreationTime": number,
   "RestoreTestingPlanArn": "string",
   "RestoreTestingPlanName": "string",
   "RestoreTestingSelectionName": "string",
   "UpdateTime": number
}
```

## 回應元素
<a name="API_UpdateRestoreTestingSelection_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [CreationTime](#API_UpdateRestoreTestingSelection_ResponseSyntax) **   <a name="Backup-UpdateRestoreTestingSelection-response-CreationTime"></a>
成功更新資源測試選擇的時間。  
類型：Timestamp

 ** [RestoreTestingPlanArn](#API_UpdateRestoreTestingSelection_ResponseSyntax) **   <a name="Backup-UpdateRestoreTestingSelection-response-RestoreTestingPlanArn"></a>
不重複字串，也就是還原測試計畫的名稱。  
類型：字串

 ** [RestoreTestingPlanName](#API_UpdateRestoreTestingSelection_ResponseSyntax) **   <a name="Backup-UpdateRestoreTestingSelection-response-RestoreTestingPlanName"></a>
與更新還原測試選擇相關聯的還原測試計劃。  
類型：字串

 ** [RestoreTestingSelectionName](#API_UpdateRestoreTestingSelection_ResponseSyntax) **   <a name="Backup-UpdateRestoreTestingSelection-response-RestoreTestingSelectionName"></a>
傳回的還原測試選擇名稱。  
類型：字串

 ** [UpdateTime](#API_UpdateRestoreTestingSelection_ResponseSyntax) **   <a name="Backup-UpdateRestoreTestingSelection-response-UpdateTime"></a>
針對還原測試選擇完成更新的時間。  
類型：Timestamp

## 錯誤
<a name="API_UpdateRestoreTestingSelection_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** ConflictException **   
 AWS Backup 在完成執行先前的動作之前， 無法執行您請求的動作。請稍後再試。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_UpdateRestoreTestingSelection_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UpdateRestoreTestingSelection) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateRestoreTestingSelection) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateRestoreTestingSelection) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateRestoreTestingSelection) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateRestoreTestingSelection) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateRestoreTestingSelection) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateRestoreTestingSelection) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateRestoreTestingSelection) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateRestoreTestingSelection) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/UpdateRestoreTestingSelection) 

# UpdateTieringConfiguration
<a name="API_UpdateTieringConfiguration"></a>

此請求會將變更傳送到您指定的分層組態。 建立後就`TieringConfigurationName`無法更新。

 `ResourceSelection` 可能包含：
+  `Resources` 
+  `TieringDownSettingsInDays` 
+  `ResourceType` 

## 請求語法
<a name="API_UpdateTieringConfiguration_RequestSyntax"></a>

```
PUT /tiering-configurations/tieringConfigurationName HTTP/1.1
Content-type: application/json

{
   "TieringConfiguration": { 
      "BackupVaultName": "string",
      "ResourceSelection": [ 
         { 
            "Resources": [ "string" ],
            "ResourceType": "string",
            "TieringDownSettingsInDays": number
         }
      ]
   }
}
```

## URI 請求參數
<a name="API_UpdateTieringConfiguration_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [tieringConfigurationName](#API_UpdateTieringConfiguration_RequestSyntax) **   <a name="Backup-UpdateTieringConfiguration-request-uri-TieringConfigurationName"></a>
要更新的分層組態名稱。  
模式：`^[a-zA-Z0-9_]{1,200}$`  
必要：是

## 請求主體
<a name="API_UpdateTieringConfiguration_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [TieringConfiguration](#API_UpdateTieringConfiguration_RequestSyntax) **   <a name="Backup-UpdateTieringConfiguration-request-TieringConfiguration"></a>
指定分層組態的內文。  
類型：[TieringConfigurationInputForUpdate](API_TieringConfigurationInputForUpdate.md) 物件  
必要：是

## 回應語法
<a name="API_UpdateTieringConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreationTime": number,
   "LastUpdatedTime": number,
   "TieringConfigurationArn": "string",
   "TieringConfigurationName": "string"
}
```

## 回應元素
<a name="API_UpdateTieringConfiguration_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [CreationTime](#API_UpdateTieringConfiguration_ResponseSyntax) **   <a name="Backup-UpdateTieringConfiguration-response-CreationTime"></a>
建立分層組態的日期和時間，採用 Unix 格式和國際標準時間 (UTC)。`CreationTime` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [LastUpdatedTime](#API_UpdateTieringConfiguration_ResponseSyntax) **   <a name="Backup-UpdateTieringConfiguration-response-LastUpdatedTime"></a>
更新分層組態的日期和時間，採用 Unix 格式和國際標準時間 (UTC)。`LastUpdatedTime` 的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。  
類型：Timestamp

 ** [TieringConfigurationArn](#API_UpdateTieringConfiguration_ResponseSyntax) **   <a name="Backup-UpdateTieringConfiguration-response-TieringConfigurationArn"></a>
唯一識別更新分層組態的 Amazon Resource Name (ARN)。  
類型：字串

 ** [TieringConfigurationName](#API_UpdateTieringConfiguration_ResponseSyntax) **   <a name="Backup-UpdateTieringConfiguration-response-TieringConfigurationName"></a>
此唯一字串是分層組態的名稱。  
類型：字串  
模式：`^[a-zA-Z0-9_]{1,200}$`

## 錯誤
<a name="API_UpdateTieringConfiguration_Errors"></a>

如需所有動作常見的錯誤資訊，請參閱《[常見錯誤類型](CommonErrors.md)》。

 ** AlreadyExistsException **   
所需資源已存在。    
 ** Arn **   
  
 ** Context **   
  
 ** CreatorRequestId **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ConflictException **   
 AWS Backup 在完成執行先前的動作之前， 無法執行您請求的動作。請稍後再試。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** LimitExceededException **   
請求已超過限制；例如，請求中允許的最大項目數量。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_UpdateTieringConfiguration_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UpdateTieringConfiguration) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateTieringConfiguration) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateTieringConfiguration) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateTieringConfiguration) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateTieringConfiguration) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateTieringConfiguration) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateTieringConfiguration) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateTieringConfiguration) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateTieringConfiguration) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/UpdateTieringConfiguration)