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

# AWS Backup API
<a name="api-reference"></a>

 除使用控制台外，您还可以使用 AWS Backup API 操作和数据类型，以编程方式配置和管理 AWS Backup 及其资源。本节介绍 AWS Backup 操作和数据类型。它包含 AWS Backup 的 API 参考。

**AWS Backup API**
+ [AWS Backup 操作](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_Operations.html)
+ [AWS Backup 数据类型](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_Types.html)

# 操作
<a name="API_Operations"></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) 

以下操作受以下支持 AWS Backup gateway：
+  [AssociateGatewayToServer](API_BGW_AssociateGatewayToServer.md) 
+  [CreateGateway](API_BGW_CreateGateway.md) 
+  [DeleteGateway](API_BGW_DeleteGateway.md) 
+  [DeleteHypervisor](API_BGW_DeleteHypervisor.md) 
+  [DisassociateGatewayFromServer](API_BGW_DisassociateGatewayFromServer.md) 
+  [GetBandwidthRateLimitSchedule](API_BGW_GetBandwidthRateLimitSchedule.md) 
+  [GetGateway](API_BGW_GetGateway.md) 
+  [GetHypervisor](API_BGW_GetHypervisor.md) 
+  [GetHypervisorPropertyMappings](API_BGW_GetHypervisorPropertyMappings.md) 
+  [GetVirtualMachine](API_BGW_GetVirtualMachine.md) 
+  [ImportHypervisorConfiguration](API_BGW_ImportHypervisorConfiguration.md) 
+  [ListGateways](API_BGW_ListGateways.md) 
+  [ListHypervisors](API_BGW_ListHypervisors.md) 
+  [ListTagsForResource](API_BGW_ListTagsForResource.md) 
+  [ListVirtualMachines](API_BGW_ListVirtualMachines.md) 
+  [PutBandwidthRateLimitSchedule](API_BGW_PutBandwidthRateLimitSchedule.md) 
+  [PutHypervisorPropertyMappings](API_BGW_PutHypervisorPropertyMappings.md) 
+  [PutMaintenanceStartTime](API_BGW_PutMaintenanceStartTime.md) 
+  [StartVirtualMachinesMetadataSync](API_BGW_StartVirtualMachinesMetadataSync.md) 
+  [TagResource](API_BGW_TagResource.md) 
+  [TestHypervisorConfiguration](API_BGW_TestHypervisorConfiguration.md) 
+  [UntagResource](API_BGW_UntagResource.md) 
+  [UpdateGatewayInformation](API_BGW_UpdateGatewayInformation.md) 
+  [UpdateGatewaySoftwareNow](API_BGW_UpdateGatewaySoftwareNow.md) 
+  [UpdateHypervisor](API_BGW_UpdateHypervisor.md) 

以下操作受以下支持 AWS Backup 搜索：
+  [GetSearchJob](API_BKS_GetSearchJob.md) 
+  [GetSearchResultExportJob](API_BKS_GetSearchResultExportJob.md) 
+  [ListSearchJobBackups](API_BKS_ListSearchJobBackups.md) 
+  [ListSearchJobResults](API_BKS_ListSearchJobResults.md) 
+  [ListSearchJobs](API_BKS_ListSearchJobs.md) 
+  [ListSearchResultExportJobs](API_BKS_ListSearchResultExportJobs.md) 
+  [ListTagsForResource](API_BKS_ListTagsForResource.md) 
+  [StartSearchJob](API_BKS_StartSearchJob.md) 
+  [StartSearchResultExportJob](API_BKS_StartSearchResultExportJob.md) 
+  [StopSearchJob](API_BKS_StopSearchJob.md) 
+  [TagResource](API_BKS_TagResource.md) 
+  [UntagResource](API_BKS_UntagResource.md) 

# 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 资源名称（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>

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

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/CancelLegalHold) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CancelLegalHold) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CancelLegalHold) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CancelLegalHold) 
+  [AWS Python 软件开发工具包](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 资源名称 (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。  
类型：时间戳

 ** [VersionId](#API_CreateBackupPlan_ResponseSyntax) **   <a name="Backup-CreateBackupPlan-response-VersionId"></a>
唯一的、随机生成的、Unicode、UTF-8 编码字符串，长度最大为 1024 个字节。无法对其进行编辑。  
类型：字符串

## 错误
<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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/CreateBackupPlan) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateBackupPlan) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CreateBackupPlan) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateBackupPlan) 
+  [AWS Python 软件开发工具包](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 文档，指定要分配给备份计划的一组资源。有关示例，请参阅[以编程方式分配资源](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。  
类型：时间戳

 ** [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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/CreateBackupSelection) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateBackupSelection) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateBackupSelection) 
+  [AWS Python 软件开发工具包](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 资源名称 (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。  
类型：时间戳

## 错误
<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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/CreateBackupVault) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateBackupVault) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateBackupVault) 
+  [AWS Python 软件开发工具包](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>
框架的可选描述，最多 1024 个字符。  
类型：字符串  
长度限制：最小长度为 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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/CreateFramework) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateFramework) 
+  [AWS 适用于 Java 的 SDK 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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateFramework) 
+  [AWS Python 软件开发工具包](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>
法定保留的创建时间。  
类型：时间戳

 ** [Description](#API_CreateLegalHold_ResponseSyntax) **   <a name="Backup-CreateLegalHold-response-Description"></a>
法定保留的描述。  
类型：字符串

 ** [LegalHoldArn](#API_CreateLegalHold_ResponseSyntax) **   <a name="Backup-CreateLegalHold-response-LegalHoldArn"></a>
法定保留的 Amazon 资源名称（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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/CreateLegalHold) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateLegalHold) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateLegalHold) 
+  [AWS Python 软件开发工具包](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，用于加密逻辑上存在气隙的备份保管库。如果未指定，则将使用由 Back AWS up 管理的 AWS自有密钥对保管库进行加密。  
类型：字符串  
必需：否

 ** [MaxRetentionDays](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **   <a name="Backup-CreateLogicallyAirGappedBackupVault-request-MaxRetentionDays"></a>
保管库保留其恢复点的最长保留期。  
类型：长整型  
是否必需：是

 ** [MinRetentionDays](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **   <a name="Backup-CreateLogicallyAirGappedBackupVault-request-MinRetentionDays"></a>
此设置用于指定保管库保留其恢复点的最短保留期。  
接受的最小值为 7 天。  
类型：长整型  
是否必需：是

## 响应语法
<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 资源名称）。  
类型：字符串

 ** [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。  
类型：时间戳

 ** [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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/CreateLogicallyAirGappedBackupVault) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateLogicallyAirGappedBackupVault) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CreateLogicallyAirGappedBackupVault) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateLogicallyAirGappedBackupVault) 
+  [AWS Python 软件开发工具包](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>
报告计划的可选描述，最多 1024 个字符。  
类型：字符串  
长度限制：最小长度为 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。  
类型：时间戳

 ** [ReportPlanArn](#API_CreateReportPlan_ResponseSyntax) **   <a name="Backup-CreateReportPlan-response-ReportPlanArn"></a>
唯一标识资源的 Amazon 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/CreateReportPlan) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateReportPlan) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CreateReportPlan) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateReportPlan) 
+  [AWS Python 软件开发工具包](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 格式和协调世界时（UTC）   
类型：时间戳

 ** [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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/CreateRestoreAccessBackupVault) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateRestoreAccessBackupVault) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateRestoreAccessBackupVault) 
+  [AWS Python 软件开发工具包](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。  
类型：时间戳

 ** [RestoreTestingPlanArn](#API_CreateRestoreTestingPlan_ResponseSyntax) **   <a name="Backup-CreateRestoreTestingPlan-response-RestoreTestingPlanArn"></a>
可唯一标识已创建的还原测试计划的 Amazon 资源名称（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>

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

每种受保护的资源类型可以具有一个单一值。

还原测试选择可以包括带通配符值（“\$1”）的 `ProtectedResourceArns` 以及 `ProtectedResourceConditions`。或者，您最多可以在其中包含 30 个特定的受保护资源 ARNs `ProtectedResourceArns`。

无法同时按受保护的资源类型和特定资源类型进行选择 ARNs。如果同时使用两者，则请求将失败。

## 请求语法
<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` 
每种受保护的资源类型可以具有一个单一值。  
还原测试选择可以包括带通配符值（“\$1”）的 `ProtectedResourceArns` 以及 `ProtectedResourceConditions`。或者，您最多可以在其中包含 30 个特定的受保护资源 ARNs `ProtectedResourceArns`。  
类型：[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>
资源测试选择的创建时间。  
类型：时间戳

 ** [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>

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

 ** [TieringConfigurationArn](#API_CreateTieringConfiguration_ResponseSyntax) **   <a name="Backup-CreateTieringConfiguration-response-TieringConfigurationArn"></a>
Amazon 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/CreateTieringConfiguration) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateTieringConfiguration) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CreateTieringConfiguration) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateTieringConfiguration) 
+  [AWS Python 软件开发工具包](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 资源名称 (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。  
类型：时间戳

 ** [VersionId](#API_DeleteBackupPlan_ResponseSyntax) **   <a name="Backup-DeleteBackupPlan-response-VersionId"></a>
唯一的、随机生成的、Unicode、UTF-8 编码字符串，长度最大为 1024 个字节。版本 IDs 无法编辑。  
类型：字符串

## 错误
<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>

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

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

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

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DeleteBackupVaultAccessPolicy) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DeleteBackupVaultAccessPolicy) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DeleteBackupVaultAccessPolicy) 
+  [AWS Python 软件开发工具包](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 库名称指定的备份保管库中删除文件库锁。

如果保管库锁定配置不可变，则无法使用 API 操作删除保管库锁定，且您将在尝试此操作时收到 `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>

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

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

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

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

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

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

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

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DeleteTieringConfiguration) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DeleteTieringConfiguration) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DeleteTieringConfiguration) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DeleteTieringConfiguration) 
+  [AWS Python 软件开发工具包](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 通过异步工作流程传递给，这可能意味着此显示的值可能低估了实际备份大小。
类型：长整型

 ** [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 资源名称 (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>
查询作业状态时传输到备份保管库的大小（以字节为单位）。  
类型：长整型

 ** [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。  
类型：时间戳

 ** [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。  
类型：时间戳

 ** [EncryptionKeyArn](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-EncryptionKeyArn"></a>
用于加密备份的 KMS 密钥的 Amazon 资源名称（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。  
类型：时间戳

 ** [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>
备份作业的启动日期。  
类型：时间戳

 ** [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>
这将返回子（嵌套）备份作业的数量。  
类型：长整型

 ** [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` 和 `DeleteAfterDays` 指定 -1。  
类型：[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 EBS) Block Store 卷或亚马逊关系数据库服务 (Amazon RDS) 数据库。  
类型：字符串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`

 ** [StartBy](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-StartBy"></a>
采用 Unix 格式和协调世界时 (UTC)，指定备份作业必须在取消改作业之前多久启动。该值通过将启动时段与计划时间相加进行计算。因此，如果计划时间为下午 6:00，启动时段为 2 小时，则 `StartBy` 时间为指定日期的晚上 8:00。`StartBy` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳

 ** [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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeBackupJob) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeBackupJob) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeBackupJob) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeBackupJob) 
+  [AWS Python 软件开发工具包](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 资源名称 (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。  
类型：时间戳

 ** [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，对于客户管理的密钥，有效值为 \$1OWNED\$1KMS\$1KEY。 AWS AWS  
类型：字符串  
有效值：`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 文件库锁定配置的日期和时间。  
如果您在未指定锁定日期的情况下对保管库应用了保管库锁定，则可以随时更改任何保管库锁定设置，或从保管库中完全删除保管库锁定。  
该值采用 Unix 格式和协调世界时 (UTC)，精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳

 ** [Locked](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-Locked"></a>
一个布尔值，用于指示 AWS Backup Vault Lock 当前是否在保护备份存储库。 `True`意味着文件库锁定会导致对存储在保管库中的恢复点执行删除或更新操作失败。  
类型：布尔值

 ** [MaxRetentionDays](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-MaxRetentionDays"></a>
 AWS Backup 文件库锁定设置，用于指定文件库保留其恢复点的最大保留期。如果不指定此参数，则保管库锁定不会对保管库中的恢复点强制规定最长保留期（允许无限期存储）。  
如果指定了此参数，则备份或复制到保管库的任何作业都必须具有生命周期策略，其保留期等于或小于最长保留期。如果作业的保留期长于该最长保留期，则保管库将无法执行该备份或复制作业，因此您应该修改生命周期设置或使用其他保管库。保管库锁定之前已存储在保管库中的恢复点不受影响。  
类型：长整型

 ** [MinRetentionDays](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-MinRetentionDays"></a>
 AWS Backup 文件库锁定设置，用于指定文件库保留其恢复点的最短保留期。如果未指定此参数，保管库锁定将不会强制规定最短保留期。  
如果指定了此参数，则备份或复制到保管库的任何作业都必须具有生命周期策略，其保留期等于或大于最短保留期。如果作业的保留期短于该最短保留期，则保管库将无法执行该备份或复制作业，因此，您应该修改生命周期设置或使用其他保管库。保管库锁定之前已存储在保管库中的恢复点不受影响。  
类型：长整型

 ** [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 来获取确切的计数。  
类型：长整型

 ** [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>

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

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeCopyJob) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeCopyJob) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeCopyJob) 
+  [AWS Python 软件开发工具包](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:00，比 UTC 晚 8 个小时。  
类型：时间戳

 ** [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 资源名称 (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`wh AWS Backup en 此时无法验证录制状态。
类型：字符串

 ** [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>

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

## 错误
<a name="API_DescribeGlobalSettings_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** InvalidRequestException **   
表示请求的输入有问题。例如，参数的类型错误。    
 ** Context **   
  
 ** Type **   

HTTP 状态代码：400

 ** ServiceUnavailableException **   
由于服务器发生临时故障而导致请求失败。    
 ** Context **   
  
 ** Type **   

HTTP 状态代码：500

## 另请参阅
<a name="API_DescribeGlobalSettings_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeGlobalSettings) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeGlobalSettings) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeGlobalSettings) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeGlobalSettings) 
+  [AWS Python 软件开发工具包](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 资源名称 (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 资源名称 (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。  
类型：时间戳

 ** [LastBackupVaultArn](#API_DescribeProtectedResource_ResponseSyntax) **   <a name="Backup-DescribeProtectedResource-response-LastBackupVaultArn"></a>
包含最新备份恢复点的备份保管库的 ARN（Amazon 资源名称）。  
类型：字符串

 ** [LastRecoveryPointArn](#API_DescribeProtectedResource_ResponseSyntax) **   <a name="Backup-DescribeProtectedResource-response-LastRecoveryPointArn"></a>
最新恢复点的 ARN（Amazon 资源名称）。  
类型：字符串

 ** [LatestRestoreExecutionTimeMinutes](#API_DescribeProtectedResource_ResponseSyntax) **   <a name="Backup-DescribeProtectedResource-response-LatestRestoreExecutionTimeMinutes"></a>
完成最新还原作业所需的时间（以分钟为单位）。  
类型：长整型

 ** [LatestRestoreJobCreationDate](#API_DescribeProtectedResource_ResponseSyntax) **   <a name="Backup-DescribeProtectedResource-response-LatestRestoreJobCreationDate"></a>
最新还原作业的创建日期。  
类型：时间戳

 ** [LatestRestoreRecoveryPointCreationDate](#API_DescribeProtectedResource_ResponseSyntax) **   <a name="Backup-DescribeProtectedResource-response-LatestRestoreRecoveryPointCreationDate"></a>
最新恢复点的创建日期。  
类型：时间戳

 ** [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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeProtectedResource) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeProtectedResource) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeProtectedResource) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeProtectedResource) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>
备份的大小（以字节为单位）。  
类型：长整型

 ** [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。  
类型：时间戳

 ** [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。  
类型：时间戳

 ** [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，对于客户管理的密钥，有效值为 \$1OWNED\$1KMS\$1KEY。 AWS AWS  
类型：字符串  
有效值：`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）。  
类型：时间戳

 ** [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。  
类型：时间戳

 ** [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 EBS) Block Store 卷或亚马逊关系数据库服务 (Amazon RDS) 数据库。  
类型：字符串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`

 ** [ScanResults](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-ScanResults"></a>
包含针对恢复点的最新扫描结果，当前包括`MalwareScanner``ScanJobState`、`Findings`、和 `LastScanTimestamp`   
类型：[ScanResult](API_ScanResult.md) 对象数组  
数组成员：最少 0 个物品。最多 5 项。

 ** [SourceBackupVaultArn](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-SourceBackupVaultArn"></a>
唯一标识资源最初备份的源保管库的 Amazon 资源名称 (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`status 表示已为资源启动 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 存储桶上启用版本控制。满足这些条件后，下一个运行的备份规则实例将导致创建新的连续恢复点。不需要删除处于 STOPPED 状态的恢复点。

  对于 SAP HANA，Amazon 上的 EC2`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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeRecoveryPoint) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeRecoveryPoint) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeRecoveryPoint) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeRecoveryPoint) 
+  [AWS Python 软件开发工具包](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的](https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html#advanced-ddb-backup-enable-cli)完全 AWS Backup 管理。  
类型：字符串到布尔映射  
键模式：`^[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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeRegionSettings) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeRegionSettings) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeRegionSettings) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeRegionSettings) 
+  [AWS Python 软件开发工具包](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 编码字符串，长度最大为 1024 个字节。无法编辑报告作业 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 资源名称（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>

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

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeReportPlan) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeReportPlan) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeReportPlan) 
+  [AWS Python 软件开发工具包](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>
还原资源的大小（以字节为单位）。  
类型：长整型

 ** [BackupVaultArn](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-BackupVaultArn"></a>
包含正在恢复的恢复点的备份保管库的 Amazon 资源名称（ARN）。此值有助于确定保管库访问策略和权限。  
类型：字符串

 ** [CompletionDate](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-CompletionDate"></a>
恢复点还原作业的完成日期和时间，采用 Unix 格式和协调世界时 (UTC)。`CompletionDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳

 ** [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 资源名称（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。  
类型：时间戳

 ** [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>
恢复点还原作业预计要花费的时间（以分钟为单位）。  
类型：长整型

 ** [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>
指定还原作业创建恢复点的日期。  
类型：时间戳

 ** [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 资源名称（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>

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

返回指定 ScanJob ID 的扫描任务详细信息。

## 请求语法
<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 资源名称 (ARN)；例如，`arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`  
类型：字符串

 ** [BackupVaultName](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-BackupVaultName"></a>
用于存储备份的逻辑容器的名称。Backup 存储库由用于创建备份存储库的账户和创建备份存储库的 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。  
类型：时间戳

 ** [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。  
类型：时间戳

 ** [IamRoleArn](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-IamRoleArn"></a>
唯一标识备份保管库的 Amazon 资源名称 (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 资源类型；例如，亚马逊 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 为相应的 Scan Job 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>
 包含扫描任务和返回的`THREATS_FOUND`或已完成任务`NO_THREATS_FOUND`的。`ScanResultsStatus`  
类型：[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>

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

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

从源服务（例如 Amazon RDS）中删除指定的连续备份恢复点， AWS Backup 并释放对该持续备份的控制权。源服务将继续使用您在原始备份计划中指定的生命周期创建和保留连续备份。

不支持快照备份恢复点。

## 请求语法
<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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DisassociateRecoveryPoint) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DisassociateRecoveryPoint) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DisassociateRecoveryPoint) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DisassociateRecoveryPoint) 
+  [AWS Python 软件开发工具包](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>
存储子（嵌套）恢复点的逻辑容器的名称。Backup 存储库由用于创建备份存储库的账户和创建备份存储库的 AWS 区域所特有的名称进行标识。  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
是否必需：是

 ** [recoveryPointArn](#API_DisassociateRecoveryPointFromParent_RequestSyntax) **   <a name="Backup-DisassociateRecoveryPointFromParent-request-uri-RecoveryPointArn"></a>
唯一标识子（嵌套）恢复点的 Amazon 资源名称（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>

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

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

返回指定 `BackupPlan` 的 `BackupPlanId` 详细信息。详细信息包含 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 编码字符串，长度最大为 1024 个字节。版本 IDs 无法编辑。

## 请求正文
<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 资源名称 (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。  
类型：时间戳

 ** [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。  
类型：时间戳

 ** [LastExecutionDate](#API_GetBackupPlan_ResponseSyntax) **   <a name="Backup-GetBackupPlan-response-LastExecutionDate"></a>
上次运行此备份计划的时间。日期和时间，采用 Unix 格式和协调世界时 (UTC)。`LastExecutionDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳

 ** [ScheduledRunsPreview](#API_GetBackupPlan_ResponseSyntax) **   <a name="Backup-GetBackupPlan-response-ScheduledRunsPreview"></a>
即将进行的计划备份运行列表。仅当 `MaxScheduledRunsPreview` 参数大于 0 时包含此值。包含最多 10 个 future 备份执行及其计划时间、执行类型和关联规则 IDs。  
类型：[ScheduledPlanExecutionMember](API_ScheduledPlanExecutionMember.md) 对象数组

 ** [VersionId](#API_GetBackupPlan_ResponseSyntax) **   <a name="Backup-GetBackupPlan-response-VersionId"></a>
唯一的、随机生成的、Unicode、UTF-8 编码字符串，长度最大为 1024 个字节。版本 IDs 无法编辑。  
类型：字符串

## 错误
<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>

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

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

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/GetBackupPlanFromTemplate) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetBackupPlanFromTemplate) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetBackupPlanFromTemplate) 
+  [AWS Python 软件开发工具包](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。  
类型：时间戳

 ** [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>

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

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

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/GetBackupVaultNotifications) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetBackupVaultNotifications) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetBackupVaultNotifications) 
+  [AWS Python 软件开发工具包](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>
法定保留的取消时间。  
类型：时间戳

 ** [CreationDate](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-CreationDate"></a>
法定保留的创建时间。  
类型：时间戳

 ** [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>
法定保留记录的保留截止日期和时间。  
类型：时间戳

 ** [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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/GetLegalHold) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetLegalHold) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetLegalHold) 
+  [AWS Python 软件开发工具包](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。  
类型：时间戳

 ** [IndexCreationDate](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **   <a name="Backup-GetRecoveryPointIndexDetails-response-IndexCreationDate"></a>
备份索引的创建日期和时间，采用 Unix 时间格式和协调世界时（UTC）。`CreationDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳

 ** [IndexDeletionDate](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **   <a name="Backup-GetRecoveryPointIndexDetails-response-IndexDeletionDate"></a>
备份索引的删除日期和时间，采用 Unix 时间格式和协调世界时（UTC）。`CreationDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳

 ** [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 资源名称（ARN）字符串，用于唯一标识源资源。  
类型：字符串

 ** [TotalItemsIndexed](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **   <a name="Backup-GetRecoveryPointIndexDetails-response-TotalItemsIndexed"></a>
与恢复点关联的备份索引中的项目数。  
类型：长整型

## 错误
<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>

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

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

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/GetRestoreJobMetadata) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetRestoreJobMetadata) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetRestoreJobMetadata) 
+  [AWS Python 软件开发工具包](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>
用于存储备份的逻辑容器的名称。Backup 存储库由用于创建备份存储库的账户和创建备份存储库的 AWS区域所特有的名称进行标识。它们包含字母、数字和连字符。  
是否必需：是

 ** [RecoveryPointArn](#API_GetRestoreTestingInferredMetadata_RequestSyntax) **   <a name="Backup-GetRestoreTestingInferredMetadata-request-uri-RecoveryPointArn"></a>
唯一标识恢复点的 Amazon 资源名称 (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>

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

返回指定 `RestoreTestingPlan` 的 `RestoreTestingPlanName` 详细信息。详细信息包含 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>

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

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS Python 软件开发工具包](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 资源类型的字符串：  
+  适用于 Amazon Aurora 的 `Aurora`
+  `CloudFormation`对于 AWS CloudFormation 
+  适用于 Amazon DocumentDB（与 MongoDB 兼容）的 `DocumentDB`
+  `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
+  适用于 Amazon Neptune 的 `Neptune`
+  适用于 Amazon Relational Database Service 的 `RDS`
+  适用于 Amazon Redshift `Redshift`
+  `S3`：表示 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>

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

返回指定 `TieringConfiguration` 的 `TieringConfigurationName` 详细信息。除配置元数据外，详细信息还是 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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS Python 软件开发工具包](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 资源名称 (ARN) 匹配的备份作业。

 ** [ByResourceType](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByResourceType"></a>
仅返回指定资源的备份作业：  
+  适用于 Amazon Aurora 的 `Aurora`
+  `CloudFormation`对于 AWS CloudFormation 
+  适用于 Amazon DocumentDB（与 MongoDB 兼容）的 `DocumentDB`
+  `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`适用于亚马逊 FSx
+  适用于 Amazon Neptune 的 `Neptune`
+  适用于 Amazon Relational Database Service 的 `RDS`
+  适用于 Amazon Redshift `Redshift`
+  `S3`：表示 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` 和 `MessageCategory` 且值不是 `SUCCESS` 的作业，即，状态为已完成但带有状态消息的作业。  
要获取 `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>

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

此请求返回包含区域、账户、州、、 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>
返回指定账户的作业计数。  
如果请求是从成员账户或不属于 Organizations 的 AWS 账户发送的，则将返回申请者账户中的职位。  
根账户、管理员和委派管理员账户可以使用值 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`。有关可接受 MessageCategory 字符串的列表，请参阅[监控](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html)。  
值 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 EBS) Block Store 卷或亚马逊关系数据库服务 (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` 和 `MessageCategory` 且值不是 `SUCCESS` 的作业，即，状态为已完成但带有状态消息的作业。要获取 `Completed with issues` 的作业计数，请运行两个 GET 请求，然后减去第二个较小的数字：  
GET /audit/？backup-job-summaries AggregationPeriod=fourteen\$1days&state=已完成  
GET /audit/？backup-job-summaries AggregationPeriod=FOURTEEN\$1DAYS& =成功&状态= MessageCategory 已完成  
有效值：`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>

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

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

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS Python 软件开发工具包](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 资源名称 (ARNs)、备份计划 IDs、创建和删除日期、计划名称和版本 IDs。

## 请求语法
<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>

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

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

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListBackupVaults) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListBackupVaults) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListBackupVaults) 
+  [AWS Python 软件开发工具包](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 资源名称 (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 资源名称 (ARN) 匹配的复制作业。

 ** [ByResourceType](#API_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-request-uri-ByResourceType"></a>
仅返回指定资源的备份作业：  
+  适用于 Amazon Aurora 的 `Aurora`
+  `CloudFormation`对于 AWS CloudFormation 
+  适用于 Amazon DocumentDB（与 MongoDB 兼容）的 `DocumentDB`
+  `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`适用于亚马逊 FSx
+  适用于 Amazon Neptune 的 `Neptune`
+  适用于 Amazon Relational Database Service 的 `RDS`
+  适用于 Amazon Redshift `Redshift`
+  `S3`：表示 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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListCopyJobs) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListCopyJobs) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListCopyJobs) 
+  [AWS Python 软件开发工具包](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 或来筛选结果。

此请求返回包含区域、账户、州、、 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>
返回指定账户的作业计数。  
如果请求是从成员账户或不属于 Organizations 的 AWS 账户发送的，则将返回申请者账户中的职位。  
根账户、管理员和委派管理员账户可以使用值 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`。有关可接受 MessageCategory 字符串的列表，请参阅[监控](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html)。  
值 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 EBS) Block Store 卷或亚马逊关系数据库服务 (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>
此返回结果显示的摘要包含区域、账户、州 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>

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

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

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

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

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

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS Python 软件开发工具包](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 资源名称 (ARN) 匹配的恢复点。

 ** [ByResourceArn](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-request-uri-ByResourceArn"></a>
仅返回与指定资源 Amazon 资源名称 (ARN) 匹配的恢复点。

 ** [ByResourceType](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-request-uri-ByResourceType"></a>
仅返回与指定资源类型匹配的恢复点。  
+  适用于 Amazon Aurora 的 `Aurora`
+  `CloudFormation`对于 AWS CloudFormation 
+  适用于 Amazon DocumentDB（与 MongoDB 兼容）的 `DocumentDB`
+  `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`适用于亚马逊 FSx
+  适用于 Amazon Neptune 的 `Neptune`
+  适用于 Amazon Relational Database Service 的 `RDS`
+  适用于 Amazon Redshift `Redshift`
+  `S3`：表示 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>

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

此操作将返回指定合法保留的恢复点 ARNs （Amazon 资源名称）。

## 请求语法
<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>

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

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

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

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

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS Python 软件开发工具包](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>
包含此参数可仅返回指定资源的还原作业：  
+  适用于 Amazon Aurora 的 `Aurora`
+  `CloudFormation`对于 AWS CloudFormation 
+  适用于 Amazon DocumentDB（与 MongoDB 兼容）的 `DocumentDB`
+  `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
+  适用于 Amazon Neptune 的 `Neptune`
+  适用于 Amazon Relational Database Service 的 `RDS`
+  适用于 Amazon Redshift `Redshift`
+  `S3`：表示 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 资源名称（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>

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

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS Python 软件开发工具包](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 或来筛选结果。

此请求返回包含区域、账户、州、、 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>
返回指定账户的作业计数。  
如果请求是从成员账户或不属于 Organizations 的 AWS 账户发送的，则将返回申请者账户中的职位。  
根账户、管理员和委派管理员账户可以使用值 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 EBS) Block Store 卷或亚马逊关系数据库服务 (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>
此返回包含区域、账户、州、、 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>

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

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

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS Python 软件开发工具包](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 关联的备份作业。  
如果从 Organi AWS zations 管理账户中使用，则传递`*`会返回整个组织中的所有作业。  
模式：`^[0-9]{12}$`

 ** [ByBackupVaultName](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByBackupVaultName"></a>
仅返回将存储在指定备份库中的扫描任务。Backup 存储库由用于创建备份存储库的账户和创建备份存储库的 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 资源名称 (ARN) 匹配的扫描任务。

 ** [ByResourceType](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByResourceType"></a>
按指定的还原测试计划名称返回还原测试选择。  
+  `EBS`适用于 Amazon 弹性区块存储
+  `EC2`适用于 Amazon 弹性计算云
+  `S3`适用于亚马逊简单存储服务 (Amazon S3) Simple Service
模式：`^[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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListScanJobs) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListScanJobs) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListScanJobs) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListScanJobs) 
+  [AWS Python 软件开发工具包](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>
返回指定账户的作业计数。  
如果请求是从成员账户或不属于 Organizations 的 AWS 账户发送的，则将返回申请者账户中的职位。  
root、管理员和委派管理员账户可以使用该值`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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS Python 软件开发工具包](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 恢复点的 Amazon 资源名称（ARN）以 `arn:aws:backup` 开头。未启用高级设置的 DynamoDB 恢复点（备份）的 ARN 以 `arn:aws:dynamodb` 开头。

当调用此操作时，如果包含的 `resourceArn` 值的 ARN 不是 `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 资源名称 (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>

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

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

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS Python 软件开发工具包](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 文件库锁定应用于备份保管库，防止尝试删除存储在备份保管库中或在备份保管库中创建的任何恢复点。保管库锁定还可以防止尝试更新生命周期策略，该策略控制当前存储在备份保管库中的任何恢复点的保留期。如果指定，保管库锁定功能将为后续针对备份保管库的备份和复制任务强制规定最小和最大保留期。

**注意**  
 AWS Backup Cohasset Associates已对Vault Lock进行了评估，适用于受美国证券交易委员会17a-4、美国商品期货交易委员会和美国金融监管局法规约束的环境。有关 AWS Backup Vault Lock 与这些法规的关系的更多信息，请参阅 [Cohasset Associates 合规性评估](https://docs.aws.amazon.com/aws-backup/latest/devguide/samples/cohassetreport.zip)。

相关详情，请参阅 [AWS Backup 保管库锁定](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 文件库锁定配置，用于指定锁定日期之前的天数。例如，在世界标准时间 2022 年 1 月 1 日晚上 8 点将 `ChangeableForDays` 设置为 30 会将锁定日期设置为世界标准时间 2022 年 1 月 31 日晚上 8 点。  
 AWS Backup 在 Vault Lock 生效并变为不可变之前，强制执行 72 小时的冷却期。因此，您必须将 `ChangeableForDays` 设置为 3 或更大。  
您可以指定的最大值为 36,500 天（大约 100 年）。  
在锁定日期之前，您可以使用 `DeleteBackupVaultLockConfiguration` 从保管库中删除保管库锁定，或使用 `PutBackupVaultLockConfiguration` 更改保管库锁定配置。在锁定日期及之后，保管库锁定将变为不可变且无法更改或删除。  
如果未指定此参数，您可以使用 `DeleteBackupVaultLockConfiguration` 从保管库中删除保管库锁定，或者使用 `PutBackupVaultLockConfiguration` 随时更改保管库锁定配置。  
类型：长整型  
必需：否

 ** [MaxRetentionDays](#API_PutBackupVaultLockConfiguration_RequestSyntax) **   <a name="Backup-PutBackupVaultLockConfiguration-request-MaxRetentionDays"></a>
 AWS Backup 文件库锁定配置，用于指定保管库保留其恢复点的最大保留期。例如，如果贵企业的策略要求您在某些数据保留四年（1460 天）后将其销毁，则此设置非常有用。  
如果不包括此参数，则保管库锁定不会对保管库中的恢复点强制规定最长保留期。如果包含此参数但没有值，保管库锁定将不会强制规定最长保留期。  
如果指定了此参数，则保管库的任何备份或复制作业都必须具有生命周期策略，其保留期等于或小于最长保留期。如果作业的保留期长于该最长保留期，则保管库将无法执行该备份或复制作业，因此您应该修改生命周期设置或使用其他保管库。您可以指定的最长保留期为 36500 天（大约 100 年）。保管库锁定之前已保存在保管库中的恢复点不受影响。  
类型：长整型  
必需：否

 ** [MinRetentionDays](#API_PutBackupVaultLockConfiguration_RequestSyntax) **   <a name="Backup-PutBackupVaultLockConfiguration-request-MinRetentionDays"></a>
 AWS Backup 文件库锁定配置，用于指定保管库保留其恢复点的最短保留期。例如，如果贵企业的策略要求您将某些数据至少保留七年（2555 天），则此设置非常有用。  
通过创建文件库锁时，此参数是必需的 AWS CloudFormation；否则，此参数是可选的。如果未指定此参数，保管库锁定将不会强制规定最短保留期。  
如果指定了此参数，则保管库的任何备份或复制作业都必须具有生命周期策略，其保留期等于或大于最短保留期。如果作业的保留期短于该最短保留期，则保管库将无法执行该备份或复制作业，因此您应该修改生命周期设置或使用其他保管库。您可以指定的最短保留期为 1 天。保管库锁定之前已保存在保管库中的恢复点不受影响。  
类型：长整型  
必需：否

## 响应语法
<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>

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

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

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

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS Python 软件开发工具包](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 分钟）。  
类型：长整型  
必需：否

 ** [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`：表示 Amazon Simple Storage Service（Amazon S3）
索引可能取两个值中的一个，可以是 `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 资源名称 (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`（预计在启动窗口时间结束时发生）。  
类型：长整型  
必需：否

## 响应语法
<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。  
类型：时间戳

 ** [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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/StartBackupJob) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/StartBackupJob) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/StartBackupJob) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/StartBackupJob) 
+  [AWS Python 软件开发工具包](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 资源名称 (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` 和 `DeleteAfterDays` 指定 -1。  
类型：[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-1 B5E7-9EB0-435A-A80B-108B488B0D45。EB3  
类型：字符串  
是否必需：是

 ** [SourceBackupVaultName](#API_StartCopyJob_RequestSyntax) **   <a name="Backup-StartCopyJob-request-SourceBackupVaultName"></a>
用于存储备份的逻辑源容器的名称。Backup 存储库由用于创建备份存储库的账户和创建备份存储库的 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。  
类型：时间戳

 ** [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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/StartCopyJob) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/StartCopyJob) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/StartCopyJob) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/StartCopyJob) 
+  [AWS Python 软件开发工具包](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 编码字符串，长度最大为 1024 个字节。无法编辑报告作业 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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/StartReportJob) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/StartReportJob) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/StartReportJob) 
+  [AWS Python 软件开发工具包](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 资源名称 (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 角色的亚马逊资源名称 (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) 
+  [亚马逊 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`-亚马逊 Elastic Kubernetes Service
+  `FSx`-亚马逊 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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/StartRestoreJob) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/StartRestoreJob) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/StartRestoreJob) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/StartRestoreJob) 
+  [AWS Python 软件开发工具包](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>
用于存储备份的逻辑容器的名称。Backup 存储库由用于创建备份存储库的账户和创建备份存储库的 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>
唯一标识恢复点的亚马逊资源名称 (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。  
类型：时间戳

 ** [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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/StartScanJob) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/StartScanJob) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/StartScanJob) 
+  [AWS Python 软件开发工具包](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（兼容 MongoDB）
+ 亚马逊 f FSx or Lustre
+  FSx 适用于 NetApp ONTAP 的亚马逊
+  FSx 适用于 OpenZFS 的亚马逊
+  FSx 适用于 Windows 文件服务器的亚马逊
+ Amazon Neptune
+ 亚马逊 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>

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

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/TagResource) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/TagResource) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/TagResource) 
+  [AWS Python 软件开发工具包](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 资源名称 (ARN) 标识的备份保管库中删除一组键值对

包括 Aurora、Amazon DocumentDB 在内的资源类型的恢复点不支持此 API。亚马逊 EBS、亚马逊 FSx、Neptune 和亚马逊 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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UntagResource) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UntagResource) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UntagResource) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UntagResource) 
+  [AWS Python 软件开发工具包](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 资源名称 (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。  
类型：时间戳

 ** [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 编码字符串，长度最大为 1024 个字节。无法编辑版本 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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS Python 软件开发工具包](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>
框架的可选描述，最多 1024 个字符。  
类型：字符串  
长度限制：最小长度为 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:00，比 UTC 晚 8 个小时。  
类型：时间戳

 ** [FrameworkArn](#API_UpdateFramework_ResponseSyntax) **   <a name="Backup-UpdateFramework-response-FrameworkArn"></a>
唯一标识资源的 Amazon 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UpdateFramework) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateFramework) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateFramework) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateFramework) 
+  [AWS Python 软件开发工具包](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`。  
创建 Backup 服务相关角色的值，样式为。`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>

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

## 请求语法
<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>
索引可能取两个值中的一个，可以是 `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>
索引可能取两个值中的一个，可以是 `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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS Python 软件开发工具包](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`，请在调用此操作时包括这些参数及其值。不包括它们可能会导致您的计划更新为空值。

此操作不支持连续备份。

## 请求语法
<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 资源名称 (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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS Python 软件开发工具包](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 备份功能，请按照程序以编程方式启用高级 DynamoDB 备份](https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html)。](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、Amaz EC2 on 或 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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS Python 软件开发工具包](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>
报告计划的可选描述，最多 1024 个字符。  
类型：字符串  
长度限制：最小长度为 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。  
类型：时间戳

 ** [ReportPlanArn](#API_UpdateReportPlan_ResponseSyntax) **   <a name="Backup-UpdateReportPlan-response-ReportPlanArn"></a>
唯一标识资源的 Amazon 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UpdateReportPlan) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateReportPlan) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateReportPlan) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateReportPlan) 
+  [AWS Python 软件开发工具包](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>
资源测试计划的创建时间。  
类型：时间戳

 ** [RestoreTestingPlanArn](#API_UpdateRestoreTestingPlan_ResponseSyntax) **   <a name="Backup-UpdateRestoreTestingPlan-response-RestoreTestingPlanArn"></a>
还原测试计划的唯一 ARN（Amazon 资源名称）。  
类型：字符串

 ** [RestoreTestingPlanName](#API_UpdateRestoreTestingPlan_ResponseSyntax) **   <a name="Backup-UpdateRestoreTestingPlan-response-RestoreTestingPlanName"></a>
名称一经创建便无法更改。名称只能包含字母数字字符和下划线。最大长度为 50。  
类型：字符串

 ** [UpdateTime](#API_UpdateRestoreTestingPlan_ResponseSyntax) **   <a name="Backup-UpdateRestoreTestingPlan-response-UpdateTime"></a>
还原测试计划完成更新的时间。  
类型：时间戳

## 错误
<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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS Python 软件开发工具包](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>
要更新您的恢复测试选项，您可以使用受保护的资源 ARNs 或条件，但不能同时使用两者。也就是说，如果您的选项具有 `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>
成功更新资源测试选择的时间。  
类型：时间戳

 ** [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>
还原测试选择完成更新的时间。  
类型：时间戳

## 错误
<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>

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

 ** [LastUpdatedTime](#API_UpdateTieringConfiguration_ResponseSyntax) **   <a name="Backup-UpdateTieringConfiguration-response-LastUpdatedTime"></a>
分层配置的更新日期和时间，采用 Unix 格式和协调世界时 (UTC)。`LastUpdatedTime` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳

 ** [TieringConfigurationArn](#API_UpdateTieringConfiguration_ResponseSyntax) **   <a name="Backup-UpdateTieringConfiguration-response-TieringConfigurationArn"></a>
Amazon 资源名称 (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>

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

# AWS Backup gateway
<a name="API_Operations_AWS_Backup_Gateway"></a>

AWS Backup gateway 支持以下操作：
+  [AssociateGatewayToServer](API_BGW_AssociateGatewayToServer.md) 
+  [CreateGateway](API_BGW_CreateGateway.md) 
+  [DeleteGateway](API_BGW_DeleteGateway.md) 
+  [DeleteHypervisor](API_BGW_DeleteHypervisor.md) 
+  [DisassociateGatewayFromServer](API_BGW_DisassociateGatewayFromServer.md) 
+  [GetBandwidthRateLimitSchedule](API_BGW_GetBandwidthRateLimitSchedule.md) 
+  [GetGateway](API_BGW_GetGateway.md) 
+  [GetHypervisor](API_BGW_GetHypervisor.md) 
+  [GetHypervisorPropertyMappings](API_BGW_GetHypervisorPropertyMappings.md) 
+  [GetVirtualMachine](API_BGW_GetVirtualMachine.md) 
+  [ImportHypervisorConfiguration](API_BGW_ImportHypervisorConfiguration.md) 
+  [ListGateways](API_BGW_ListGateways.md) 
+  [ListHypervisors](API_BGW_ListHypervisors.md) 
+  [ListTagsForResource](API_BGW_ListTagsForResource.md) 
+  [ListVirtualMachines](API_BGW_ListVirtualMachines.md) 
+  [PutBandwidthRateLimitSchedule](API_BGW_PutBandwidthRateLimitSchedule.md) 
+  [PutHypervisorPropertyMappings](API_BGW_PutHypervisorPropertyMappings.md) 
+  [PutMaintenanceStartTime](API_BGW_PutMaintenanceStartTime.md) 
+  [StartVirtualMachinesMetadataSync](API_BGW_StartVirtualMachinesMetadataSync.md) 
+  [TagResource](API_BGW_TagResource.md) 
+  [TestHypervisorConfiguration](API_BGW_TestHypervisorConfiguration.md) 
+  [UntagResource](API_BGW_UntagResource.md) 
+  [UpdateGatewayInformation](API_BGW_UpdateGatewayInformation.md) 
+  [UpdateGatewaySoftwareNow](API_BGW_UpdateGatewaySoftwareNow.md) 
+  [UpdateHypervisor](API_BGW_UpdateHypervisor.md) 

# AssociateGatewayToServer
<a name="API_BGW_AssociateGatewayToServer"></a>

将备份网关与您的服务器关联。完成关联过程后，您可以 VMs 通过网关进行备份和恢复。

## 请求语法
<a name="API_BGW_AssociateGatewayToServer_RequestSyntax"></a>

```
{
   "GatewayArn": "string",
   "ServerArn": "string"
}
```

## 请求参数
<a name="API_BGW_AssociateGatewayToServer_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [GatewayArn](#API_BGW_AssociateGatewayToServer_RequestSyntax) **   <a name="Backup-BGW_AssociateGatewayToServer-request-GatewayArn"></a>
网关的 Amazon 资源名称 (ARN)。使用`ListGateways`操作返回您的账户的网关列表和 AWS 区域。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
是否必需：是

 ** [ServerArn](#API_BGW_AssociateGatewayToServer_RequestSyntax) **   <a name="Backup-BGW_AssociateGatewayToServer-request-ServerArn"></a>
托管虚拟机的服务器的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：是

## 响应语法
<a name="API_BGW_AssociateGatewayToServer_ResponseSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

## 响应元素
<a name="API_BGW_AssociateGatewayToServer_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [GatewayArn](#API_BGW_AssociateGatewayToServer_ResponseSyntax) **   <a name="Backup-BGW_AssociateGatewayToServer-response-GatewayArn"></a>
网关的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

## 错误
<a name="API_BGW_AssociateGatewayToServer_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** ConflictException **   
由于不支持该操作，因此无法继续操作。    
 ** ErrorCode **   
对不支持该操作的原因的描述。
HTTP 状态代码：400

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

## 另请参阅
<a name="API_BGW_AssociateGatewayToServer_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/AssociateGatewayToServer) 

# CreateGateway
<a name="API_BGW_CreateGateway"></a>

创建备份网关。创建网关后，您可以通过 `AssociateGatewayToServer` 操作将其与服务器关联。

## 请求语法
<a name="API_BGW_CreateGateway_RequestSyntax"></a>

```
{
   "ActivationKey": "string",
   "GatewayDisplayName": "string",
   "GatewayType": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## 请求参数
<a name="API_BGW_CreateGateway_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [ActivationKey](#API_BGW_CreateGateway_RequestSyntax) **   <a name="Backup-BGW_CreateGateway-request-ActivationKey"></a>
已创建网关的激活密钥。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 50。  
模式：`[0-9a-zA-Z\-]+`  
是否必需：是

 ** [GatewayDisplayName](#API_BGW_CreateGateway_RequestSyntax) **   <a name="Backup-BGW_CreateGateway-request-GatewayDisplayName"></a>
已创建网关的显示名称。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[a-zA-Z0-9-]*`  
是否必需：是

 ** [GatewayType](#API_BGW_CreateGateway_RequestSyntax) **   <a name="Backup-BGW_CreateGateway-request-GatewayType"></a>
已创建网关的类型。  
类型：字符串  
有效值：`BACKUP_VM`  
是否必需：是

 ** [Tags](#API_BGW_CreateGateway_RequestSyntax) **   <a name="Backup-BGW_CreateGateway-request-Tags"></a>
分配给网关的最多 50 个标签的列表。每个标签都是一个键-值对。  
类型：[Tag](API_BGW_Tag.md) 对象数组  
必需：否

## 响应语法
<a name="API_BGW_CreateGateway_ResponseSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

## 响应元素
<a name="API_BGW_CreateGateway_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [GatewayArn](#API_BGW_CreateGateway_ResponseSyntax) **   <a name="Backup-BGW_CreateGateway-response-GatewayArn"></a>
您创建的网关的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

## 错误
<a name="API_BGW_CreateGateway_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

## 另请参阅
<a name="API_BGW_CreateGateway_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/CreateGateway) 

# DeleteGateway
<a name="API_BGW_DeleteGateway"></a>

删除备份网关。

## 请求语法
<a name="API_BGW_DeleteGateway_RequestSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

## 请求参数
<a name="API_BGW_DeleteGateway_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [GatewayArn](#API_BGW_DeleteGateway_RequestSyntax) **   <a name="Backup-BGW_DeleteGateway-request-GatewayArn"></a>
要删除的网关的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：是

## 响应语法
<a name="API_BGW_DeleteGateway_ResponseSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

## 响应元素
<a name="API_BGW_DeleteGateway_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [GatewayArn](#API_BGW_DeleteGateway_ResponseSyntax) **   <a name="Backup-BGW_DeleteGateway-response-GatewayArn"></a>
您已删除的网关的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

## 错误
<a name="API_BGW_DeleteGateway_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

## 另请参阅
<a name="API_BGW_DeleteGateway_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/DeleteGateway) 

# DeleteHypervisor
<a name="API_BGW_DeleteHypervisor"></a>

删除管理程序。

## 请求语法
<a name="API_BGW_DeleteHypervisor_RequestSyntax"></a>

```
{
   "HypervisorArn": "string"
}
```

## 请求参数
<a name="API_BGW_DeleteHypervisor_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [HypervisorArn](#API_BGW_DeleteHypervisor_RequestSyntax) **   <a name="Backup-BGW_DeleteHypervisor-request-HypervisorArn"></a>
要删除的管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：是

## 响应语法
<a name="API_BGW_DeleteHypervisor_ResponseSyntax"></a>

```
{
   "HypervisorArn": "string"
}
```

## 响应元素
<a name="API_BGW_DeleteHypervisor_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [HypervisorArn](#API_BGW_DeleteHypervisor_ResponseSyntax) **   <a name="Backup-BGW_DeleteHypervisor-response-HypervisorArn"></a>
您已删除的管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

## 错误
<a name="API_BGW_DeleteHypervisor_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** AccessDeniedException **   
由于您的权限不足，操作无法继续。    
 ** ErrorCode **   
对您的权限不足的原因的描述。
HTTP 状态代码：400

 ** ConflictException **   
由于不支持该操作，因此无法继续操作。    
 ** ErrorCode **   
对不支持该操作的原因的描述。
HTTP 状态代码：400

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

## 另请参阅
<a name="API_BGW_DeleteHypervisor_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/DeleteHypervisor) 

# DisassociateGatewayFromServer
<a name="API_BGW_DisassociateGatewayFromServer"></a>

解除备份网关与指定服务器的关联。解除关联过程完成后，网关将无法再访问服务器上的虚拟机。

## 请求语法
<a name="API_BGW_DisassociateGatewayFromServer_RequestSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

## 请求参数
<a name="API_BGW_DisassociateGatewayFromServer_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [GatewayArn](#API_BGW_DisassociateGatewayFromServer_RequestSyntax) **   <a name="Backup-BGW_DisassociateGatewayFromServer-request-GatewayArn"></a>
要解除关联的网关的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：是

## 响应语法
<a name="API_BGW_DisassociateGatewayFromServer_ResponseSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

## 响应元素
<a name="API_BGW_DisassociateGatewayFromServer_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [GatewayArn](#API_BGW_DisassociateGatewayFromServer_ResponseSyntax) **   <a name="Backup-BGW_DisassociateGatewayFromServer-response-GatewayArn"></a>
您已解除关联的网关的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

## 错误
<a name="API_BGW_DisassociateGatewayFromServer_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** ConflictException **   
由于不支持该操作，因此无法继续操作。    
 ** ErrorCode **   
对不支持该操作的原因的描述。
HTTP 状态代码：400

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

## 另请参阅
<a name="API_BGW_DisassociateGatewayFromServer_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 

# GetBandwidthRateLimitSchedule
<a name="API_BGW_GetBandwidthRateLimitSchedule"></a>

检索指定网关的带宽速率限制计划。默认情况下，网关没有带宽速率限制计划，这意味着没有有效的带宽速率限制。使用该参数可获取网关的带宽速率限制计划。

## 请求语法
<a name="API_BGW_GetBandwidthRateLimitSchedule_RequestSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

## 请求参数
<a name="API_BGW_GetBandwidthRateLimitSchedule_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [GatewayArn](#API_BGW_GetBandwidthRateLimitSchedule_RequestSyntax) **   <a name="Backup-BGW_GetBandwidthRateLimitSchedule-request-GatewayArn"></a>
网关的 Amazon 资源名称 (ARN)。使用[https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html)操作返回您的账户的网关列表和 AWS 区域。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：是

## 响应语法
<a name="API_BGW_GetBandwidthRateLimitSchedule_ResponseSyntax"></a>

```
{
   "BandwidthRateLimitIntervals": [ 
      { 
         "AverageUploadRateLimitInBitsPerSec": number,
         "DaysOfWeek": [ number ],
         "EndHourOfDay": number,
         "EndMinuteOfHour": number,
         "StartHourOfDay": number,
         "StartMinuteOfHour": number
      }
   ],
   "GatewayArn": "string"
}
```

## 响应元素
<a name="API_BGW_GetBandwidthRateLimitSchedule_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [BandwidthRateLimitIntervals](#API_BGW_GetBandwidthRateLimitSchedule_ResponseSyntax) **   <a name="Backup-BGW_GetBandwidthRateLimitSchedule-response-BandwidthRateLimitIntervals"></a>
包含网关带宽速率限制计划间隔的数组。如果没有安排带宽速率限制间隔，则该数组为空。  
类型：[BandwidthRateLimitInterval](API_BGW_BandwidthRateLimitInterval.md) 对象数组  
数组成员：最少 0 个物品。最多 20 个项目。

 ** [GatewayArn](#API_BGW_GetBandwidthRateLimitSchedule_ResponseSyntax) **   <a name="Backup-BGW_GetBandwidthRateLimitSchedule-response-GatewayArn"></a>
网关的 Amazon 资源名称 (ARN)。使用[https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html)操作返回您的账户的网关列表和 AWS 区域。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

## 错误
<a name="API_BGW_GetBandwidthRateLimitSchedule_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

## 另请参阅
<a name="API_BGW_GetBandwidthRateLimitSchedule_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 

# GetGateway
<a name="API_BGW_GetGateway"></a>

通过提供 ARN（Amazon 资源名称），此 API 将返回网关。

## 请求语法
<a name="API_BGW_GetGateway_RequestSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

## 请求参数
<a name="API_BGW_GetGateway_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [GatewayArn](#API_BGW_GetGateway_RequestSyntax) **   <a name="Backup-BGW_GetGateway-request-GatewayArn"></a>
网关的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：是

## 响应语法
<a name="API_BGW_GetGateway_ResponseSyntax"></a>

```
{
   "Gateway": { 
      "DeprecationDate": number,
      "GatewayArn": "string",
      "GatewayDisplayName": "string",
      "GatewayType": "string",
      "HypervisorId": "string",
      "LastSeenTime": number,
      "MaintenanceStartTime": { 
         "DayOfMonth": number,
         "DayOfWeek": number,
         "HourOfDay": number,
         "MinuteOfHour": number
      },
      "NextUpdateAvailabilityTime": number,
      "SoftwareVersion": "string",
      "VpcEndpoint": "string"
   }
}
```

## 响应元素
<a name="API_BGW_GetGateway_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Gateway](#API_BGW_GetGateway_ResponseSyntax) **   <a name="Backup-BGW_GetGateway-response-Gateway"></a>
通过提供 ARN（Amazon 资源名称），此 API 将返回网关。  
类型：[GatewayDetails](API_BGW_GatewayDetails.md) 对象

## 错误
<a name="API_BGW_GetGateway_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

## 另请参阅
<a name="API_BGW_GetGateway_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/GetGateway) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/GetGateway) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GetGateway) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/GetGateway) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GetGateway) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/GetGateway) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/GetGateway) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/GetGateway) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/GetGateway) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/GetGateway) 

# GetHypervisor
<a name="API_BGW_GetHypervisor"></a>

此操作请求有关网关将要连接到的指定管理程序的信息。管理程序是用于创建和管理虚拟机并为其分配资源的硬件、软件或固件。

## 请求语法
<a name="API_BGW_GetHypervisor_RequestSyntax"></a>

```
{
   "HypervisorArn": "string"
}
```

## 请求参数
<a name="API_BGW_GetHypervisor_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [HypervisorArn](#API_BGW_GetHypervisor_RequestSyntax) **   <a name="Backup-BGW_GetHypervisor-request-HypervisorArn"></a>
管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：是

## 响应语法
<a name="API_BGW_GetHypervisor_ResponseSyntax"></a>

```
{
   "Hypervisor": { 
      "Host": "string",
      "HypervisorArn": "string",
      "KmsKeyArn": "string",
      "LastSuccessfulMetadataSyncTime": number,
      "LatestMetadataSyncStatus": "string",
      "LatestMetadataSyncStatusMessage": "string",
      "LogGroupArn": "string",
      "Name": "string",
      "State": "string"
   }
}
```

## 响应元素
<a name="API_BGW_GetHypervisor_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Hypervisor](#API_BGW_GetHypervisor_ResponseSyntax) **   <a name="Backup-BGW_GetHypervisor-response-Hypervisor"></a>
有关请求的管理程序的详细信息。  
类型：[HypervisorDetails](API_BGW_HypervisorDetails.md) 对象

## 错误
<a name="API_BGW_GetHypervisor_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

## 另请参阅
<a name="API_BGW_GetHypervisor_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/GetHypervisor) 

# GetHypervisorPropertyMappings
<a name="API_BGW_GetHypervisorPropertyMappings"></a>

此操作检索指定管理程序的属性映射。虚拟机管理程序属性映射显示虚拟机管理程序中可用的实体属性与中可用属性的关系。 AWS

## 请求语法
<a name="API_BGW_GetHypervisorPropertyMappings_RequestSyntax"></a>

```
{
   "HypervisorArn": "string"
}
```

## 请求参数
<a name="API_BGW_GetHypervisorPropertyMappings_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [HypervisorArn](#API_BGW_GetHypervisorPropertyMappings_RequestSyntax) **   <a name="Backup-BGW_GetHypervisorPropertyMappings-request-HypervisorArn"></a>
管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：是

## 响应语法
<a name="API_BGW_GetHypervisorPropertyMappings_ResponseSyntax"></a>

```
{
   "HypervisorArn": "string",
   "IamRoleArn": "string",
   "VmwareToAwsTagMappings": [ 
      { 
         "AwsTagKey": "string",
         "AwsTagValue": "string",
         "VmwareCategory": "string",
         "VmwareTagName": "string"
      }
   ]
}
```

## 响应元素
<a name="API_BGW_GetHypervisorPropertyMappings_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [HypervisorArn](#API_BGW_GetHypervisorPropertyMappings_ResponseSyntax) **   <a name="Backup-BGW_GetHypervisorPropertyMappings-response-HypervisorArn"></a>
管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

 ** [IamRoleArn](#API_BGW_GetHypervisorPropertyMappings_ResponseSyntax) **   <a name="Backup-BGW_GetHypervisorPropertyMappings-response-IamRoleArn"></a>
IAM 角色的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。  
模式：`arn:(aws|aws-cn|aws-us-gov):iam::([0-9]+):role/(\S+)`

 ** [VmwareToAwsTagMappings](#API_BGW_GetHypervisorPropertyMappings_ResponseSyntax) **   <a name="Backup-BGW_GetHypervisorPropertyMappings-response-VmwareToAwsTagMappings"></a>
这是标签与 VMware 标签的映射的显示。 AWS   
类型：[VmwareToAwsTagMapping](API_BGW_VmwareToAwsTagMapping.md) 对象数组

## 错误
<a name="API_BGW_GetHypervisorPropertyMappings_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

## 另请参阅
<a name="API_BGW_GetHypervisorPropertyMappings_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 

# GetVirtualMachine
<a name="API_BGW_GetVirtualMachine"></a>

通过提供 ARN（Amazon 资源名称），此 API 将返回虚拟机。

## 请求语法
<a name="API_BGW_GetVirtualMachine_RequestSyntax"></a>

```
{
   "ResourceArn": "string"
}
```

## 请求参数
<a name="API_BGW_GetVirtualMachine_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [ResourceArn](#API_BGW_GetVirtualMachine_RequestSyntax) **   <a name="Backup-BGW_GetVirtualMachine-request-ResourceArn"></a>
虚拟机的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：是

## 响应语法
<a name="API_BGW_GetVirtualMachine_ResponseSyntax"></a>

```
{
   "VirtualMachine": { 
      "HostName": "string",
      "HypervisorId": "string",
      "LastBackupDate": number,
      "Name": "string",
      "Path": "string",
      "ResourceArn": "string",
      "VmwareTags": [ 
         { 
            "VmwareCategory": "string",
            "VmwareTagDescription": "string",
            "VmwareTagName": "string"
         }
      ]
   }
}
```

## 响应元素
<a name="API_BGW_GetVirtualMachine_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [VirtualMachine](#API_BGW_GetVirtualMachine_ResponseSyntax) **   <a name="Backup-BGW_GetVirtualMachine-response-VirtualMachine"></a>
此对象包含 `GetVirtualMachine` 的输出所含的 `VirtualMachine` 的基本属性   
类型：[VirtualMachineDetails](API_BGW_VirtualMachineDetails.md) 对象

## 错误
<a name="API_BGW_GetVirtualMachine_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

## 另请参阅
<a name="API_BGW_GetVirtualMachine_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/GetVirtualMachine) 

# ImportHypervisorConfiguration
<a name="API_BGW_ImportHypervisorConfiguration"></a>

通过导入管理程序的配置来连接管理程序。

## 请求语法
<a name="API_BGW_ImportHypervisorConfiguration_RequestSyntax"></a>

```
{
   "Host": "string",
   "KmsKeyArn": "string",
   "Name": "string",
   "Password": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Username": "string"
}
```

## 请求参数
<a name="API_BGW_ImportHypervisorConfiguration_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [Host](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-Host"></a>
管理程序的服务器主机。这可以是 IP 地址或完全限定域名 (FQDN)。  
类型：字符串  
长度约束：最小长度为 3。最大长度为 128。  
模式：`.+`  
是否必需：是

 ** [KmsKeyArn](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-KmsKeyArn"></a>
 AWS Key Management Service 适用于虚拟机管理程序。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`(^arn:(aws|aws-cn|aws-us-gov):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)`  
必需：否

 ** [Name](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-Name"></a>
管理程序的名称。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[a-zA-Z0-9-]*`  
是否必需：是

 ** [Password](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-Password"></a>
管理程序的密码。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[ -~]+`  
必需：否

 ** [Tags](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-Tags"></a>
要导入的管理程序配置的标签。  
类型：[Tag](API_BGW_Tag.md) 对象数组  
必需：否

 ** [Username](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-Username"></a>
管理程序的用户名。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*`  
必需：否

## 响应语法
<a name="API_BGW_ImportHypervisorConfiguration_ResponseSyntax"></a>

```
{
   "HypervisorArn": "string"
}
```

## 响应元素
<a name="API_BGW_ImportHypervisorConfiguration_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [HypervisorArn](#API_BGW_ImportHypervisorConfiguration_ResponseSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-response-HypervisorArn"></a>
您已解除关联的管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

## 错误
<a name="API_BGW_ImportHypervisorConfiguration_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** AccessDeniedException **   
由于您的权限不足，操作无法继续。    
 ** ErrorCode **   
对您的权限不足的原因的描述。
HTTP 状态代码：400

 ** ConflictException **   
由于不支持该操作，因此无法继续操作。    
 ** ErrorCode **   
对不支持该操作的原因的描述。
HTTP 状态代码：400

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

## 另请参阅
<a name="API_BGW_ImportHypervisorConfiguration_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 

# ListGateways
<a name="API_BGW_ListGateways"></a>

列出中由拥有 AWS 账户 的备份网关 AWS 区域。返回的列表是按网关 Amazon 资源名称 (ARN) 排序的。

## 请求语法
<a name="API_BGW_ListGateways_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

## 请求参数
<a name="API_BGW_ListGateways_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [MaxResults](#API_BGW_ListGateways_RequestSyntax) **   <a name="Backup-BGW_ListGateways-request-MaxResults"></a>
要列出的网关的最大数量。  
类型：整数  
有效范围：最小值为 1。  
必需：否

 ** [NextToken](#API_BGW_ListGateways_RequestSyntax) **   <a name="Backup-BGW_ListGateways-request-NextToken"></a>
所返回资源的部分列表的后续下一个项目。例如，如果请求返回 `MaxResults` 数量的资源，则 `NextToken` 允许您从下一个令牌指向的位置开始返回列表中的更多项目。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 1000。  
模式：`.+`  
必需：否

## 响应语法
<a name="API_BGW_ListGateways_ResponseSyntax"></a>

```
{
   "Gateways": [ 
      { 
         "GatewayArn": "string",
         "GatewayDisplayName": "string",
         "GatewayType": "string",
         "HypervisorId": "string",
         "LastSeenTime": number
      }
   ],
   "NextToken": "string"
}
```

## 响应元素
<a name="API_BGW_ListGateways_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Gateways](#API_BGW_ListGateways_ResponseSyntax) **   <a name="Backup-BGW_ListGateways-response-Gateways"></a>
您的网关列表。  
类型：[Gateway](API_BGW_Gateway.md) 对象数组

 ** [NextToken](#API_BGW_ListGateways_ResponseSyntax) **   <a name="Backup-BGW_ListGateways-response-NextToken"></a>
所返回资源的部分列表的后续下一个项目。例如，如果请求返回 `maxResults` 数量的资源，则 `NextToken` 允许您从下一个令牌指向的位置开始返回列表中的更多项目。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 1000。  
模式：`.+`

## 错误
<a name="API_BGW_ListGateways_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

## 另请参阅
<a name="API_BGW_ListGateways_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/ListGateways) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/ListGateways) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/ListGateways) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/ListGateways) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/ListGateways) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/ListGateways) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/ListGateways) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/ListGateways) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/ListGateways) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/ListGateways) 

# ListHypervisors
<a name="API_BGW_ListHypervisors"></a>

列出您的管理程序。

## 请求语法
<a name="API_BGW_ListHypervisors_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

## 请求参数
<a name="API_BGW_ListHypervisors_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [MaxResults](#API_BGW_ListHypervisors_RequestSyntax) **   <a name="Backup-BGW_ListHypervisors-request-MaxResults"></a>
要列出的管理程序的最大数量。  
类型：整数  
有效范围：最小值为 1。  
必需：否

 ** [NextToken](#API_BGW_ListHypervisors_RequestSyntax) **   <a name="Backup-BGW_ListHypervisors-request-NextToken"></a>
所返回资源的部分列表的后续下一个项目。例如，如果请求返回 `maxResults` 数量的资源，则 `NextToken` 允许您从下一个令牌指向的位置开始返回列表中的更多项目。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 1000。  
模式：`.+`  
必需：否

## 响应语法
<a name="API_BGW_ListHypervisors_ResponseSyntax"></a>

```
{
   "Hypervisors": [ 
      { 
         "Host": "string",
         "HypervisorArn": "string",
         "KmsKeyArn": "string",
         "Name": "string",
         "State": "string"
      }
   ],
   "NextToken": "string"
}
```

## 响应元素
<a name="API_BGW_ListHypervisors_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Hypervisors](#API_BGW_ListHypervisors_ResponseSyntax) **   <a name="Backup-BGW_ListHypervisors-response-Hypervisors"></a>
您的`Hypervisor`对象列表，按其 Amazon 资源名称排序 (ARNs)。  
类型：[Hypervisor](API_BGW_Hypervisor.md) 对象数组

 ** [NextToken](#API_BGW_ListHypervisors_ResponseSyntax) **   <a name="Backup-BGW_ListHypervisors-response-NextToken"></a>
所返回资源的部分列表的后续下一个项目。例如，如果请求返回 `maxResults` 数量的资源，则 `NextToken` 允许您从下一个令牌指向的位置开始返回列表中的更多项目。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 1000。  
模式：`.+`

## 错误
<a name="API_BGW_ListHypervisors_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

## 另请参阅
<a name="API_BGW_ListHypervisors_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/ListHypervisors) 

# ListTagsForResource
<a name="API_BGW_ListTagsForResource"></a>

列出应用于由其 Amazon 资源名称 (ARN) 标识的资源的标记。

## 请求语法
<a name="API_BGW_ListTagsForResource_RequestSyntax"></a>

```
{
   "ResourceArn": "string"
}
```

## 请求参数
<a name="API_BGW_ListTagsForResource_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [ResourceArn](#API_BGW_ListTagsForResource_RequestSyntax) **   <a name="Backup-BGW_ListTagsForResource-request-ResourceArn"></a>
要列出的资源标记的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：是

## 响应语法
<a name="API_BGW_ListTagsForResource_ResponseSyntax"></a>

```
{
   "ResourceArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## 响应元素
<a name="API_BGW_ListTagsForResource_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [ResourceArn](#API_BGW_ListTagsForResource_ResponseSyntax) **   <a name="Backup-BGW_ListTagsForResource-response-ResourceArn"></a>
您已列出的资源标记的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

 ** [Tags](#API_BGW_ListTagsForResource_ResponseSyntax) **   <a name="Backup-BGW_ListTagsForResource-response-Tags"></a>
资源标记列表。  
类型：[Tag](API_BGW_Tag.md) 对象数组

## 错误
<a name="API_BGW_ListTagsForResource_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

## 另请参阅
<a name="API_BGW_ListTagsForResource_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/ListTagsForResource) 

# ListVirtualMachines
<a name="API_BGW_ListVirtualMachines"></a>

列出您的虚拟机。

## 请求语法
<a name="API_BGW_ListVirtualMachines_RequestSyntax"></a>

```
{
   "HypervisorArn": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## 请求参数
<a name="API_BGW_ListVirtualMachines_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [HypervisorArn](#API_BGW_ListVirtualMachines_RequestSyntax) **   <a name="Backup-BGW_ListVirtualMachines-request-HypervisorArn"></a>
连接到虚拟机的管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：否

 ** [MaxResults](#API_BGW_ListVirtualMachines_RequestSyntax) **   <a name="Backup-BGW_ListVirtualMachines-request-MaxResults"></a>
要列出的最大虚拟机数量。  
类型：整数  
有效范围：最小值为 1。  
必需：否

 ** [NextToken](#API_BGW_ListVirtualMachines_RequestSyntax) **   <a name="Backup-BGW_ListVirtualMachines-request-NextToken"></a>
所返回资源的部分列表的后续下一个项目。例如，如果请求返回 `maxResults` 数量的资源，则 `NextToken` 允许您从下一个令牌指向的位置开始返回列表中的更多项目。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 1000。  
模式：`.+`  
必需：否

## 响应语法
<a name="API_BGW_ListVirtualMachines_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "VirtualMachines": [ 
      { 
         "HostName": "string",
         "HypervisorId": "string",
         "LastBackupDate": number,
         "Name": "string",
         "Path": "string",
         "ResourceArn": "string"
      }
   ]
}
```

## 响应元素
<a name="API_BGW_ListVirtualMachines_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [NextToken](#API_BGW_ListVirtualMachines_ResponseSyntax) **   <a name="Backup-BGW_ListVirtualMachines-response-NextToken"></a>
所返回资源的部分列表的后续下一个项目。例如，如果请求返回 `maxResults` 数量的资源，则 `NextToken` 允许您从下一个令牌指向的位置开始返回列表中的更多项目。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 1000。  
模式：`.+`

 ** [VirtualMachines](#API_BGW_ListVirtualMachines_ResponseSyntax) **   <a name="Backup-BGW_ListVirtualMachines-response-VirtualMachines"></a>
您的`VirtualMachine`对象列表，按其 Amazon 资源名称排序 (ARNs)。  
类型：[VirtualMachine](API_BGW_VirtualMachine.md) 对象数组

## 错误
<a name="API_BGW_ListVirtualMachines_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

## 另请参阅
<a name="API_BGW_ListVirtualMachines_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/ListVirtualMachines) 

# PutBandwidthRateLimitSchedule
<a name="API_BGW_PutBandwidthRateLimitSchedule"></a>

此操作为指定网关设置带宽速率限制计划。默认情况下，网关没有带宽速率限制计划，这意味着没有有效的带宽速率限制。使用此操作可启动网关的带宽速率限制计划。

## 请求语法
<a name="API_BGW_PutBandwidthRateLimitSchedule_RequestSyntax"></a>

```
{
   "BandwidthRateLimitIntervals": [ 
      { 
         "AverageUploadRateLimitInBitsPerSec": number,
         "DaysOfWeek": [ number ],
         "EndHourOfDay": number,
         "EndMinuteOfHour": number,
         "StartHourOfDay": number,
         "StartMinuteOfHour": number
      }
   ],
   "GatewayArn": "string"
}
```

## 请求参数
<a name="API_BGW_PutBandwidthRateLimitSchedule_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [BandwidthRateLimitIntervals](#API_BGW_PutBandwidthRateLimitSchedule_RequestSyntax) **   <a name="Backup-BGW_PutBandwidthRateLimitSchedule-request-BandwidthRateLimitIntervals"></a>
包含网关带宽速率限制计划间隔的数组。如果没有安排带宽速率限制间隔，则该数组为空。  
类型：[BandwidthRateLimitInterval](API_BGW_BandwidthRateLimitInterval.md) 对象数组  
数组成员：最少 0 个物品。最多 20 个项目。  
是否必需：是

 ** [GatewayArn](#API_BGW_PutBandwidthRateLimitSchedule_RequestSyntax) **   <a name="Backup-BGW_PutBandwidthRateLimitSchedule-request-GatewayArn"></a>
网关的 Amazon 资源名称 (ARN)。使用[https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html)操作返回您的账户的网关列表和 AWS 区域。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：是

## 响应语法
<a name="API_BGW_PutBandwidthRateLimitSchedule_ResponseSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

## 响应元素
<a name="API_BGW_PutBandwidthRateLimitSchedule_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [GatewayArn](#API_BGW_PutBandwidthRateLimitSchedule_ResponseSyntax) **   <a name="Backup-BGW_PutBandwidthRateLimitSchedule-response-GatewayArn"></a>
网关的 Amazon 资源名称 (ARN)。使用[https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html)操作返回您的账户的网关列表和 AWS 区域。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

## 错误
<a name="API_BGW_PutBandwidthRateLimitSchedule_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

## 另请参阅
<a name="API_BGW_PutBandwidthRateLimitSchedule_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 

# PutHypervisorPropertyMappings
<a name="API_BGW_PutHypervisorPropertyMappings"></a>

此操作设置指定管理程序的属性映射。虚拟机管理程序属性映射显示虚拟机管理程序中可用的实体属性与中可用属性的关系。 AWS

## 请求语法
<a name="API_BGW_PutHypervisorPropertyMappings_RequestSyntax"></a>

```
{
   "HypervisorArn": "string",
   "IamRoleArn": "string",
   "VmwareToAwsTagMappings": [ 
      { 
         "AwsTagKey": "string",
         "AwsTagValue": "string",
         "VmwareCategory": "string",
         "VmwareTagName": "string"
      }
   ]
}
```

## 请求参数
<a name="API_BGW_PutHypervisorPropertyMappings_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [HypervisorArn](#API_BGW_PutHypervisorPropertyMappings_RequestSyntax) **   <a name="Backup-BGW_PutHypervisorPropertyMappings-request-HypervisorArn"></a>
管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
是否必需：是

 ** [IamRoleArn](#API_BGW_PutHypervisorPropertyMappings_RequestSyntax) **   <a name="Backup-BGW_PutHypervisorPropertyMappings-request-IamRoleArn"></a>
IAM 角色的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。  
模式：`arn:(aws|aws-cn|aws-us-gov):iam::([0-9]+):role/(\S+)`  
是否必需：是

 ** [VmwareToAwsTagMappings](#API_BGW_PutHypervisorPropertyMappings_RequestSyntax) **   <a name="Backup-BGW_PutHypervisorPropertyMappings-request-VmwareToAwsTagMappings"></a>
此操作请求标签与 VMware AWS 标签的映射。  
类型：[VmwareToAwsTagMapping](API_BGW_VmwareToAwsTagMapping.md) 对象数组  
是否必需：是

## 响应语法
<a name="API_BGW_PutHypervisorPropertyMappings_ResponseSyntax"></a>

```
{
   "HypervisorArn": "string"
}
```

## 响应元素
<a name="API_BGW_PutHypervisorPropertyMappings_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [HypervisorArn](#API_BGW_PutHypervisorPropertyMappings_ResponseSyntax) **   <a name="Backup-BGW_PutHypervisorPropertyMappings-response-HypervisorArn"></a>
管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

## 错误
<a name="API_BGW_PutHypervisorPropertyMappings_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** AccessDeniedException **   
由于您的权限不足，操作无法继续。    
 ** ErrorCode **   
对您的权限不足的原因的描述。
HTTP 状态代码：400

 ** ConflictException **   
由于不支持该操作，因此无法继续操作。    
 ** ErrorCode **   
对不支持该操作的原因的描述。
HTTP 状态代码：400

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

## 另请参阅
<a name="API_BGW_PutHypervisorPropertyMappings_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 

# PutMaintenanceStartTime
<a name="API_BGW_PutMaintenanceStartTime"></a>

设置网关的维护开始时间。

## 请求语法
<a name="API_BGW_PutMaintenanceStartTime_RequestSyntax"></a>

```
{
   "DayOfMonth": number,
   "DayOfWeek": number,
   "GatewayArn": "string",
   "HourOfDay": number,
   "MinuteOfHour": number
}
```

## 请求参数
<a name="API_BGW_PutMaintenanceStartTime_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [DayOfMonth](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **   <a name="Backup-BGW_PutMaintenanceStartTime-request-DayOfMonth"></a>
当月的某一天开始对网关进行维护。  
有效值范围为 `Sunday` 至 `Saturday`。  
类型：整数  
有效范围：最小值为 1。最大值为 31。  
必需：否

 ** [DayOfWeek](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **   <a name="Backup-BGW_PutMaintenanceStartTime-request-DayOfWeek"></a>
一周中的某一天开始对网关进行维护。  
类型：整数  
有效范围：最小值为 0。最大值为 6。  
必需：否

 ** [GatewayArn](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **   <a name="Backup-BGW_PutMaintenanceStartTime-request-GatewayArn"></a>
网关的 Amazon 资源名称 (ARN)，用于指定其维护开始时间。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
是否必需：是

 ** [HourOfDay](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **   <a name="Backup-BGW_PutMaintenanceStartTime-request-HourOfDay"></a>
一天中的某个时间开始维护网关。  
类型：整数  
有效范围：最小值为 0。最大值为 23。  
是否必需：是

 ** [MinuteOfHour](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **   <a name="Backup-BGW_PutMaintenanceStartTime-request-MinuteOfHour"></a>
一小时中的某个分钟点开始对网关进行维护。  
类型：整数  
有效范围：最小值为 0。最大值为 59。  
是否必需：是

## 响应语法
<a name="API_BGW_PutMaintenanceStartTime_ResponseSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

## 响应元素
<a name="API_BGW_PutMaintenanceStartTime_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [GatewayArn](#API_BGW_PutMaintenanceStartTime_ResponseSyntax) **   <a name="Backup-BGW_PutMaintenanceStartTime-response-GatewayArn"></a>
您设置维护开始时间的网关的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

## 错误
<a name="API_BGW_PutMaintenanceStartTime_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** ConflictException **   
由于不支持该操作，因此无法继续操作。    
 ** ErrorCode **   
对不支持该操作的原因的描述。
HTTP 状态代码：400

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

## 另请参阅
<a name="API_BGW_PutMaintenanceStartTime_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/PutMaintenanceStartTime) 

# StartVirtualMachinesMetadataSync
<a name="API_BGW_StartVirtualMachinesMetadataSync"></a>

此操作会发送在指定虚拟机之间同步元数据的请求。

## 请求语法
<a name="API_BGW_StartVirtualMachinesMetadataSync_RequestSyntax"></a>

```
{
   "HypervisorArn": "string"
}
```

## 请求参数
<a name="API_BGW_StartVirtualMachinesMetadataSync_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [HypervisorArn](#API_BGW_StartVirtualMachinesMetadataSync_RequestSyntax) **   <a name="Backup-BGW_StartVirtualMachinesMetadataSync-request-HypervisorArn"></a>
管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：是

## 响应语法
<a name="API_BGW_StartVirtualMachinesMetadataSync_ResponseSyntax"></a>

```
{
   "HypervisorArn": "string"
}
```

## 响应元素
<a name="API_BGW_StartVirtualMachinesMetadataSync_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [HypervisorArn](#API_BGW_StartVirtualMachinesMetadataSync_ResponseSyntax) **   <a name="Backup-BGW_StartVirtualMachinesMetadataSync-response-HypervisorArn"></a>
管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

## 错误
<a name="API_BGW_StartVirtualMachinesMetadataSync_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** AccessDeniedException **   
由于您的权限不足，操作无法继续。    
 ** ErrorCode **   
对您的权限不足的原因的描述。
HTTP 状态代码：400

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

## 另请参阅
<a name="API_BGW_StartVirtualMachinesMetadataSync_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 

# TagResource
<a name="API_BGW_TagResource"></a>

标记资源。

## 请求语法
<a name="API_BGW_TagResource_RequestSyntax"></a>

```
{
   "ResourceARN": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## 请求参数
<a name="API_BGW_TagResource_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [ResourceARN](#API_BGW_TagResource_RequestSyntax) **   <a name="Backup-BGW_TagResource-request-ResourceARN"></a>
要标记的资源的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
是否必需：是

 ** [Tags](#API_BGW_TagResource_RequestSyntax) **   <a name="Backup-BGW_TagResource-request-Tags"></a>
分配给资源的标签列表。  
类型：[Tag](API_BGW_Tag.md) 对象数组  
是否必需：是

## 响应语法
<a name="API_BGW_TagResource_ResponseSyntax"></a>

```
{
   "ResourceARN": "string"
}
```

## 响应元素
<a name="API_BGW_TagResource_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [ResourceARN](#API_BGW_TagResource_ResponseSyntax) **   <a name="Backup-BGW_TagResource-response-ResourceARN"></a>
您已标记的资源的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

## 错误
<a name="API_BGW_TagResource_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

## 另请参阅
<a name="API_BGW_TagResource_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/TagResource) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/TagResource) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/TagResource) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/TagResource) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/TagResource) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/TagResource) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/TagResource) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/TagResource) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/TagResource) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/TagResource) 

# TestHypervisorConfiguration
<a name="API_BGW_TestHypervisorConfiguration"></a>

测试您的管理程序配置，以验证备份网关是否可以连接该管理程序及其资源。

## 请求语法
<a name="API_BGW_TestHypervisorConfiguration_RequestSyntax"></a>

```
{
   "GatewayArn": "string",
   "Host": "string",
   "Password": "string",
   "Username": "string"
}
```

## 请求参数
<a name="API_BGW_TestHypervisorConfiguration_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [GatewayArn](#API_BGW_TestHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_TestHypervisorConfiguration-request-GatewayArn"></a>
要测试的管理程序网关的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
是否必需：是

 ** [Host](#API_BGW_TestHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_TestHypervisorConfiguration-request-Host"></a>
管理程序的服务器主机。这可以是 IP 地址或完全限定域名 (FQDN)。  
类型：字符串  
长度约束：最小长度为 3。最大长度为 128。  
模式：`.+`  
是否必需：是

 ** [Password](#API_BGW_TestHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_TestHypervisorConfiguration-request-Password"></a>
管理程序的密码。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[ -~]+`  
必需：否

 ** [Username](#API_BGW_TestHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_TestHypervisorConfiguration-request-Username"></a>
管理程序的用户名。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*`  
必需：否

## 响应元素
<a name="API_BGW_TestHypervisorConfiguration_ResponseElements"></a>

如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。

## 错误
<a name="API_BGW_TestHypervisorConfiguration_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** ConflictException **   
由于不支持该操作，因此无法继续操作。    
 ** ErrorCode **   
对不支持该操作的原因的描述。
HTTP 状态代码：400

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

## 另请参阅
<a name="API_BGW_TestHypervisorConfiguration_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/TestHypervisorConfiguration) 

# UntagResource
<a name="API_BGW_UntagResource"></a>

删除资源标签。

## 请求语法
<a name="API_BGW_UntagResource_RequestSyntax"></a>

```
{
   "ResourceARN": "string",
   "TagKeys": [ "string" ]
}
```

## 请求参数
<a name="API_BGW_UntagResource_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [ResourceARN](#API_BGW_UntagResource_RequestSyntax) **   <a name="Backup-BGW_UntagResource-request-ResourceARN"></a>
要删除其标签的资源的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
是否必需：是

 ** [TagKeys](#API_BGW_UntagResource_RequestSyntax) **   <a name="Backup-BGW_UntagResource-request-TagKeys"></a>
指定要删除标签的标签键列表。  
类型：字符串数组  
长度限制：最小长度为 1。最大长度为 128。  
模式：`([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`  
必需：是

## 响应语法
<a name="API_BGW_UntagResource_ResponseSyntax"></a>

```
{
   "ResourceARN": "string"
}
```

## 响应元素
<a name="API_BGW_UntagResource_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [ResourceARN](#API_BGW_UntagResource_ResponseSyntax) **   <a name="Backup-BGW_UntagResource-response-ResourceARN"></a>
您已删除标签的资源的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

## 错误
<a name="API_BGW_UntagResource_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

## 另请参阅
<a name="API_BGW_UntagResource_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/UntagResource) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/UntagResource) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/UntagResource) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/UntagResource) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/UntagResource) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/UntagResource) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/UntagResource) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/UntagResource) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/UntagResource) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/UntagResource) 

# UpdateGatewayInformation
<a name="API_BGW_UpdateGatewayInformation"></a>

更新网关的名称。指定要在请求中使用网关的 Amazon 资源名称 (ARN) 更新哪个网关。

## 请求语法
<a name="API_BGW_UpdateGatewayInformation_RequestSyntax"></a>

```
{
   "GatewayArn": "string",
   "GatewayDisplayName": "string"
}
```

## 请求参数
<a name="API_BGW_UpdateGatewayInformation_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [GatewayArn](#API_BGW_UpdateGatewayInformation_RequestSyntax) **   <a name="Backup-BGW_UpdateGatewayInformation-request-GatewayArn"></a>
要更新的网关的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
是否必需：是

 ** [GatewayDisplayName](#API_BGW_UpdateGatewayInformation_RequestSyntax) **   <a name="Backup-BGW_UpdateGatewayInformation-request-GatewayDisplayName"></a>
更新后的网关显示名称。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[a-zA-Z0-9-]*`  
必需：否

## 响应语法
<a name="API_BGW_UpdateGatewayInformation_ResponseSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

## 响应元素
<a name="API_BGW_UpdateGatewayInformation_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [GatewayArn](#API_BGW_UpdateGatewayInformation_ResponseSyntax) **   <a name="Backup-BGW_UpdateGatewayInformation-response-GatewayArn"></a>
您已更新的网关的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

## 错误
<a name="API_BGW_UpdateGatewayInformation_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** ConflictException **   
由于不支持该操作，因此无法继续操作。    
 ** ErrorCode **   
对不支持该操作的原因的描述。
HTTP 状态代码：400

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

## 另请参阅
<a name="API_BGW_UpdateGatewayInformation_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/UpdateGatewayInformation) 

# UpdateGatewaySoftwareNow
<a name="API_BGW_UpdateGatewaySoftwareNow"></a>

更新网关虚拟机 (VM) 软件。该请求会立即触发软件更新。

**注意**  
您在发出此请求时会立即收到 `200 OK` 成功响应。但是，可能需要一段时间才能完成更新。

## 请求语法
<a name="API_BGW_UpdateGatewaySoftwareNow_RequestSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

## 请求参数
<a name="API_BGW_UpdateGatewaySoftwareNow_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [GatewayArn](#API_BGW_UpdateGatewaySoftwareNow_RequestSyntax) **   <a name="Backup-BGW_UpdateGatewaySoftwareNow-request-GatewayArn"></a>
要更新的网关的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：是

## 响应语法
<a name="API_BGW_UpdateGatewaySoftwareNow_ResponseSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

## 响应元素
<a name="API_BGW_UpdateGatewaySoftwareNow_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [GatewayArn](#API_BGW_UpdateGatewaySoftwareNow_ResponseSyntax) **   <a name="Backup-BGW_UpdateGatewaySoftwareNow-response-GatewayArn"></a>
您已更新的网关的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

## 错误
<a name="API_BGW_UpdateGatewaySoftwareNow_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

## 另请参阅
<a name="API_BGW_UpdateGatewaySoftwareNow_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 

# UpdateHypervisor
<a name="API_BGW_UpdateHypervisor"></a>

更新管理程序元数据，包括其主机、用户名和密码。指定要在请求中使用管理程序的 Amazon 资源名称 (ARN) 来更新哪个管理程序。

## 请求语法
<a name="API_BGW_UpdateHypervisor_RequestSyntax"></a>

```
{
   "Host": "string",
   "HypervisorArn": "string",
   "LogGroupArn": "string",
   "Name": "string",
   "Password": "string",
   "Username": "string"
}
```

## 请求参数
<a name="API_BGW_UpdateHypervisor_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [Host](#API_BGW_UpdateHypervisor_RequestSyntax) **   <a name="Backup-BGW_UpdateHypervisor-request-Host"></a>
更新后的管理程序的主机。这可以是 IP 地址或完全限定域名 (FQDN)。  
类型：字符串  
长度约束：最小长度为 3。最大长度为 128。  
模式：`.+`  
必需：否

 ** [HypervisorArn](#API_BGW_UpdateHypervisor_RequestSyntax) **   <a name="Backup-BGW_UpdateHypervisor-request-HypervisorArn"></a>
要更新的管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
是否必需：是

 ** [LogGroupArn](#API_BGW_UpdateHypervisor_RequestSyntax) **   <a name="Backup-BGW_UpdateHypervisor-request-LogGroupArn"></a>
请求日志中网关组的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 0。最大长度为 2048。  
模式：`$|^arn:(aws|aws-cn|aws-us-gov):logs:([a-zA-Z0-9-]+):([0-9]+):log-group:[a-zA-Z0-9_\-\/\.]+:\*`  
必需：否

 ** [Name](#API_BGW_UpdateHypervisor_RequestSyntax) **   <a name="Backup-BGW_UpdateHypervisor-request-Name"></a>
更新后的管理程序名称  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[a-zA-Z0-9-]*`  
必需：否

 ** [Password](#API_BGW_UpdateHypervisor_RequestSyntax) **   <a name="Backup-BGW_UpdateHypervisor-request-Password"></a>
更新后的管理程序密码。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[ -~]+`  
必需：否

 ** [Username](#API_BGW_UpdateHypervisor_RequestSyntax) **   <a name="Backup-BGW_UpdateHypervisor-request-Username"></a>
更新后的管理程序用户名。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*`  
必需：否

## 响应语法
<a name="API_BGW_UpdateHypervisor_ResponseSyntax"></a>

```
{
   "HypervisorArn": "string"
}
```

## 响应元素
<a name="API_BGW_UpdateHypervisor_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [HypervisorArn](#API_BGW_UpdateHypervisor_ResponseSyntax) **   <a name="Backup-BGW_UpdateHypervisor-response-HypervisorArn"></a>
您已更新的管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

## 错误
<a name="API_BGW_UpdateHypervisor_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** AccessDeniedException **   
由于您的权限不足，操作无法继续。    
 ** ErrorCode **   
对您的权限不足的原因的描述。
HTTP 状态代码：400

 ** ConflictException **   
由于不支持该操作，因此无法继续操作。    
 ** ErrorCode **   
对不支持该操作的原因的描述。
HTTP 状态代码：400

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

## 另请参阅
<a name="API_BGW_UpdateHypervisor_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/UpdateHypervisor) 

# AWS Backup 搜索
<a name="API_Operations_AWS_Backup_Search"></a>

以下操作受以下支持 AWS Backup 搜索：
+  [GetSearchJob](API_BKS_GetSearchJob.md) 
+  [GetSearchResultExportJob](API_BKS_GetSearchResultExportJob.md) 
+  [ListSearchJobBackups](API_BKS_ListSearchJobBackups.md) 
+  [ListSearchJobResults](API_BKS_ListSearchJobResults.md) 
+  [ListSearchJobs](API_BKS_ListSearchJobs.md) 
+  [ListSearchResultExportJobs](API_BKS_ListSearchResultExportJobs.md) 
+  [ListTagsForResource](API_BKS_ListTagsForResource.md) 
+  [StartSearchJob](API_BKS_StartSearchJob.md) 
+  [StartSearchResultExportJob](API_BKS_StartSearchResultExportJob.md) 
+  [StopSearchJob](API_BKS_StopSearchJob.md) 
+  [TagResource](API_BKS_TagResource.md) 
+  [UntagResource](API_BKS_UntagResource.md) 

# GetSearchJob
<a name="API_BKS_GetSearchJob"></a>

此操作可检索搜索作业的元数据，包括其进度。

## 请求语法
<a name="API_BKS_GetSearchJob_RequestSyntax"></a>

```
GET /search-jobs/SearchJobIdentifier HTTP/1.1
```

## URI 请求参数
<a name="API_BKS_GetSearchJob_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [SearchJobIdentifier](#API_BKS_GetSearchJob_RequestSyntax) **   <a name="Backup-BKS_GetSearchJob-request-uri-SearchJobIdentifier"></a>
指定搜索作业的必填唯一字符串。  
是否必需：是

## 请求体
<a name="API_BKS_GetSearchJob_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<a name="API_BKS_GetSearchJob_ResponseSyntax"></a>

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

{
   "CompletionTime": number,
   "CreationTime": number,
   "CurrentSearchProgress": { 
      "ItemsMatchedCount": number,
      "ItemsScannedCount": number,
      "RecoveryPointsScannedCount": number
   },
   "EncryptionKeyArn": "string",
   "ItemFilters": { 
      "EBSItemFilters": [ 
         { 
            "CreationTimes": [ 
               { 
                  "Operator": "string",
                  "Value": number
               }
            ],
            "FilePaths": [ 
               { 
                  "Operator": "string",
                  "Value": "string"
               }
            ],
            "LastModificationTimes": [ 
               { 
                  "Operator": "string",
                  "Value": number
               }
            ],
            "Sizes": [ 
               { 
                  "Operator": "string",
                  "Value": number
               }
            ]
         }
      ],
      "S3ItemFilters": [ 
         { 
            "CreationTimes": [ 
               { 
                  "Operator": "string",
                  "Value": number
               }
            ],
            "ETags": [ 
               { 
                  "Operator": "string",
                  "Value": "string"
               }
            ],
            "ObjectKeys": [ 
               { 
                  "Operator": "string",
                  "Value": "string"
               }
            ],
            "Sizes": [ 
               { 
                  "Operator": "string",
                  "Value": number
               }
            ],
            "VersionIds": [ 
               { 
                  "Operator": "string",
                  "Value": "string"
               }
            ]
         }
      ]
   },
   "Name": "string",
   "SearchJobArn": "string",
   "SearchJobIdentifier": "string",
   "SearchScope": { 
      "BackupResourceArns": [ "string" ],
      "BackupResourceCreationTime": { 
         "CreatedAfter": number,
         "CreatedBefore": number
      },
      "BackupResourceTags": { 
         "string" : "string" 
      },
      "BackupResourceTypes": [ "string" ],
      "SourceResourceArns": [ "string" ]
   },
   "SearchScopeSummary": { 
      "TotalItemsToScanCount": number,
      "TotalRecoveryPointsToScanCount": number
   },
   "Status": "string",
   "StatusMessage": "string"
}
```

## 响应元素
<a name="API_BKS_GetSearchJob_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [CompletionTime](#API_BKS_GetSearchJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchJob-response-CompletionTime"></a>
搜索作业的完成日期和时间，采用 Unix 格式和协调世界时（UTC）。`CompletionTime` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳

 ** [CreationTime](#API_BKS_GetSearchJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchJob-response-CreationTime"></a>
搜索作业的创建日期和时间，采用 Unix 时间格式和协调世界时（UTC）。`CompletionTime` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳

 ** [CurrentSearchProgress](#API_BKS_GetSearchJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchJob-response-CurrentSearchProgress"></a>
返回表示 BackupsScannedCount ItemsScanned、和的数字 ItemsMatched。  
类型：[CurrentSearchProgress](API_BKS_CurrentSearchProgress.md) 对象

 ** [EncryptionKeyArn](#API_BKS_GetSearchJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchJob-response-EncryptionKeyArn"></a>
指定搜索作业的加密密钥。  
示例：`arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`。  
类型：字符串

 ** [ItemFilters](#API_BKS_GetSearchJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchJob-response-ItemFilters"></a>
项目筛选条件表示创建搜索时指定的所有输入项目属性。  
类型：[ItemFilters](API_BKS_ItemFilters.md) 对象

 ** [Name](#API_BKS_GetSearchJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchJob-response-Name"></a>
返回的指定搜索作业的名称。  
类型：字符串

 ** [SearchJobArn](#API_BKS_GetSearchJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchJob-response-SearchJobArn"></a>
标识指定搜索作业的 Amazon 资源名称（ARN）的唯一字符串。  
类型：字符串

 ** [SearchJobIdentifier](#API_BKS_GetSearchJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchJob-response-SearchJobIdentifier"></a>
标识指定搜索作业的唯一字符串。  
类型：字符串

 ** [SearchScope](#API_BKS_GetSearchJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchJob-response-SearchScope"></a>
搜索范围为所有输入到搜索中的备份属性。  
类型：[SearchScope](API_BKS_SearchScope.md) 对象

 ** [SearchScopeSummary](#API_BKS_GetSearchJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchJob-response-SearchScopeSummary"></a>
返回的指定搜索作业范围的摘要，包括：  
+ TotalBackupsToScanCount，搜索返回的恢复点数。
+ TotalItemsToScanCount，搜索返回的商品数量。
类型：[SearchScopeSummary](API_BKS_SearchScopeSummary.md) 对象

 ** [Status](#API_BKS_GetSearchJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchJob-response-Status"></a>
指定搜索作业的当前状态。  
搜索作业可能具有以下状态之一：`RUNNING`、`COMPLETED`、`STOPPED`、`FAILED`、`TIMED_OUT` 或 `EXPIRED`。  
类型：字符串  
有效值：`RUNNING | COMPLETED | STOPPING | STOPPED | FAILED`

 ** [StatusMessage](#API_BKS_GetSearchJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchJob-response-StatusMessage"></a>
对于状态为 `ERRORED` 的搜索作业或状态为 `COMPLETED` 且存在问题的搜索作业，将返回状态消息。  
例如，一条消息可能会显示，由于权限问题，搜索结果中包含无法扫描的恢复点。  
类型：字符串

## 错误
<a name="API_BKS_GetSearchJob_Errors"></a>

有关所有操作的常见错误信息，请参阅 [常见错误类型](CommonErrors.md)。

 ** AccessDeniedException **   
您没有足够的访问权限，无法执行该操作。    
 ** message **   
用户没有足够的访问权限，无法执行该操作。
HTTP 状态代码：403

 ** InternalServerException **   
发生内部服务器错误。重试您的请求。    
 ** message **   
请求处理过程中发生意外错误。  
 ** retryAfterSeconds **   
等待指定秒数后重试此调用。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到此请求所需的资源。  
确认资源信息（例如 ARN 或类型）正确无误且存在，然后重试请求。    
 ** message **   
请求引用的资源不存在。  
 ** resourceId **   
受影响资源的假设性标识符。  
 ** resourceType **   
受影响资源的假设性类型。
HTTP 状态代码：404

 ** ThrottlingException **   
由于请求限制而导致请求被拒绝。    
 ** message **   
由于请求节流，请求失败。  
 ** quotaCode **   
这是具有限额的原始服务所独有的代码。  
 ** retryAfterSeconds **   
等待指定秒数后重试此调用。  
 ** serviceCode **   
这是原始服务所独有的代码。
HTTP 状态代码：429

 ** ValidationException **   
输入未能满足服务指定的约束条件。    
 ** message **   
输入未能满足 Amazon 服务指定的约束条件。
HTTP 状态代码：400

## 另请参阅
<a name="API_BKS_GetSearchJob_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backupsearch-2018-05-10/GetSearchJob) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/GetSearchJob) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/GetSearchJob) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/GetSearchJob) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/GetSearchJob) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/GetSearchJob) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/GetSearchJob) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/GetSearchJob) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/GetSearchJob) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/GetSearchJob) 

# GetSearchResultExportJob
<a name="API_BKS_GetSearchResultExportJob"></a>

此操作可检索导出作业的元数据。

导出作业是一项将搜索作业的结果传输到 .csv 文件中的指定 S3 存储桶的操作。

导出作业可让您将搜索结果保留超过搜索作业预设的 7 天保留期限。

## 请求语法
<a name="API_BKS_GetSearchResultExportJob_RequestSyntax"></a>

```
GET /export-search-jobs/ExportJobIdentifier HTTP/1.1
```

## URI 请求参数
<a name="API_BKS_GetSearchResultExportJob_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [ExportJobIdentifier](#API_BKS_GetSearchResultExportJob_RequestSyntax) **   <a name="Backup-BKS_GetSearchResultExportJob-request-uri-ExportJobIdentifier"></a>
这是标识特定导出作业的唯一字符串。  
对于此操作来说是必填项。  
是否必需：是

## 请求体
<a name="API_BKS_GetSearchResultExportJob_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<a name="API_BKS_GetSearchResultExportJob_ResponseSyntax"></a>

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

{
   "CompletionTime": number,
   "CreationTime": number,
   "ExportJobArn": "string",
   "ExportJobIdentifier": "string",
   "ExportSpecification": { ... },
   "SearchJobArn": "string",
   "Status": "string",
   "StatusMessage": "string"
}
```

## 响应元素
<a name="API_BKS_GetSearchResultExportJob_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [CompletionTime](#API_BKS_GetSearchResultExportJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchResultExportJob-response-CompletionTime"></a>
导出作业的完成日期和时间，采用 Unix 格式和协调世界时（UTC）。`CreationTime` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳

 ** [CreationTime](#API_BKS_GetSearchResultExportJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchResultExportJob-response-CreationTime"></a>
导出作业的创建日期和时间，采用 Unix 时间格式和协调世界时（UTC）。`CreationTime` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳

 ** [ExportJobArn](#API_BKS_GetSearchResultExportJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchResultExportJob-response-ExportJobArn"></a>
唯一标识导出作业的唯一 Amazon 资源名称（ARN）。  
类型：字符串

 ** [ExportJobIdentifier](#API_BKS_GetSearchResultExportJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchResultExportJob-response-ExportJobIdentifier"></a>
这是标识指定导出作业的唯一字符串。  
类型：字符串

 ** [ExportSpecification](#API_BKS_GetSearchResultExportJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchResultExportJob-response-ExportSpecification"></a>
导出规范由搜索结果导出到的目标 S3 存储桶以及目标前缀组成。  
类型：[ExportSpecification](API_BKS_ExportSpecification.md) 对象  
 **注意：**此对象是 Union 类型。只能指定或返回此对象的一个成员。

 ** [SearchJobArn](#API_BKS_GetSearchResultExportJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchResultExportJob-response-SearchJobArn"></a>
标识指定搜索作业的 Amazon 资源名称（ARN）的唯一字符串。  
类型：字符串

 ** [Status](#API_BKS_GetSearchResultExportJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchResultExportJob-response-Status"></a>
这是导出作业的当前状态。  
类型：字符串  
有效值：`RUNNING | FAILED | COMPLETED`

 ** [StatusMessage](#API_BKS_GetSearchResultExportJob_ResponseSyntax) **   <a name="Backup-BKS_GetSearchResultExportJob-response-StatusMessage"></a>
状态消息是针对状态为 `FAILED` 的搜索作业返回的字符串，其中包含补救和重试操作的步骤。  
类型：字符串

## 错误
<a name="API_BKS_GetSearchResultExportJob_Errors"></a>

有关所有操作的常见错误信息，请参阅 [常见错误类型](CommonErrors.md)。

 ** AccessDeniedException **   
您没有足够的访问权限，无法执行该操作。    
 ** message **   
用户没有足够的访问权限，无法执行该操作。
HTTP 状态代码：403

 ** InternalServerException **   
发生内部服务器错误。重试您的请求。    
 ** message **   
请求处理过程中发生意外错误。  
 ** retryAfterSeconds **   
等待指定秒数后重试此调用。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到此请求所需的资源。  
确认资源信息（例如 ARN 或类型）正确无误且存在，然后重试请求。    
 ** message **   
请求引用的资源不存在。  
 ** resourceId **   
受影响资源的假设性标识符。  
 ** resourceType **   
受影响资源的假设性类型。
HTTP 状态代码：404

 ** ThrottlingException **   
由于请求限制而导致请求被拒绝。    
 ** message **   
由于请求节流，请求失败。  
 ** quotaCode **   
这是具有限额的原始服务所独有的代码。  
 ** retryAfterSeconds **   
等待指定秒数后重试此调用。  
 ** serviceCode **   
这是原始服务所独有的代码。
HTTP 状态代码：429

 ** ValidationException **   
输入未能满足服务指定的约束条件。    
 ** message **   
输入未能满足 Amazon 服务指定的约束条件。
HTTP 状态代码：400

## 另请参阅
<a name="API_BKS_GetSearchResultExportJob_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backupsearch-2018-05-10/GetSearchResultExportJob) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/GetSearchResultExportJob) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/GetSearchResultExportJob) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/GetSearchResultExportJob) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/GetSearchResultExportJob) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/GetSearchResultExportJob) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/GetSearchResultExportJob) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/GetSearchResultExportJob) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/GetSearchResultExportJob) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/GetSearchResultExportJob) 

# ListSearchJobBackups
<a name="API_BKS_ListSearchJobBackups"></a>

此操作以分页格式返回搜索作业中包含的所有备份（恢复点）的列表。

如果搜索结果中未显示预期的备份，则您可以调用此操作来显示搜索结果中包含的每项备份。系统将显示任何因权限问题而处于 `FAILED` 状态且未包含在内的备份以及状态消息。

搜索结果中仅包含备份索引状态为 `ACTIVE` 的恢复点。如果索引有任何其他状态，则其状态将与状态消息一起显示。

## 请求语法
<a name="API_BKS_ListSearchJobBackups_RequestSyntax"></a>

```
GET /search-jobs/SearchJobIdentifier/backups?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI 请求参数
<a name="API_BKS_ListSearchJobBackups_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [MaxResults](#API_BKS_ListSearchJobBackups_RequestSyntax) **   <a name="Backup-BKS_ListSearchJobBackups-request-uri-MaxResults"></a>
要返回的资源列表项的最大数量。  
有效范围：最小值为 1。最大值为 1000。

 ** [NextToken](#API_BKS_ListSearchJobBackups_RequestSyntax) **   <a name="Backup-BKS_ListSearchJobBackups-request-uri-NextToken"></a>
搜索作业中包含的所返回备份的部分列表的后续下一个项目。  
例如，如果请求返回 `MaxResults` 数量的备份，则 `NextToken` 允许您从下一个令牌指向的位置开始返回列表中的更多项目。

 ** [SearchJobIdentifier](#API_BKS_ListSearchJobBackups_RequestSyntax) **   <a name="Backup-BKS_ListSearchJobBackups-request-uri-SearchJobIdentifier"></a>
指定搜索作业的唯一字符串。  
是否必需：是

## 请求体
<a name="API_BKS_ListSearchJobBackups_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<a name="API_BKS_ListSearchJobBackups_ResponseSyntax"></a>

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

{
   "NextToken": "string",
   "Results": [ 
      { 
         "BackupCreationTime": number,
         "BackupResourceArn": "string",
         "IndexCreationTime": number,
         "ResourceType": "string",
         "SourceResourceArn": "string",
         "Status": "string",
         "StatusMessage": "string"
      }
   ]
}
```

## 响应元素
<a name="API_BKS_ListSearchJobBackups_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [NextToken](#API_BKS_ListSearchJobBackups_ResponseSyntax) **   <a name="Backup-BKS_ListSearchJobBackups-response-NextToken"></a>
搜索作业中包含的所返回备份的部分列表的后续下一个项目。  
例如，如果请求返回 `MaxResults` 数量的备份，则 `NextToken` 允许您从下一个令牌指向的位置开始返回列表中的更多项目。  
类型：字符串

 ** [Results](#API_BKS_ListSearchJobBackups_ResponseSyntax) **   <a name="Backup-BKS_ListSearchJobBackups-response-Results"></a>
恢复点返回了搜索作业的结果  
类型：[SearchJobBackupsResult](API_BKS_SearchJobBackupsResult.md) 对象数组

## 错误
<a name="API_BKS_ListSearchJobBackups_Errors"></a>

有关所有操作的常见错误信息，请参阅 [常见错误类型](CommonErrors.md)。

 ** AccessDeniedException **   
您没有足够的访问权限，无法执行该操作。    
 ** message **   
用户没有足够的访问权限，无法执行该操作。
HTTP 状态代码：403

 ** InternalServerException **   
发生内部服务器错误。重试您的请求。    
 ** message **   
请求处理过程中发生意外错误。  
 ** retryAfterSeconds **   
等待指定秒数后重试此调用。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到此请求所需的资源。  
确认资源信息（例如 ARN 或类型）正确无误且存在，然后重试请求。    
 ** message **   
请求引用的资源不存在。  
 ** resourceId **   
受影响资源的假设性标识符。  
 ** resourceType **   
受影响资源的假设性类型。
HTTP 状态代码：404

 ** ThrottlingException **   
由于请求限制而导致请求被拒绝。    
 ** message **   
由于请求节流，请求失败。  
 ** quotaCode **   
这是具有限额的原始服务所独有的代码。  
 ** retryAfterSeconds **   
等待指定秒数后重试此调用。  
 ** serviceCode **   
这是原始服务所独有的代码。
HTTP 状态代码：429

 ** ValidationException **   
输入未能满足服务指定的约束条件。    
 ** message **   
输入未能满足 Amazon 服务指定的约束条件。
HTTP 状态代码：400

## 另请参阅
<a name="API_BKS_ListSearchJobBackups_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backupsearch-2018-05-10/ListSearchJobBackups) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/ListSearchJobBackups) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/ListSearchJobBackups) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/ListSearchJobBackups) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/ListSearchJobBackups) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/ListSearchJobBackups) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/ListSearchJobBackups) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/ListSearchJobBackups) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/ListSearchJobBackups) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/ListSearchJobBackups) 

# ListSearchJobResults
<a name="API_BKS_ListSearchJobResults"></a>

此操作返回指定搜索作业的列表。

## 请求语法
<a name="API_BKS_ListSearchJobResults_RequestSyntax"></a>

```
GET /search-jobs/SearchJobIdentifier/search-results?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI 请求参数
<a name="API_BKS_ListSearchJobResults_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [MaxResults](#API_BKS_ListSearchJobResults_RequestSyntax) **   <a name="Backup-BKS_ListSearchJobResults-request-uri-MaxResults"></a>
要返回的资源列表项的最大数量。  
有效范围：最小值为 1。最大值为 1000。

 ** [NextToken](#API_BKS_ListSearchJobResults_RequestSyntax) **   <a name="Backup-BKS_ListSearchJobResults-request-uri-NextToken"></a>
所返回搜索作业结果的部分列表的后续下一个项目。  
例如，如果请求返回 `MaxResults` 数量的搜索作业结果，则 `NextToken` 允许您从下一个令牌指向的位置开始返回列表中的更多项目。

 ** [SearchJobIdentifier](#API_BKS_ListSearchJobResults_RequestSyntax) **   <a name="Backup-BKS_ListSearchJobResults-request-uri-SearchJobIdentifier"></a>
指定搜索作业的唯一字符串。  
是否必需：是

## 请求体
<a name="API_BKS_ListSearchJobResults_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<a name="API_BKS_ListSearchJobResults_ResponseSyntax"></a>

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

{
   "NextToken": "string",
   "Results": [ 
      { ... }
   ]
}
```

## 响应元素
<a name="API_BKS_ListSearchJobResults_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [NextToken](#API_BKS_ListSearchJobResults_ResponseSyntax) **   <a name="Backup-BKS_ListSearchJobResults-response-NextToken"></a>
搜索作业结果的部分列表的后续下一个项目。  
例如，如果请求返回 `MaxResults` 数量的备份，则 `NextToken` 允许您从下一个令牌指向的位置开始返回列表中的更多项目。  
类型：字符串

 ** [Results](#API_BKS_ListSearchJobResults_ResponseSyntax) **   <a name="Backup-BKS_ListSearchJobResults-response-Results"></a>
结果由 EBSResult项目或 S3 组成ResultItem。  
类型：[ResultItem](API_BKS_ResultItem.md) 对象数组

## 错误
<a name="API_BKS_ListSearchJobResults_Errors"></a>

有关所有操作的常见错误信息，请参阅 [常见错误类型](CommonErrors.md)。

 ** AccessDeniedException **   
您没有足够的访问权限，无法执行该操作。    
 ** message **   
用户没有足够的访问权限，无法执行该操作。
HTTP 状态代码：403

 ** InternalServerException **   
发生内部服务器错误。重试您的请求。    
 ** message **   
请求处理过程中发生意外错误。  
 ** retryAfterSeconds **   
等待指定秒数后重试此调用。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到此请求所需的资源。  
确认资源信息（例如 ARN 或类型）正确无误且存在，然后重试请求。    
 ** message **   
请求引用的资源不存在。  
 ** resourceId **   
受影响资源的假设性标识符。  
 ** resourceType **   
受影响资源的假设性类型。
HTTP 状态代码：404

 ** ThrottlingException **   
由于请求限制而导致请求被拒绝。    
 ** message **   
由于请求节流，请求失败。  
 ** quotaCode **   
这是具有限额的原始服务所独有的代码。  
 ** retryAfterSeconds **   
等待指定秒数后重试此调用。  
 ** serviceCode **   
这是原始服务所独有的代码。
HTTP 状态代码：429

 ** ValidationException **   
输入未能满足服务指定的约束条件。    
 ** message **   
输入未能满足 Amazon 服务指定的约束条件。
HTTP 状态代码：400

## 另请参阅
<a name="API_BKS_ListSearchJobResults_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backupsearch-2018-05-10/ListSearchJobResults) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/ListSearchJobResults) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/ListSearchJobResults) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/ListSearchJobResults) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/ListSearchJobResults) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/ListSearchJobResults) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/ListSearchJobResults) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/ListSearchJobResults) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/ListSearchJobResults) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/ListSearchJobResults) 

# ListSearchJobs
<a name="API_BKS_ListSearchJobs"></a>

此操作会返回属于某个账户的搜索作业列表。

## 请求语法
<a name="API_BKS_ListSearchJobs_RequestSyntax"></a>

```
GET /search-jobs?MaxResults=MaxResults&NextToken=NextToken&Status=ByStatus HTTP/1.1
```

## URI 请求参数
<a name="API_BKS_ListSearchJobs_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [ByStatus](#API_BKS_ListSearchJobs_RequestSyntax) **   <a name="Backup-BKS_ListSearchJobs-request-uri-ByStatus"></a>
包含此参数可按搜索作业状态筛选列表。  
有效值：`RUNNING | COMPLETED | STOPPING | STOPPED | FAILED`

 ** [MaxResults](#API_BKS_ListSearchJobs_RequestSyntax) **   <a name="Backup-BKS_ListSearchJobs-request-uri-MaxResults"></a>
要返回的资源列表项的最大数量。  
有效范围：最小值为 1。最大值为 1000。

 ** [NextToken](#API_BKS_ListSearchJobs_RequestSyntax) **   <a name="Backup-BKS_ListSearchJobs-request-uri-NextToken"></a>
所返回搜索作业的部分列表的后续下一个项目。  
例如，如果请求返回 `MaxResults` 数量的备份，则 `NextToken` 允许您从下一个令牌指向的位置开始返回列表中的更多项目。

## 请求正文
<a name="API_BKS_ListSearchJobs_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<a name="API_BKS_ListSearchJobs_ResponseSyntax"></a>

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

{
   "NextToken": "string",
   "SearchJobs": [ 
      { 
         "CompletionTime": number,
         "CreationTime": number,
         "Name": "string",
         "SearchJobArn": "string",
         "SearchJobIdentifier": "string",
         "SearchScopeSummary": { 
            "TotalItemsToScanCount": number,
            "TotalRecoveryPointsToScanCount": number
         },
         "Status": "string",
         "StatusMessage": "string"
      }
   ]
}
```

## 响应元素
<a name="API_BKS_ListSearchJobs_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [NextToken](#API_BKS_ListSearchJobs_ResponseSyntax) **   <a name="Backup-BKS_ListSearchJobs-response-NextToken"></a>
搜索作业中包含的所返回备份的部分列表的后续下一个项目。  
例如，如果请求返回 `MaxResults` 数量的备份，则 `NextToken` 允许您从下一个令牌指向的位置开始返回列表中的更多项目。  
类型：字符串

 ** [SearchJobs](#API_BKS_ListSearchJobs_ResponseSyntax) **   <a name="Backup-BKS_ListSearchJobs-response-SearchJobs"></a>
列表中的搜索作业，以及返回的搜索作业的详细信息。  
类型：[SearchJobSummary](API_BKS_SearchJobSummary.md) 对象数组

## 错误
<a name="API_BKS_ListSearchJobs_Errors"></a>

有关所有操作的常见错误信息，请参阅 [常见错误类型](CommonErrors.md)。

 ** AccessDeniedException **   
您没有足够的访问权限，无法执行该操作。    
 ** message **   
用户没有足够的访问权限，无法执行该操作。
HTTP 状态代码：403

 ** InternalServerException **   
发生内部服务器错误。重试您的请求。    
 ** message **   
请求处理过程中发生意外错误。  
 ** retryAfterSeconds **   
等待指定秒数后重试此调用。
HTTP 状态代码：500

 ** ThrottlingException **   
由于请求限制而导致请求被拒绝。    
 ** message **   
由于请求节流，请求失败。  
 ** quotaCode **   
这是具有限额的原始服务所独有的代码。  
 ** retryAfterSeconds **   
等待指定秒数后重试此调用。  
 ** serviceCode **   
这是原始服务所独有的代码。
HTTP 状态代码：429

 ** ValidationException **   
输入未能满足服务指定的约束条件。    
 ** message **   
输入未能满足 Amazon 服务指定的约束条件。
HTTP 状态代码：400

## 另请参阅
<a name="API_BKS_ListSearchJobs_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backupsearch-2018-05-10/ListSearchJobs) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/ListSearchJobs) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/ListSearchJobs) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/ListSearchJobs) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/ListSearchJobs) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/ListSearchJobs) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/ListSearchJobs) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/ListSearchJobs) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/ListSearchJobs) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/ListSearchJobs) 

# ListSearchResultExportJobs
<a name="API_BKS_ListSearchResultExportJobs"></a>

此操作将搜索作业的搜索结果导出到指定的目标 S3 存储桶。

## 请求语法
<a name="API_BKS_ListSearchResultExportJobs_RequestSyntax"></a>

```
GET /export-search-jobs?MaxResults=MaxResults&NextToken=NextToken&SearchJobIdentifier=SearchJobIdentifier&Status=Status HTTP/1.1
```

## URI 请求参数
<a name="API_BKS_ListSearchResultExportJobs_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [MaxResults](#API_BKS_ListSearchResultExportJobs_RequestSyntax) **   <a name="Backup-BKS_ListSearchResultExportJobs-request-uri-MaxResults"></a>
要返回的资源列表项的最大数量。  
有效范围：最小值为 1。最大值为 1000。

 ** [NextToken](#API_BKS_ListSearchResultExportJobs_RequestSyntax) **   <a name="Backup-BKS_ListSearchResultExportJobs-request-uri-NextToken"></a>
搜索作业中包含的所返回备份的部分列表的后续下一个项目。  
例如，如果请求返回 `MaxResults` 数量的备份，则 `NextToken` 允许您从下一个令牌指向的位置开始返回列表中的更多项目。

 ** [SearchJobIdentifier](#API_BKS_ListSearchResultExportJobs_RequestSyntax) **   <a name="Backup-BKS_ListSearchResultExportJobs-request-uri-SearchJobIdentifier"></a>
指定搜索作业的唯一字符串。

 ** [Status](#API_BKS_ListSearchResultExportJobs_RequestSyntax) **   <a name="Backup-BKS_ListSearchResultExportJobs-request-uri-Status"></a>
通过包含此参数，可以筛选要包含在导出作业中的搜索作业。  
有效值：`RUNNING | FAILED | COMPLETED`

## 请求正文
<a name="API_BKS_ListSearchResultExportJobs_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<a name="API_BKS_ListSearchResultExportJobs_ResponseSyntax"></a>

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

{
   "ExportJobs": [ 
      { 
         "CompletionTime": number,
         "CreationTime": number,
         "ExportJobArn": "string",
         "ExportJobIdentifier": "string",
         "SearchJobArn": "string",
         "Status": "string",
         "StatusMessage": "string"
      }
   ],
   "NextToken": "string"
}
```

## 响应元素
<a name="API_BKS_ListSearchResultExportJobs_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [ExportJobs](#API_BKS_ListSearchResultExportJobs_ResponseSyntax) **   <a name="Backup-BKS_ListSearchResultExportJobs-response-ExportJobs"></a>
该操作会返回所包含的导出作业。  
类型：[ExportJobSummary](API_BKS_ExportJobSummary.md) 对象数组

 ** [NextToken](#API_BKS_ListSearchResultExportJobs_ResponseSyntax) **   <a name="Backup-BKS_ListSearchResultExportJobs-response-NextToken"></a>
搜索作业中包含的所返回备份的部分列表的后续下一个项目。  
例如，如果请求返回 `MaxResults` 数量的备份，则 `NextToken` 允许您从下一个令牌指向的位置开始返回列表中的更多项目。  
类型：字符串

## 错误
<a name="API_BKS_ListSearchResultExportJobs_Errors"></a>

有关所有操作的常见错误信息，请参阅 [常见错误类型](CommonErrors.md)。

 ** AccessDeniedException **   
您没有足够的访问权限，无法执行该操作。    
 ** message **   
用户没有足够的访问权限，无法执行该操作。
HTTP 状态代码：403

 ** InternalServerException **   
发生内部服务器错误。重试您的请求。    
 ** message **   
请求处理过程中发生意外错误。  
 ** retryAfterSeconds **   
等待指定秒数后重试此调用。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到此请求所需的资源。  
确认资源信息（例如 ARN 或类型）正确无误且存在，然后重试请求。    
 ** message **   
请求引用的资源不存在。  
 ** resourceId **   
受影响资源的假设性标识符。  
 ** resourceType **   
受影响资源的假设性类型。
HTTP 状态代码：404

 ** ServiceQuotaExceededException **   
由于超出允许的配额限制，请求被拒绝。    
 ** message **   
由于服务配额超过限制，此请求失败。  
 ** quotaCode **   
这是配额类型特有的代码。  
 ** resourceId **   
资源的标识符。  
 ** resourceType **   
资源的类型。  
 ** serviceCode **   
这是具有限额的原始服务所独有的代码。
HTTP 状态代码：402

 ** ThrottlingException **   
由于请求限制而导致请求被拒绝。    
 ** message **   
由于请求节流，请求失败。  
 ** quotaCode **   
这是具有限额的原始服务所独有的代码。  
 ** retryAfterSeconds **   
等待指定秒数后重试此调用。  
 ** serviceCode **   
这是原始服务所独有的代码。
HTTP 状态代码：429

 ** ValidationException **   
输入未能满足服务指定的约束条件。    
 ** message **   
输入未能满足 Amazon 服务指定的约束条件。
HTTP 状态代码：400

## 另请参阅
<a name="API_BKS_ListSearchResultExportJobs_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backupsearch-2018-05-10/ListSearchResultExportJobs) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/ListSearchResultExportJobs) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/ListSearchResultExportJobs) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/ListSearchResultExportJobs) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/ListSearchResultExportJobs) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/ListSearchResultExportJobs) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/ListSearchResultExportJobs) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/ListSearchResultExportJobs) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/ListSearchResultExportJobs) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/ListSearchResultExportJobs) 

# ListTagsForResource
<a name="API_BKS_ListTagsForResource"></a>

此操作会返回资源类型的标签。

## 请求语法
<a name="API_BKS_ListTagsForResource_RequestSyntax"></a>

```
GET /tags/ResourceArn HTTP/1.1
```

## URI 请求参数
<a name="API_BKS_ListTagsForResource_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [ResourceArn](#API_BKS_ListTagsForResource_RequestSyntax) **   <a name="Backup-BKS_ListTagsForResource-request-uri-ResourceArn"></a>
唯一标识资源的 Amazon 资源名称（ARN）。>  
是否必需：是

## 请求体
<a name="API_BKS_ListTagsForResource_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<a name="API_BKS_ListTagsForResource_ResponseSyntax"></a>

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

{
   "Tags": { 
      "string" : "string" 
   }
}
```

## 响应元素
<a name="API_BKS_ListTagsForResource_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Tags](#API_BKS_ListTagsForResource_ResponseSyntax) **   <a name="Backup-BKS_ListTagsForResource-response-Tags"></a>
操作返回的标签列表。  
类型：字符串到字符串映射

## 错误
<a name="API_BKS_ListTagsForResource_Errors"></a>

有关所有操作的常见错误信息，请参阅 [常见错误类型](CommonErrors.md)。

 ** AccessDeniedException **   
您没有足够的访问权限，无法执行该操作。    
 ** message **   
用户没有足够的访问权限，无法执行该操作。
HTTP 状态代码：403

 ** InternalServerException **   
发生内部服务器错误。重试您的请求。    
 ** message **   
请求处理过程中发生意外错误。  
 ** retryAfterSeconds **   
等待指定秒数后重试此调用。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到此请求所需的资源。  
确认资源信息（例如 ARN 或类型）正确无误且存在，然后重试请求。    
 ** message **   
请求引用的资源不存在。  
 ** resourceId **   
受影响资源的假设性标识符。  
 ** resourceType **   
受影响资源的假设性类型。
HTTP 状态代码：404

 ** ThrottlingException **   
由于请求限制而导致请求被拒绝。    
 ** message **   
由于请求节流，请求失败。  
 ** quotaCode **   
这是具有限额的原始服务所独有的代码。  
 ** retryAfterSeconds **   
等待指定秒数后重试此调用。  
 ** serviceCode **   
这是原始服务所独有的代码。
HTTP 状态代码：429

 ** ValidationException **   
输入未能满足服务指定的约束条件。    
 ** message **   
输入未能满足 Amazon 服务指定的约束条件。
HTTP 状态代码：400

## 另请参阅
<a name="API_BKS_ListTagsForResource_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backupsearch-2018-05-10/ListTagsForResource) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/ListTagsForResource) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/ListTagsForResource) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/ListTagsForResource) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/ListTagsForResource) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/ListTagsForResource) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/ListTagsForResource) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/ListTagsForResource) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/ListTagsForResource) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/ListTagsForResource) 

# StartSearchJob
<a name="API_BKS_StartSearchJob"></a>

此操作创建了一个搜索作业，该作业返回按筛选的恢复点 SearchScope 和筛选的项目 ItemFilters。

您可以选择包含 ClientToken、 EncryptionKeyArn、名称、 and/or 标签。

## 请求语法
<a name="API_BKS_StartSearchJob_RequestSyntax"></a>

```
PUT /search-jobs HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "EncryptionKeyArn": "string",
   "ItemFilters": { 
      "EBSItemFilters": [ 
         { 
            "CreationTimes": [ 
               { 
                  "Operator": "string",
                  "Value": number
               }
            ],
            "FilePaths": [ 
               { 
                  "Operator": "string",
                  "Value": "string"
               }
            ],
            "LastModificationTimes": [ 
               { 
                  "Operator": "string",
                  "Value": number
               }
            ],
            "Sizes": [ 
               { 
                  "Operator": "string",
                  "Value": number
               }
            ]
         }
      ],
      "S3ItemFilters": [ 
         { 
            "CreationTimes": [ 
               { 
                  "Operator": "string",
                  "Value": number
               }
            ],
            "ETags": [ 
               { 
                  "Operator": "string",
                  "Value": "string"
               }
            ],
            "ObjectKeys": [ 
               { 
                  "Operator": "string",
                  "Value": "string"
               }
            ],
            "Sizes": [ 
               { 
                  "Operator": "string",
                  "Value": number
               }
            ],
            "VersionIds": [ 
               { 
                  "Operator": "string",
                  "Value": "string"
               }
            ]
         }
      ]
   },
   "Name": "string",
   "SearchScope": { 
      "BackupResourceArns": [ "string" ],
      "BackupResourceCreationTime": { 
         "CreatedAfter": number,
         "CreatedBefore": number
      },
      "BackupResourceTags": { 
         "string" : "string" 
      },
      "BackupResourceTypes": [ "string" ],
      "SourceResourceArns": [ "string" ]
   },
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI 请求参数
<a name="API_BKS_StartSearchJob_RequestParameters"></a>

该请求不使用任何 URI 参数。

## 请求正文
<a name="API_BKS_StartSearchJob_RequestBody"></a>

请求接受采用 JSON 格式的以下数据。

 ** [ClientToken](#API_BKS_StartSearchJob_RequestSyntax) **   <a name="Backup-BKS_StartSearchJob-request-ClientToken"></a>
包含此参数可允许进行多次相同调用，以实现幂等性。  
客户端令牌自首次使用该令牌的请求完成后 8 小时内有效。8 小时后，所有具有相同令牌的请求都将视为新请求。  
类型：字符串  
必需：否

 ** [EncryptionKeyArn](#API_BKS_StartSearchJob_RequestSyntax) **   <a name="Backup-BKS_StartSearchJob-request-EncryptionKeyArn"></a>
指定搜索作业的加密密钥。  
类型：字符串  
必需：否

 ** [ItemFilters](#API_BKS_StartSearchJob_RequestSyntax) **   <a name="Backup-BKS_StartSearchJob-request-ItemFilters"></a>
项目筛选条件表示创建搜索时指定的所有输入项目属性。  
包含 EBSItem过滤器或 S3 ItemFilters  
类型：[ItemFilters](API_BKS_ItemFilters.md) 对象  
必需：否

 ** [Name](#API_BKS_StartSearchJob_RequestSyntax) **   <a name="Backup-BKS_StartSearchJob-request-Name"></a>
需包含字母数字字符，为该搜索作业创建一个名称。  
类型：字符串  
长度限制：最小长度为 0。最大长度为 500。  
必需：否

 ** [SearchScope](#API_BKS_StartSearchJob_RequestSyntax) **   <a name="Backup-BKS_StartSearchJob-request-SearchScope"></a>
此对象可以包含 BackupResourceTypes BackupResourceArns、 BackupResourceCreationTime、 BackupResourceTags、和， SourceResourceArns 以筛选搜索任务返回的恢复点。  
类型：[SearchScope](API_BKS_SearchScope.md) 对象  
是否必需：是

 ** [Tags](#API_BKS_StartSearchJob_RequestSyntax) **   <a name="Backup-BKS_StartSearchJob-request-Tags"></a>
操作返回的标签列表。  
类型：字符串到字符串映射  
必需：否

## 响应语法
<a name="API_BKS_StartSearchJob_ResponseSyntax"></a>

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

{
   "CreationTime": number,
   "SearchJobArn": "string",
   "SearchJobIdentifier": "string"
}
```

## 响应元素
<a name="API_BKS_StartSearchJob_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [CreationTime](#API_BKS_StartSearchJob_ResponseSyntax) **   <a name="Backup-BKS_StartSearchJob-response-CreationTime"></a>
作业的创建日期和时间，采用 Unix 时间格式和协调世界时（UTC）。`CompletionTime` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳

 ** [SearchJobArn](#API_BKS_StartSearchJob_ResponseSyntax) **   <a name="Backup-BKS_StartSearchJob-response-SearchJobArn"></a>
标识指定搜索作业的 Amazon 资源名称（ARN）的唯一字符串。  
类型：字符串

 ** [SearchJobIdentifier](#API_BKS_StartSearchJob_ResponseSyntax) **   <a name="Backup-BKS_StartSearchJob-response-SearchJobIdentifier"></a>
指定搜索作业的唯一字符串。  
类型：字符串

## 错误
<a name="API_BKS_StartSearchJob_Errors"></a>

有关所有操作的常见错误信息，请参阅 [常见错误类型](CommonErrors.md)。

 ** AccessDeniedException **   
您没有足够的访问权限，无法执行该操作。    
 ** message **   
用户没有足够的访问权限，无法执行该操作。
HTTP 状态代码：403

 ** ConflictException **   
当检测到与之前成功执行的操作存在冲突时，会触发此异常。当上一项操作没有时间传播到处理当前请求的主机时，通常会发生这种情况。  
对于此异常，建议的应对方式是重试（需配合适当的退避逻辑）。    
 ** message **   
更新或删除资源可能会导致状态不一致。  
 ** resourceId **   
受影响资源的标识符。  
 ** resourceType **   
受影响资源的类型。
HTTP 状态代码：409

 ** InternalServerException **   
发生内部服务器错误。重试您的请求。    
 ** message **   
请求处理过程中发生意外错误。  
 ** retryAfterSeconds **   
等待指定秒数后重试此调用。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到此请求所需的资源。  
确认资源信息（例如 ARN 或类型）正确无误且存在，然后重试请求。    
 ** message **   
请求引用的资源不存在。  
 ** resourceId **   
受影响资源的假设性标识符。  
 ** resourceType **   
受影响资源的假设性类型。
HTTP 状态代码：404

 ** ServiceQuotaExceededException **   
由于超出允许的配额限制，请求被拒绝。    
 ** message **   
由于服务配额超过限制，此请求失败。  
 ** quotaCode **   
这是配额类型特有的代码。  
 ** resourceId **   
资源的标识符。  
 ** resourceType **   
资源的类型。  
 ** serviceCode **   
这是具有限额的原始服务所独有的代码。
HTTP 状态代码：402

 ** ThrottlingException **   
由于请求限制而导致请求被拒绝。    
 ** message **   
由于请求节流，请求失败。  
 ** quotaCode **   
这是具有限额的原始服务所独有的代码。  
 ** retryAfterSeconds **   
等待指定秒数后重试此调用。  
 ** serviceCode **   
这是原始服务所独有的代码。
HTTP 状态代码：429

 ** ValidationException **   
输入未能满足服务指定的约束条件。    
 ** message **   
输入未能满足 Amazon 服务指定的约束条件。
HTTP 状态代码：400

## 另请参阅
<a name="API_BKS_StartSearchJob_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backupsearch-2018-05-10/StartSearchJob) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/StartSearchJob) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/StartSearchJob) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/StartSearchJob) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/StartSearchJob) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/StartSearchJob) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/StartSearchJob) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/StartSearchJob) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/StartSearchJob) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/StartSearchJob) 

# StartSearchResultExportJob
<a name="API_BKS_StartSearchResultExportJob"></a>

此操作会启动一项作业，将搜索作业的结果导出到指定的 S3 存储桶。

## 请求语法
<a name="API_BKS_StartSearchResultExportJob_RequestSyntax"></a>

```
PUT /export-search-jobs HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "ExportSpecification": { ... },
   "RoleArn": "string",
   "SearchJobIdentifier": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI 请求参数
<a name="API_BKS_StartSearchResultExportJob_RequestParameters"></a>

该请求不使用任何 URI 参数。

## 请求正文
<a name="API_BKS_StartSearchResultExportJob_RequestBody"></a>

请求接受采用 JSON 格式的以下数据。

 ** [ClientToken](#API_BKS_StartSearchResultExportJob_RequestSyntax) **   <a name="Backup-BKS_StartSearchResultExportJob-request-ClientToken"></a>
包含此参数可允许进行多次相同调用，以实现幂等性。  
客户端令牌自首次使用该令牌的请求完成后 8 小时内有效。8 小时后，所有具有相同令牌的请求都将视为新请求。  
类型：字符串  
必需：否

 ** [ExportSpecification](#API_BKS_StartSearchResultExportJob_RequestSyntax) **   <a name="Backup-BKS_StartSearchResultExportJob-request-ExportSpecification"></a>
此规范包含目标存储桶的必填字符串；您也可以选择包含目标前缀。  
类型：[ExportSpecification](API_BKS_ExportSpecification.md) 对象  
 **注意：**此对象是 Union 类型。只能指定或返回此对象的一个成员。  
是否必需：是

 ** [RoleArn](#API_BKS_StartSearchResultExportJob_RequestSyntax) **   <a name="Backup-BKS_StartSearchResultExportJob-request-RoleArn"></a>
此参数指定了用于启动搜索结果导出作业的角色 ARN。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。  
模式：`arn:(?:aws|aws-cn|aws-us-gov):iam::[a-z0-9-]+:role/(.+)`  
必需：否

 ** [SearchJobIdentifier](#API_BKS_StartSearchResultExportJob_RequestSyntax) **   <a name="Backup-BKS_StartSearchResultExportJob-request-SearchJobIdentifier"></a>
指定搜索作业的唯一字符串。  
类型：字符串  
是否必需：是

 ** [Tags](#API_BKS_StartSearchResultExportJob_RequestSyntax) **   <a name="Backup-BKS_StartSearchResultExportJob-request-Tags"></a>
要包括的可选标签。标签是您可用来管理、筛选和搜索资源的键值对。允许使用的字符包括 UTF-8 字母、数字、空格以及以下字符：\$1 - = . \$1 : /。  
类型：字符串到字符串映射  
必需：否

## 响应语法
<a name="API_BKS_StartSearchResultExportJob_ResponseSyntax"></a>

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

{
   "ExportJobArn": "string",
   "ExportJobIdentifier": "string"
}
```

## 响应元素
<a name="API_BKS_StartSearchResultExportJob_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [ExportJobArn](#API_BKS_StartSearchResultExportJob_ResponseSyntax) **   <a name="Backup-BKS_StartSearchResultExportJob-response-ExportJobArn"></a>
这是属于新导出作业的唯一 Amazon 资源名称（ARN）。  
类型：字符串

 ** [ExportJobIdentifier](#API_BKS_StartSearchResultExportJob_ResponseSyntax) **   <a name="Backup-BKS_StartSearchResultExportJob-response-ExportJobIdentifier"></a>
这是指定新导出作业的唯一标识符。  
类型：字符串

## 错误
<a name="API_BKS_StartSearchResultExportJob_Errors"></a>

有关所有操作的常见错误信息，请参阅 [常见错误类型](CommonErrors.md)。

 ** AccessDeniedException **   
您没有足够的访问权限，无法执行该操作。    
 ** message **   
用户没有足够的访问权限，无法执行该操作。
HTTP 状态代码：403

 ** ConflictException **   
当检测到与之前成功执行的操作存在冲突时，会触发此异常。当上一项操作没有时间传播到处理当前请求的主机时，通常会发生这种情况。  
对于此异常，建议的应对方式是重试（需配合适当的退避逻辑）。    
 ** message **   
更新或删除资源可能会导致状态不一致。  
 ** resourceId **   
受影响资源的标识符。  
 ** resourceType **   
受影响资源的类型。
HTTP 状态代码：409

 ** InternalServerException **   
发生内部服务器错误。重试您的请求。    
 ** message **   
请求处理过程中发生意外错误。  
 ** retryAfterSeconds **   
等待指定秒数后重试此调用。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到此请求所需的资源。  
确认资源信息（例如 ARN 或类型）正确无误且存在，然后重试请求。    
 ** message **   
请求引用的资源不存在。  
 ** resourceId **   
受影响资源的假设性标识符。  
 ** resourceType **   
受影响资源的假设性类型。
HTTP 状态代码：404

 ** ServiceQuotaExceededException **   
由于超出允许的配额限制，请求被拒绝。    
 ** message **   
由于服务配额超过限制，此请求失败。  
 ** quotaCode **   
这是配额类型特有的代码。  
 ** resourceId **   
资源的标识符。  
 ** resourceType **   
资源的类型。  
 ** serviceCode **   
这是具有限额的原始服务所独有的代码。
HTTP 状态代码：402

 ** ThrottlingException **   
由于请求限制而导致请求被拒绝。    
 ** message **   
由于请求节流，请求失败。  
 ** quotaCode **   
这是具有限额的原始服务所独有的代码。  
 ** retryAfterSeconds **   
等待指定秒数后重试此调用。  
 ** serviceCode **   
这是原始服务所独有的代码。
HTTP 状态代码：429

 ** ValidationException **   
输入未能满足服务指定的约束条件。    
 ** message **   
输入未能满足 Amazon 服务指定的约束条件。
HTTP 状态代码：400

## 另请参阅
<a name="API_BKS_StartSearchResultExportJob_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backupsearch-2018-05-10/StartSearchResultExportJob) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/StartSearchResultExportJob) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/StartSearchResultExportJob) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/StartSearchResultExportJob) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/StartSearchResultExportJob) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/StartSearchResultExportJob) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/StartSearchResultExportJob) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/StartSearchResultExportJob) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/StartSearchResultExportJob) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/StartSearchResultExportJob) 

# StopSearchJob
<a name="API_BKS_StopSearchJob"></a>

此操作可结束搜索作业。

只能停止状态为 `RUNNING` 的搜索作业。

## 请求语法
<a name="API_BKS_StopSearchJob_RequestSyntax"></a>

```
PUT /search-jobs/SearchJobIdentifier/actions/cancel HTTP/1.1
```

## URI 请求参数
<a name="API_BKS_StopSearchJob_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [SearchJobIdentifier](#API_BKS_StopSearchJob_RequestSyntax) **   <a name="Backup-BKS_StopSearchJob-request-uri-SearchJobIdentifier"></a>
指定搜索作业的唯一字符串。  
是否必需：是

## 请求体
<a name="API_BKS_StopSearchJob_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<a name="API_BKS_StopSearchJob_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 响应元素
<a name="API_BKS_StopSearchJob_ResponseElements"></a>

如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。

## 错误
<a name="API_BKS_StopSearchJob_Errors"></a>

有关所有操作的常见错误信息，请参阅 [常见错误类型](CommonErrors.md)。

 ** AccessDeniedException **   
您没有足够的访问权限，无法执行该操作。    
 ** message **   
用户没有足够的访问权限，无法执行该操作。
HTTP 状态代码：403

 ** ConflictException **   
当检测到与之前成功执行的操作存在冲突时，会触发此异常。当上一项操作没有时间传播到处理当前请求的主机时，通常会发生这种情况。  
对于此异常，建议的应对方式是重试（需配合适当的退避逻辑）。    
 ** message **   
更新或删除资源可能会导致状态不一致。  
 ** resourceId **   
受影响资源的标识符。  
 ** resourceType **   
受影响资源的类型。
HTTP 状态代码：409

 ** InternalServerException **   
发生内部服务器错误。重试您的请求。    
 ** message **   
请求处理过程中发生意外错误。  
 ** retryAfterSeconds **   
等待指定秒数后重试此调用。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到此请求所需的资源。  
确认资源信息（例如 ARN 或类型）正确无误且存在，然后重试请求。    
 ** message **   
请求引用的资源不存在。  
 ** resourceId **   
受影响资源的假设性标识符。  
 ** resourceType **   
受影响资源的假设性类型。
HTTP 状态代码：404

 ** ThrottlingException **   
由于请求限制而导致请求被拒绝。    
 ** message **   
由于请求节流，请求失败。  
 ** quotaCode **   
这是具有限额的原始服务所独有的代码。  
 ** retryAfterSeconds **   
等待指定秒数后重试此调用。  
 ** serviceCode **   
这是原始服务所独有的代码。
HTTP 状态代码：429

 ** ValidationException **   
输入未能满足服务指定的约束条件。    
 ** message **   
输入未能满足 Amazon 服务指定的约束条件。
HTTP 状态代码：400

## 另请参阅
<a name="API_BKS_StopSearchJob_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backupsearch-2018-05-10/StopSearchJob) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/StopSearchJob) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/StopSearchJob) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/StopSearchJob) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/StopSearchJob) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/StopSearchJob) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/StopSearchJob) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/StopSearchJob) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/StopSearchJob) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/StopSearchJob) 

# TagResource
<a name="API_BKS_TagResource"></a>

此操作会为您指定的资源添加标签。

## 请求语法
<a name="API_BKS_TagResource_RequestSyntax"></a>

```
POST /tags/ResourceArn HTTP/1.1
Content-type: application/json

{
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI 请求参数
<a name="API_BKS_TagResource_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [ResourceArn](#API_BKS_TagResource_RequestSyntax) **   <a name="Backup-BKS_TagResource-request-uri-ResourceArn"></a>
唯一标识资源的 Amazon 资源名称（ARN）。  
这就是将要被添加指定标签的资源。  
是否必需：是

## 请求体
<a name="API_BKS_TagResource_RequestBody"></a>

请求接受采用 JSON 格式的以下数据。

 ** [Tags](#API_BKS_TagResource_RequestSyntax) **   <a name="Backup-BKS_TagResource-request-Tags"></a>
必须包含的标签。标签是您可用来管理、筛选和搜索资源的键值对。允许使用的字符包括 UTF-8 字母、数字、空格以及以下字符：\$1 - = . \$1 : /。  
类型：字符串到字符串映射  
必需：是

## 响应语法
<a name="API_BKS_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 响应元素
<a name="API_BKS_TagResource_ResponseElements"></a>

如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。

## 错误
<a name="API_BKS_TagResource_Errors"></a>

有关所有操作的常见错误信息，请参阅 [常见错误类型](CommonErrors.md)。

 ** AccessDeniedException **   
您没有足够的访问权限，无法执行该操作。    
 ** message **   
用户没有足够的访问权限，无法执行该操作。
HTTP 状态代码：403

 ** InternalServerException **   
发生内部服务器错误。重试您的请求。    
 ** message **   
请求处理过程中发生意外错误。  
 ** retryAfterSeconds **   
等待指定秒数后重试此调用。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到此请求所需的资源。  
确认资源信息（例如 ARN 或类型）正确无误且存在，然后重试请求。    
 ** message **   
请求引用的资源不存在。  
 ** resourceId **   
受影响资源的假设性标识符。  
 ** resourceType **   
受影响资源的假设性类型。
HTTP 状态代码：404

 ** ThrottlingException **   
由于请求限制而导致请求被拒绝。    
 ** message **   
由于请求节流，请求失败。  
 ** quotaCode **   
这是具有限额的原始服务所独有的代码。  
 ** retryAfterSeconds **   
等待指定秒数后重试此调用。  
 ** serviceCode **   
这是原始服务所独有的代码。
HTTP 状态代码：429

 ** ValidationException **   
输入未能满足服务指定的约束条件。    
 ** message **   
输入未能满足 Amazon 服务指定的约束条件。
HTTP 状态代码：400

## 另请参阅
<a name="API_BKS_TagResource_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backupsearch-2018-05-10/TagResource) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/TagResource) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/TagResource) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/TagResource) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/TagResource) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/TagResource) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/TagResource) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/TagResource) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/TagResource) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/TagResource) 

# UntagResource
<a name="API_BKS_UntagResource"></a>

此操作可删除指定资源的标签。

## 请求语法
<a name="API_BKS_UntagResource_RequestSyntax"></a>

```
DELETE /tags/ResourceArn?tagKeys=TagKeys HTTP/1.1
```

## URI 请求参数
<a name="API_BKS_UntagResource_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [ResourceArn](#API_BKS_UntagResource_RequestSyntax) **   <a name="Backup-BKS_UntagResource-request-uri-ResourceArn"></a>
用于唯一标识您要删除标签的资源的 Amazon 资源名称（ARN）。  
是否必需：是

 ** [TagKeys](#API_BKS_UntagResource_RequestSyntax) **   <a name="Backup-BKS_UntagResource-request-uri-TagKeys"></a>
此必填参数包含您要从源中删除的标签键。  
是否必需：是

## 请求体
<a name="API_BKS_UntagResource_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<a name="API_BKS_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## 响应元素
<a name="API_BKS_UntagResource_ResponseElements"></a>

如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。

## 错误
<a name="API_BKS_UntagResource_Errors"></a>

有关所有操作的常见错误信息，请参阅 [常见错误类型](CommonErrors.md)。

 ** AccessDeniedException **   
您没有足够的访问权限，无法执行该操作。    
 ** message **   
用户没有足够的访问权限，无法执行该操作。
HTTP 状态代码：403

 ** InternalServerException **   
发生内部服务器错误。重试您的请求。    
 ** message **   
请求处理过程中发生意外错误。  
 ** retryAfterSeconds **   
等待指定秒数后重试此调用。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到此请求所需的资源。  
确认资源信息（例如 ARN 或类型）正确无误且存在，然后重试请求。    
 ** message **   
请求引用的资源不存在。  
 ** resourceId **   
受影响资源的假设性标识符。  
 ** resourceType **   
受影响资源的假设性类型。
HTTP 状态代码：404

 ** ThrottlingException **   
由于请求限制而导致请求被拒绝。    
 ** message **   
由于请求节流，请求失败。  
 ** quotaCode **   
这是具有限额的原始服务所独有的代码。  
 ** retryAfterSeconds **   
等待指定秒数后重试此调用。  
 ** serviceCode **   
这是原始服务所独有的代码。
HTTP 状态代码：429

 ** ValidationException **   
输入未能满足服务指定的约束条件。    
 ** message **   
输入未能满足 Amazon 服务指定的约束条件。
HTTP 状态代码：400

## 另请参阅
<a name="API_BKS_UntagResource_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backupsearch-2018-05-10/UntagResource) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/UntagResource) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/UntagResource) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/UntagResource) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/UntagResource) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/UntagResource) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/UntagResource) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/UntagResource) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/UntagResource) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/UntagResource) 

# 数据类型
<a name="API_Types"></a>

支持以下数据类型 AWS Backup：
+  [AdvancedBackupSetting](API_AdvancedBackupSetting.md) 
+  [AggregatedScanResult](API_AggregatedScanResult.md) 
+  [BackupJob](API_BackupJob.md) 
+  [BackupJobSummary](API_BackupJobSummary.md) 
+  [BackupPlan](API_BackupPlan.md) 
+  [BackupPlanInput](API_BackupPlanInput.md) 
+  [BackupPlansListMember](API_BackupPlansListMember.md) 
+  [BackupPlanTemplatesListMember](API_BackupPlanTemplatesListMember.md) 
+  [BackupRule](API_BackupRule.md) 
+  [BackupRuleInput](API_BackupRuleInput.md) 
+  [BackupSelection](API_BackupSelection.md) 
+  [BackupSelectionsListMember](API_BackupSelectionsListMember.md) 
+  [BackupVaultListMember](API_BackupVaultListMember.md) 
+  [CalculatedLifecycle](API_CalculatedLifecycle.md) 
+  [Condition](API_Condition.md) 
+  [ConditionParameter](API_ConditionParameter.md) 
+  [Conditions](API_Conditions.md) 
+  [ControlInputParameter](API_ControlInputParameter.md) 
+  [ControlScope](API_ControlScope.md) 
+  [CopyAction](API_CopyAction.md) 
+  [CopyJob](API_CopyJob.md) 
+  [CopyJobSummary](API_CopyJobSummary.md) 
+  [DateRange](API_DateRange.md) 
+  [Framework](API_Framework.md) 
+  [FrameworkControl](API_FrameworkControl.md) 
+  [IndexAction](API_IndexAction.md) 
+  [IndexedRecoveryPoint](API_IndexedRecoveryPoint.md) 
+  [KeyValue](API_KeyValue.md) 
+  [LatestMpaApprovalTeamUpdate](API_LatestMpaApprovalTeamUpdate.md) 
+  [LatestRevokeRequest](API_LatestRevokeRequest.md) 
+  [LegalHold](API_LegalHold.md) 
+  [Lifecycle](API_Lifecycle.md) 
+  [ProtectedResource](API_ProtectedResource.md) 
+  [ProtectedResourceConditions](API_ProtectedResourceConditions.md) 
+  [RecoveryPointByBackupVault](API_RecoveryPointByBackupVault.md) 
+  [RecoveryPointByResource](API_RecoveryPointByResource.md) 
+  [RecoveryPointCreator](API_RecoveryPointCreator.md) 
+  [RecoveryPointMember](API_RecoveryPointMember.md) 
+  [RecoveryPointSelection](API_RecoveryPointSelection.md) 
+  [ReportDeliveryChannel](API_ReportDeliveryChannel.md) 
+  [ReportDestination](API_ReportDestination.md) 
+  [ReportJob](API_ReportJob.md) 
+  [ReportPlan](API_ReportPlan.md) 
+  [ReportSetting](API_ReportSetting.md) 
+  [ResourceSelection](API_ResourceSelection.md) 
+  [RestoreAccessBackupVaultListMember](API_RestoreAccessBackupVaultListMember.md) 
+  [RestoreJobCreator](API_RestoreJobCreator.md) 
+  [RestoreJobsListMember](API_RestoreJobsListMember.md) 
+  [RestoreJobSummary](API_RestoreJobSummary.md) 
+  [RestoreTestingPlanForCreate](API_RestoreTestingPlanForCreate.md) 
+  [RestoreTestingPlanForGet](API_RestoreTestingPlanForGet.md) 
+  [RestoreTestingPlanForList](API_RestoreTestingPlanForList.md) 
+  [RestoreTestingPlanForUpdate](API_RestoreTestingPlanForUpdate.md) 
+  [RestoreTestingRecoveryPointSelection](API_RestoreTestingRecoveryPointSelection.md) 
+  [RestoreTestingSelectionForCreate](API_RestoreTestingSelectionForCreate.md) 
+  [RestoreTestingSelectionForGet](API_RestoreTestingSelectionForGet.md) 
+  [RestoreTestingSelectionForList](API_RestoreTestingSelectionForList.md) 
+  [RestoreTestingSelectionForUpdate](API_RestoreTestingSelectionForUpdate.md) 
+  [ScanAction](API_ScanAction.md) 
+  [ScanJob](API_ScanJob.md) 
+  [ScanJobCreator](API_ScanJobCreator.md) 
+  [ScanJobSummary](API_ScanJobSummary.md) 
+  [ScanResult](API_ScanResult.md) 
+  [ScanResultInfo](API_ScanResultInfo.md) 
+  [ScanSetting](API_ScanSetting.md) 
+  [ScheduledPlanExecutionMember](API_ScheduledPlanExecutionMember.md) 
+  [TieringConfiguration](API_TieringConfiguration.md) 
+  [TieringConfigurationInputForCreate](API_TieringConfigurationInputForCreate.md) 
+  [TieringConfigurationInputForUpdate](API_TieringConfigurationInputForUpdate.md) 
+  [TieringConfigurationsListMember](API_TieringConfigurationsListMember.md) 

支持以下数据类型 AWS Backup gateway：
+  [BandwidthRateLimitInterval](API_BGW_BandwidthRateLimitInterval.md) 
+  [Gateway](API_BGW_Gateway.md) 
+  [GatewayDetails](API_BGW_GatewayDetails.md) 
+  [Hypervisor](API_BGW_Hypervisor.md) 
+  [HypervisorDetails](API_BGW_HypervisorDetails.md) 
+  [MaintenanceStartTime](API_BGW_MaintenanceStartTime.md) 
+  [Tag](API_BGW_Tag.md) 
+  [VirtualMachine](API_BGW_VirtualMachine.md) 
+  [VirtualMachineDetails](API_BGW_VirtualMachineDetails.md) 
+  [VmwareTag](API_BGW_VmwareTag.md) 
+  [VmwareToAwsTagMapping](API_BGW_VmwareToAwsTagMapping.md) 

支持以下数据类型 AWS Backup 搜索：
+  [BackupCreationTimeFilter](API_BKS_BackupCreationTimeFilter.md) 
+  [CurrentSearchProgress](API_BKS_CurrentSearchProgress.md) 
+  [EBSItemFilter](API_BKS_EBSItemFilter.md) 
+  [EBSResultItem](API_BKS_EBSResultItem.md) 
+  [ExportJobSummary](API_BKS_ExportJobSummary.md) 
+  [ExportSpecification](API_BKS_ExportSpecification.md) 
+  [ItemFilters](API_BKS_ItemFilters.md) 
+  [LongCondition](API_BKS_LongCondition.md) 
+  [ResultItem](API_BKS_ResultItem.md) 
+  [S3ExportSpecification](API_BKS_S3ExportSpecification.md) 
+  [S3ItemFilter](API_BKS_S3ItemFilter.md) 
+  [S3ResultItem](API_BKS_S3ResultItem.md) 
+  [SearchJobBackupsResult](API_BKS_SearchJobBackupsResult.md) 
+  [SearchJobSummary](API_BKS_SearchJobSummary.md) 
+  [SearchScope](API_BKS_SearchScope.md) 
+  [SearchScopeSummary](API_BKS_SearchScopeSummary.md) 
+  [StringCondition](API_BKS_StringCondition.md) 
+  [TimeCondition](API_BKS_TimeCondition.md) 

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

支持以下数据类型 AWS Backup：
+  [AdvancedBackupSetting](API_AdvancedBackupSetting.md) 
+  [AggregatedScanResult](API_AggregatedScanResult.md) 
+  [BackupJob](API_BackupJob.md) 
+  [BackupJobSummary](API_BackupJobSummary.md) 
+  [BackupPlan](API_BackupPlan.md) 
+  [BackupPlanInput](API_BackupPlanInput.md) 
+  [BackupPlansListMember](API_BackupPlansListMember.md) 
+  [BackupPlanTemplatesListMember](API_BackupPlanTemplatesListMember.md) 
+  [BackupRule](API_BackupRule.md) 
+  [BackupRuleInput](API_BackupRuleInput.md) 
+  [BackupSelection](API_BackupSelection.md) 
+  [BackupSelectionsListMember](API_BackupSelectionsListMember.md) 
+  [BackupVaultListMember](API_BackupVaultListMember.md) 
+  [CalculatedLifecycle](API_CalculatedLifecycle.md) 
+  [Condition](API_Condition.md) 
+  [ConditionParameter](API_ConditionParameter.md) 
+  [Conditions](API_Conditions.md) 
+  [ControlInputParameter](API_ControlInputParameter.md) 
+  [ControlScope](API_ControlScope.md) 
+  [CopyAction](API_CopyAction.md) 
+  [CopyJob](API_CopyJob.md) 
+  [CopyJobSummary](API_CopyJobSummary.md) 
+  [DateRange](API_DateRange.md) 
+  [Framework](API_Framework.md) 
+  [FrameworkControl](API_FrameworkControl.md) 
+  [IndexAction](API_IndexAction.md) 
+  [IndexedRecoveryPoint](API_IndexedRecoveryPoint.md) 
+  [KeyValue](API_KeyValue.md) 
+  [LatestMpaApprovalTeamUpdate](API_LatestMpaApprovalTeamUpdate.md) 
+  [LatestRevokeRequest](API_LatestRevokeRequest.md) 
+  [LegalHold](API_LegalHold.md) 
+  [Lifecycle](API_Lifecycle.md) 
+  [ProtectedResource](API_ProtectedResource.md) 
+  [ProtectedResourceConditions](API_ProtectedResourceConditions.md) 
+  [RecoveryPointByBackupVault](API_RecoveryPointByBackupVault.md) 
+  [RecoveryPointByResource](API_RecoveryPointByResource.md) 
+  [RecoveryPointCreator](API_RecoveryPointCreator.md) 
+  [RecoveryPointMember](API_RecoveryPointMember.md) 
+  [RecoveryPointSelection](API_RecoveryPointSelection.md) 
+  [ReportDeliveryChannel](API_ReportDeliveryChannel.md) 
+  [ReportDestination](API_ReportDestination.md) 
+  [ReportJob](API_ReportJob.md) 
+  [ReportPlan](API_ReportPlan.md) 
+  [ReportSetting](API_ReportSetting.md) 
+  [ResourceSelection](API_ResourceSelection.md) 
+  [RestoreAccessBackupVaultListMember](API_RestoreAccessBackupVaultListMember.md) 
+  [RestoreJobCreator](API_RestoreJobCreator.md) 
+  [RestoreJobsListMember](API_RestoreJobsListMember.md) 
+  [RestoreJobSummary](API_RestoreJobSummary.md) 
+  [RestoreTestingPlanForCreate](API_RestoreTestingPlanForCreate.md) 
+  [RestoreTestingPlanForGet](API_RestoreTestingPlanForGet.md) 
+  [RestoreTestingPlanForList](API_RestoreTestingPlanForList.md) 
+  [RestoreTestingPlanForUpdate](API_RestoreTestingPlanForUpdate.md) 
+  [RestoreTestingRecoveryPointSelection](API_RestoreTestingRecoveryPointSelection.md) 
+  [RestoreTestingSelectionForCreate](API_RestoreTestingSelectionForCreate.md) 
+  [RestoreTestingSelectionForGet](API_RestoreTestingSelectionForGet.md) 
+  [RestoreTestingSelectionForList](API_RestoreTestingSelectionForList.md) 
+  [RestoreTestingSelectionForUpdate](API_RestoreTestingSelectionForUpdate.md) 
+  [ScanAction](API_ScanAction.md) 
+  [ScanJob](API_ScanJob.md) 
+  [ScanJobCreator](API_ScanJobCreator.md) 
+  [ScanJobSummary](API_ScanJobSummary.md) 
+  [ScanResult](API_ScanResult.md) 
+  [ScanResultInfo](API_ScanResultInfo.md) 
+  [ScanSetting](API_ScanSetting.md) 
+  [ScheduledPlanExecutionMember](API_ScheduledPlanExecutionMember.md) 
+  [TieringConfiguration](API_TieringConfiguration.md) 
+  [TieringConfigurationInputForCreate](API_TieringConfigurationInputForCreate.md) 
+  [TieringConfigurationInputForUpdate](API_TieringConfigurationInputForUpdate.md) 
+  [TieringConfigurationsListMember](API_TieringConfigurationsListMember.md) 

# AdvancedBackupSetting
<a name="API_AdvancedBackupSetting"></a>

每种资源类型的备份选项。

## 内容
<a name="API_AdvancedBackupSetting_Contents"></a>

 ** BackupOptions **   <a name="Backup-Type-AdvancedBackupSetting-BackupOptions"></a>
为所选资源指定备份选项。此选项仅适用于 Windows VSS 备份作业和 S3 备份。  
有效值：  
设置为 `"WindowsVSS":"enabled"` 可启用 `WindowsVSS` 备份选项并创建 Windows VSS 备份。  
设置为 `"WindowsVSS":"disabled"` 可创建常规备份。此 `WindowsVSS` 选项默认处于启用状态。  
对于 S3 备份，请设置为`"BackupACLs":"disabled"`以 ACLs 从备份中排除，或者`"BackupObjectTags":"disabled"`将对象标签从备份中排除。默认情况下， ACLs 和对象标签都包含在 S3 备份中。  
如果您指定的选项无效，则会出现 `InvalidParameterValueException` 异常。  
有关 Windows VSS 备份的更多信息，请参阅[创建启用 VSS 的 Windows 备份](https://docs.aws.amazon.com/aws-backup/latest/devguide/windows-backups.html)。  
类型：字符串到字符串映射  
键模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
值模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
必需：否

 ** ResourceType **   <a name="Backup-Type-AdvancedBackupSetting-ResourceType"></a>
指定包含资源类型和备份选项的对象。唯一支持的资源类型是带有 Windows 卷影复制服务 (VSS) 的 Amazon EC2 实例。有关 CloudFormation 示例，请参阅《* AWS Backup 用户指南*》中[启用 Windows VSS 的示例 CloudFormation 模板](https://docs.aws.amazon.com/aws-backup/latest/devguide/integrate-cloudformation-with-aws-backup.html)。  
有效值：`EC2`。  
类型：字符串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
必需：否

## 另请参阅
<a name="API_AdvancedBackupSetting_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/AdvancedBackupSetting) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/AdvancedBackupSetting) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/AdvancedBackupSetting) 

# AggregatedScanResult
<a name="API_AggregatedScanResult"></a>

包含多个扫描操作的聚合扫描结果，提供扫描状态和发现结果的摘要。

## 内容
<a name="API_AggregatedScanResult_Contents"></a>

 ** FailedScan **   <a name="Backup-Type-AggregatedScanResult-FailedScan"></a>
一个布尔值，表示是否有任何聚合扫描失败。  
类型：布尔值  
必需：否

 ** Findings **   <a name="Backup-Type-AggregatedScanResult-Findings"></a>
在所有聚合扫描中发现的一系列发现。  
类型：字符串数组  
有效值：`MALWARE`  
必需：否

 ** LastComputed **   <a name="Backup-Type-AggregatedScanResult-LastComputed"></a>
上次计算聚合扫描结果的时间戳，采用 Unix 格式和协调世界时 (UTC)。  
类型：时间戳  
必需：否

## 另请参阅
<a name="API_AggregatedScanResult_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/AggregatedScanResult) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/AggregatedScanResult) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/AggregatedScanResult) 

# BackupJob
<a name="API_BackupJob"></a>

包含有关备份作业的详细信息。

## 内容
<a name="API_BackupJob_Contents"></a>

 ** AccountId **   <a name="Backup-Type-BackupJob-AccountId"></a>
拥有备份作业的账户 ID。  
类型：字符串  
模式：`^[0-9]{12}$`  
必需：否

 ** BackupJobId **   <a name="Backup-Type-BackupJob-BackupJobId"></a>
唯一标识 AWS Backup 对的资源备份请求。  
类型：字符串  
必需：否

 ** BackupOptions **   <a name="Backup-Type-BackupJob-BackupOptions"></a>
为所选资源指定备份选项。此选项仅适用于 Windows 卷影复制服务 (VSS) 备份作业。  
有效值：设置为 `"WindowsVSS":"enabled"` 以启用 `WindowsVSS` 备份选项并创建 Windows VSS 备份。设置为 `"WindowsVSS":"disabled"` 可创建常规备份。如果您指定的选项无效，则会出现 `InvalidParameterValueException` 异常。  
类型：字符串到字符串映射  
键模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
值模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
必需：否

 ** BackupSizeInBytes **   <a name="Backup-Type-BackupJob-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 通过异步工作流程传递给，这可能意味着此显示的值可能低估了实际备份大小。
类型：长整型  
必需：否

 ** BackupType **   <a name="Backup-Type-BackupJob-BackupType"></a>
表示备份作业的备份类型。  
类型：字符串  
必需：否

 ** BackupVaultArn **   <a name="Backup-Type-BackupJob-BackupVaultArn"></a>
唯一标识备份保管库的 Amazon 资源名称 (ARN)；例如，`arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`。  
类型：字符串  
必需：否

 ** BackupVaultName **   <a name="Backup-Type-BackupJob-BackupVaultName"></a>
用于存储备份的逻辑容器的名称。备份保管库的名称在创建它们的账户和创建它们的 AWS 区域中是唯一的。  
类型：字符串  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必需：否

 ** BytesTransferred **   <a name="Backup-Type-BackupJob-BytesTransferred"></a>
查询作业状态时传输到备份保管库的大小（以字节为单位）。  
类型：长整型  
必需：否

 ** CompletionDate **   <a name="Backup-Type-BackupJob-CompletionDate"></a>
创建备份作业的作业完成的日期和时间，采用 Unix 格式和协调世界时 (UTC)。`CompletionDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** CreatedBy **   <a name="Backup-Type-BackupJob-CreatedBy"></a>
包含有关创建备份作业的标识信息，包括用于创建该作业的备份计划的 `BackupPlanArn`、`BackupPlanId`、`BackupPlanVersion` 和 `BackupRuleId`。  
类型：[RecoveryPointCreator](API_RecoveryPointCreator.md) 对象  
必需：否

 ** CreationDate **   <a name="Backup-Type-BackupJob-CreationDate"></a>
创建备份作业的日期和时间，采用 Unix 格式和协调世界时 (UTC)。`CreationDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** EncryptionKeyArn **   <a name="Backup-Type-BackupJob-EncryptionKeyArn"></a>
用于加密备份的 KMS 密钥的 Amazon 资源名称（ARN）。这可以是客户管理的密钥，也可以是 AWS 托管密钥，具体取决于保管库的配置。  
类型：字符串  
必需：否

 ** ExpectedCompletionDate **   <a name="Backup-Type-BackupJob-ExpectedCompletionDate"></a>
备份资源的作业预计完成的日期和时间，采用 Unix 格式和协调世界时 (UTC)。`ExpectedCompletionDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** IamRoleArn **   <a name="Backup-Type-BackupJob-IamRoleArn"></a>
指定用于创建目标恢复点的 IAM 角色 ARN。除默认角色之外的 IAM 角色必须在角色名称中包含 `AWSBackup` 或 `AwsBackup`。例如 `arn:aws:iam::123456789012:role/AWSBackupRDSAccess`。如果没有这些字符串，角色名称将缺少执行备份作业的权限。  
类型：字符串  
必需：否

 ** InitiationDate **   <a name="Backup-Type-BackupJob-InitiationDate"></a>
备份作业的启动日期。  
类型：时间戳  
必需：否

 ** IsEncrypted **   <a name="Backup-Type-BackupJob-IsEncrypted"></a>
指示是否对备份进行加密的布尔值。中的所有备份 AWS Backup 均已加密，但为了透明起见，此字段会显示加密状态。  
类型：布尔值  
必需：否

 ** IsParent **   <a name="Backup-Type-BackupJob-IsParent"></a>
这是一个布尔值，表示这是父（复合）备份作业。  
类型：布尔值  
必需：否

 ** MessageCategory **   <a name="Backup-Type-BackupJob-MessageCategory"></a>
此参数是指定消息类别的作业计数。  
例如，字符串可能包括 `AccessDenied`、`SUCCESS`、`AGGREGATE_ALL` 和 `INVALIDPARAMETERS`。有关 MessageCategory 字符串列表，请参阅[监控](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html)。  
值 ANY 返回所有消息类别的计数。  
 `AGGREGATE_ALL` 汇总所有消息类别的作业计数并返回总和。  
类型：字符串  
必需：否

 ** ParentJobId **   <a name="Backup-Type-BackupJob-ParentJobId"></a>
它唯一地标识向 AWS Backup 发出的备份资源请求。返回的将是父（复合）作业 ID。  
类型：字符串  
必需：否

 ** PercentDone **   <a name="Backup-Type-BackupJob-PercentDone"></a>
包含查询作业状态时作业完成的估计百分比。  
类型：字符串  
必需：否

 ** RecoveryPointArn **   <a name="Backup-Type-BackupJob-RecoveryPointArn"></a>
唯一标识恢复点的 ARN；例如，`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`。  
类型：字符串  
必需：否

 ** RecoveryPointLifecycle **   <a name="Backup-Type-BackupJob-RecoveryPointLifecycle"></a>
指定恢复点转换为冷存储或删除前经过的天数。  
过渡到冷存储的备份必须在冷库中存储至少 90 天。因此，在控制台上，“保留期”设置必须比“转换为冷态前经过的天数”设置多 90 天。在备份转换为冷态后，无法更改“转换为冷态前经过的天数”设置。  
按资源划分的[功能可用性表中列出了可以过渡到冷存储的资源](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource)类型。 AWS Backup 对于其他资源类型，将忽略此表达式。  
要删除现有的生命周期和保留期以便无限期保留恢复点，请为 `MoveToColdStorageAfterDays` 和 `DeleteAfterDays` 指定 -1。  
类型：[Lifecycle](API_Lifecycle.md) 对象  
必需：否

 ** ResourceArn **   <a name="Backup-Type-BackupJob-ResourceArn"></a>
唯一标识资源的 ARN。ARN 的格式取决于资源类型。  
类型：字符串  
必需：否

 ** ResourceName **   <a name="Backup-Type-BackupJob-ResourceName"></a>
属于指定备份的资源的非唯一名称。  
类型：字符串  
必需：否

 ** ResourceType **   <a name="Backup-Type-BackupJob-ResourceType"></a>
要备份的 AWS 资源类型；例如，亚马逊弹性区块存储 (Amazon EBS) Block Store 卷或亚马逊关系数据库服务 (Amazon RDS) 数据库。对于 Windows 卷影复制服务 (VSS) 备份，唯一支持的资源类型是亚马逊 EC2。  
类型：字符串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
必需：否

 ** StartBy **   <a name="Backup-Type-BackupJob-StartBy"></a>
采用 Unix 格式和协调世界时 (UTC)，指定备份作业必须在取消改作业之前多久启动。该值通过将启动时段与计划时间相加进行计算。因此，如果计划时间为下午 6:00，启动时段为 2 小时，则 `StartBy` 时间为指定日期的晚上 8:00。`StartBy` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** State **   <a name="Backup-Type-BackupJob-State"></a>
备份作业的当前状态。  
类型：字符串  
有效值：`CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL`  
必需：否

 ** StatusMessage **   <a name="Backup-Type-BackupJob-StatusMessage"></a>
一条详细消息，解释备份资源作业的状态。  
类型：字符串  
必需：否

 ** VaultLockState **   <a name="Backup-Type-BackupJob-VaultLockState"></a>
备份保管库的锁定状态。对于逻辑上受物理隔离的保管库，这表明该保管库是否被锁定在合规模式下。有效值包括 `LOCKED` 和 `UNLOCKED`。  
类型：字符串  
必需：否

 ** VaultType **   <a name="Backup-Type-BackupJob-VaultType"></a>
存储恢复点的备份保管库的类型。标准备份保管库的有效值为 `BACKUP_VAULT`，逻辑上受物理隔离的保管库的有效值为 `LOGICALLY_AIR_GAPPED_BACKUP_VAULT`。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_BackupJob_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupJob) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupJob) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/BackupJob) 

# BackupJobSummary
<a name="API_BackupJobSummary"></a>

此请求提供最近 30 天内创建的或正在运行的作业的摘要。

返回的摘要可能包含区域、账户、状态、资源类型、消息类别、开始时间、结束时间和所包含作业的计数。

## 目录
<a name="API_BackupJobSummary_Contents"></a>

 ** AccountId **   <a name="Backup-Type-BackupJobSummary-AccountId"></a>
拥有摘要中作业的账户 ID。  
类型：字符串  
模式：`^[0-9]{12}$`  
必需：否

 ** Count **   <a name="Backup-Type-BackupJobSummary-Count"></a>
该值以作业数量的形式显示在作业摘要中。  
类型：整数  
必需：否

 ** EndTime **   <a name="Backup-Type-BackupJobSummary-EndTime"></a>
以数字格式表示的作业结束时间值。  
该值是采用 Unix 格式表示的时间，它是世界标准时间 (UTC)，精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** MessageCategory **   <a name="Backup-Type-BackupJobSummary-MessageCategory"></a>
此参数是指定消息类别的作业计数。  
示例字符串包括 `AccessDenied`、`Success` 和 `InvalidParameters`。有关 MessageCategory 字符串的列表，请参阅[监控](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html)。  
值 ANY 返回所有消息类别的计数。  
 `AGGREGATE_ALL` 汇总所有消息类别的作业计数并返回总和。  
类型：字符串  
必需：否

 ** Region **   <a name="Backup-Type-BackupJobSummary-Region"></a>
作业摘要中的 AWS 区域。  
类型：字符串  
必需：否

 ** ResourceType **   <a name="Backup-Type-BackupJobSummary-ResourceType"></a>
此值是指定的资源类型的作业计数。请求 `GetSupportedResourceTypes` 返回支持的资源类型的字符串。  
类型：字符串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
必需：否

 ** StartTime **   <a name="Backup-Type-BackupJobSummary-StartTime"></a>
以数字格式表示的作业开始时间值。  
该值是采用 Unix 格式表示的时间，它是世界标准时间 (UTC)，精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** State **   <a name="Backup-Type-BackupJobSummary-State"></a>
此值是处于指定状态的作业的计数。  
类型：字符串  
有效值：`CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL | AGGREGATE_ALL | ANY`  
必需：否

## 另请参阅
<a name="API_BackupJobSummary_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupJobSummary) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupJobSummary) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/BackupJobSummary) 

# BackupPlan
<a name="API_BackupPlan"></a>

包含可选的备份计划显示名称和 `BackupRule` 对象数组，每个对象均指定一个备份规则。备份计划中的每个规则都是一个单独的计划任务，可以备份不同的 AWS 资源选择。

## 内容
<a name="API_BackupPlan_Contents"></a>

 ** BackupPlanName **   <a name="Backup-Type-BackupPlan-BackupPlanName"></a>
备份计划的显示名称。必须仅包含字母数字或“-\$1.” 特殊字符。  
如果是在控制台中进行设置，则可以包含 1 到 50 个字符；如果是通过 CLI 或 API 进行设置，则可以包含 1 到 200 个字符。  
类型：字符串  
是否必需：是

 ** Rules **   <a name="Backup-Type-BackupPlan-Rules"></a>
`BackupRule` 对象的数组，其中每个对象指定用于备份所选资源的计划的任务。  
类型：[BackupRule](API_BackupRule.md) 对象数组  
是否必需：是

 ** AdvancedBackupSettings **   <a name="Backup-Type-BackupPlan-AdvancedBackupSettings"></a>
包含每种资源的 `BackupOptions` 列表。  
类型：[AdvancedBackupSetting](API_AdvancedBackupSetting.md) 对象数组  
必需：否

 ** ScanSettings **   <a name="Backup-Type-BackupPlan-ScanSettings"></a>
包含备份计划的扫描配置，包括恶意软件扫描程序、所选资源和扫描器角色。  
类型：[ScanSetting](API_ScanSetting.md) 对象数组  
必需：否

## 另请参阅
<a name="API_BackupPlan_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupPlan) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupPlan) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/BackupPlan) 

# BackupPlanInput
<a name="API_BackupPlanInput"></a>

包含可选的备份计划显示名称和 `BackupRule` 对象数组，每个对象均指定一个备份规则。备份计划中的每个规则都是一个单独的计划任务。

## 内容
<a name="API_BackupPlanInput_Contents"></a>

 ** BackupPlanName **   <a name="Backup-Type-BackupPlanInput-BackupPlanName"></a>
备份计划的显示名称。必须包含 1 到 50 个字母数字或“-\$1.” 字符。  
类型：字符串  
是否必需：是

 ** Rules **   <a name="Backup-Type-BackupPlanInput-Rules"></a>
`BackupRule` 对象的数组，其中每个对象指定用于备份所选资源的计划的任务。  
类型：[BackupRuleInput](API_BackupRuleInput.md) 对象数组  
是否必需：是

 ** AdvancedBackupSettings **   <a name="Backup-Type-BackupPlanInput-AdvancedBackupSettings"></a>
指定每种资源类型的 `BackupOptions` 列表。这些设置仅适用于 Windows 卷影复制服务 (VSS) 备份作业。  
类型：[AdvancedBackupSetting](API_AdvancedBackupSetting.md) 对象数组  
必需：否

 ** ScanSettings **   <a name="Backup-Type-BackupPlanInput-ScanSettings"></a>
包含备份规则的扫描配置，包括恶意软件扫描程序以及完整或增量扫描模式。  
类型：[ScanSetting](API_ScanSetting.md) 对象数组  
必需：否

## 另请参阅
<a name="API_BackupPlanInput_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupPlanInput) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupPlanInput) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/BackupPlanInput) 

# BackupPlansListMember
<a name="API_BackupPlansListMember"></a>

包含备份计划相关的元数据。

## 目录
<a name="API_BackupPlansListMember_Contents"></a>

 ** AdvancedBackupSettings **   <a name="Backup-Type-BackupPlansListMember-AdvancedBackupSettings"></a>
包含资源类型的 `BackupOptions` 列表。  
类型：[AdvancedBackupSetting](API_AdvancedBackupSetting.md) 对象数组  
必需：否

 ** BackupPlanArn **   <a name="Backup-Type-BackupPlansListMember-BackupPlanArn"></a>
唯一标识备份计划的 Amazon 资源名称 (ARN)；例如，`arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50`。  
类型：字符串  
必需：否

 ** BackupPlanId **   <a name="Backup-Type-BackupPlansListMember-BackupPlanId"></a>
唯一标识备份计划。  
类型：字符串  
必需：否

 ** BackupPlanName **   <a name="Backup-Type-BackupPlansListMember-BackupPlanName"></a>
所保存的备份计划的显示名称。  
类型：字符串  
必需：否

 ** CreationDate **   <a name="Backup-Type-BackupPlansListMember-CreationDate"></a>
资源备份计划的创建日期和时间，采用 Unix 格式和协调世界时 (UTC)。`CreationDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** CreatorRequestId **   <a name="Backup-Type-BackupPlansListMember-CreatorRequestId"></a>
唯一字符串，用于标识请求并允许重试失败的请求，同时避免发生两次运行操作的风险。此参数为可选的。  
如果使用，则此参数必须包含 1 到 50 个字母数字或“-\$1.” 字符。  
类型：字符串  
必需：否

 ** DeletionDate **   <a name="Backup-Type-BackupPlansListMember-DeletionDate"></a>
备份计划的删除日期和时间，采用 Unix 格式和协调世界时 (UTC)。`DeletionDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** LastExecutionDate **   <a name="Backup-Type-BackupPlansListMember-LastExecutionDate"></a>
上次运行此备份计划的时间。日期和时间，采用 Unix 格式和协调世界时 (UTC)。`LastExecutionDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** VersionId **   <a name="Backup-Type-BackupPlansListMember-VersionId"></a>
唯一的、随机生成的、Unicode、UTF-8 编码字符串，长度最大为 1024 个字节。无法编辑版本 ID。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_BackupPlansListMember_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupPlansListMember) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupPlansListMember) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/BackupPlansListMember) 

# BackupPlanTemplatesListMember
<a name="API_BackupPlanTemplatesListMember"></a>

指定与备份计划模板关联的元数据的对象。

## 目录
<a name="API_BackupPlanTemplatesListMember_Contents"></a>

 ** BackupPlanTemplateId **   <a name="Backup-Type-BackupPlanTemplatesListMember-BackupPlanTemplateId"></a>
唯一标识存储的备份计划模板。  
类型：字符串  
必需：否

 ** BackupPlanTemplateName **   <a name="Backup-Type-BackupPlanTemplatesListMember-BackupPlanTemplateName"></a>
备份计划模板的可选显示名称。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_BackupPlanTemplatesListMember_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupPlanTemplatesListMember) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupPlanTemplatesListMember) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/BackupPlanTemplatesListMember) 

# BackupRule
<a name="API_BackupRule"></a>

指定用于备份所选资源的安排任务。

## 内容
<a name="API_BackupRule_Contents"></a>

 ** RuleName **   <a name="Backup-Type-BackupRule-RuleName"></a>
备份规则的显示名称。必须包含 1 到 50 个字母数字或“-\$1.” 字符。  
类型：字符串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
是否必需：是

 ** TargetBackupVaultName **   <a name="Backup-Type-BackupRule-TargetBackupVaultName"></a>
用于存储备份的逻辑容器的名称。备份保管库的名称在创建它们的账户和创建它们的 AWS 区域中是唯一的。  
类型：字符串  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
是否必需：是

 ** CompletionWindowMinutes **   <a name="Backup-Type-BackupRule-CompletionWindowMinutes"></a>
一个时间值（以分钟为单位），用于指定备份作业在成功启动之后必须在多长时间内完成，否则将会被 AWS Backup取消。该值为可选项。  
类型：长整型  
必需：否

 ** CopyActions **   <a name="Backup-Type-BackupRule-CopyActions"></a>
`CopyAction` 对象的数组，其中包含复制操作的详细信息。  
类型：[CopyAction](API_CopyAction.md) 对象数组  
必需：否

 ** EnableContinuousBackup **   <a name="Backup-Type-BackupRule-EnableContinuousBackup"></a>
指定是否 AWS Backup 创建连续备份。创建 AWS Backup 能够 point-in-time恢复的连续备份 (PITR) 的真实原因。False（或未指定）会 AWS Backup 导致创建快照备份。  
类型：布尔值  
必需：否

 ** IndexActions **   <a name="Backup-Type-BackupRule-IndexActions"></a>
IndexActions 是一个数组，用于指定应如何为备份数据编制索引。  
每个备份 BackupRule 可以有 0 或 1 IndexAction，因为每个备份最多可以有一个与之关联的索引。  
数组中是 ResourceType。每种只能接受一个 BackupRule。  
类型：[IndexAction](API_IndexAction.md) 对象数组  
必需：否

 ** Lifecycle **   <a name="Backup-Type-BackupRule-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) 对象  
必需：否

 ** RecoveryPointTags **   <a name="Backup-Type-BackupRule-RecoveryPointTags"></a>
从备份还原时分配给与此规则关联的资源的标签。  
类型：字符串到字符串映射  
必需：否

 ** RuleId **   <a name="Backup-Type-BackupRule-RuleId"></a>
唯一标识用于安排所选资源备份的规则。  
类型：字符串  
必需：否

 ** ScanActions **   <a name="Backup-Type-BackupRule-ScanActions"></a>
包含备份规则的扫描配置，包括恶意软件扫描程序以及完整或增量扫描模式。  
类型：[ScanAction](API_ScanAction.md) 对象数组  
必需：否

 ** ScheduleExpression **   <a name="Backup-Type-BackupRule-ScheduleExpression"></a>
UTC 格式的 cron 表达式，用于指定何时 AWS Backup 启动备份作业。当未提供 CRON 表达式时， AWS Backup 将使用默认表达式`cron(0 5 ? * * *)`。  
有关 AWS cron 表达式的更多信息，请参阅 *Amazon Ev CloudWatch ents 用户指南*[中的规则计划表达式](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html)。  
 AWS cron 表达式的两个示例是` 15 * ? * * *`（每小时在过去 15 分钟时进行一次备份）和`0 12 * * ? *`（UTC 每天中午 12 点进行备份）。  
要查看示例表，请单击前面的链接并向下滚动页面。  
类型：字符串  
必需：否

 ** ScheduleExpressionTimezone **   <a name="Backup-Type-BackupRule-ScheduleExpressionTimezone"></a>
设置计划表达式所在的时区。默认情况下，以 UTC ScheduleExpressions 为单位。您可以将其修改为指定的时区。  
类型：字符串  
必需：否

 ** StartWindowMinutes **   <a name="Backup-Type-BackupRule-StartWindowMinutes"></a>
一个时间值（以分钟为单位），用于指定在安排了备份之后，必须在多长时间内成功启动作业，否则将会被取消。该值为可选项。如果包含此值，则必须至少为 60 分钟才能避免错误。  
在启动时段内，备份作业的状态将保持 `CREATED` 状态，直到成功启动或启动时段结束为止。如果在启动窗口内 AWS Backup 收到允许重试作业的错误消息， AWS Backup 则至少每 10 分钟自动重试一次以开始作业，直到备份成功开始（任务状态更改为`RUNNING`）或任务状态更改为`EXPIRED`（预计在启动窗口时间结束时发生）。  
类型：长整型  
必需：否

 ** TargetLogicallyAirGappedBackupVaultArn **   <a name="Backup-Type-BackupRule-TargetLogicallyAirGappedBackupVaultArn"></a>
逻辑上存在气隙的保管库的 ARN。ARN 必须位于同一个账户和区域中。如果提供，则支持的完全托管资源将直接备份到逻辑上空隙的保管库，而其他支持的资源则在备份保管库中创建临时（可计费）快照，然后将其复制到逻辑上空隙的保管库中。不支持的资源只能备份到指定的备份存储库。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_BackupRule_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupRule) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupRule) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/BackupRule) 

# BackupRuleInput
<a name="API_BackupRuleInput"></a>

指定用于备份所选资源的安排任务。

## 内容
<a name="API_BackupRuleInput_Contents"></a>

 ** RuleName **   <a name="Backup-Type-BackupRuleInput-RuleName"></a>
备份规则的显示名称。必须包含 1 到 50 个字母数字或“-\$1.” 字符。  
类型：字符串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
是否必需：是

 ** TargetBackupVaultName **   <a name="Backup-Type-BackupRuleInput-TargetBackupVaultName"></a>
用于存储备份的逻辑容器的名称。备份保管库的名称在创建它们的账户和创建它们的 AWS 区域中是唯一的。  
类型：字符串  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
是否必需：是

 ** CompletionWindowMinutes **   <a name="Backup-Type-BackupRuleInput-CompletionWindowMinutes"></a>
一个时间值（以分钟为单位），用于指定备份作业在成功启动之后必须在多长时间内完成，否则将会被 AWS Backup取消。该值为可选项。  
类型：长整型  
必需：否

 ** CopyActions **   <a name="Backup-Type-BackupRuleInput-CopyActions"></a>
`CopyAction` 对象的数组，其中包含复制操作的详细信息。  
类型：[CopyAction](API_CopyAction.md) 对象数组  
必需：否

 ** EnableContinuousBackup **   <a name="Backup-Type-BackupRuleInput-EnableContinuousBackup"></a>
指定是否 AWS Backup 创建连续备份。创建 AWS Backup 能够 point-in-time恢复的连续备份 (PITR) 的真实原因。False（或未指定）会 AWS Backup 导致创建快照备份。  
类型：布尔值  
必需：否

 ** IndexActions **   <a name="Backup-Type-BackupRuleInput-IndexActions"></a>
每个备份 IndexAction 中最多可以有一个 BackupRule，因为每个备份可以有 0 或 1 个与之关联的备份索引。  
数组中是 ResourceTypes。每种资源类型只能接受 1 种 BackupRule。有效值：  
+  `EBS`：表示 Amazon Elastic Block Store
+  `S3`：表示 Amazon Simple Storage Service（Amazon S3）
类型：[IndexAction](API_IndexAction.md) 对象数组  
必需：否

 ** Lifecycle **   <a name="Backup-Type-BackupRuleInput-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) 对象  
必需：否

 ** RecoveryPointTags **   <a name="Backup-Type-BackupRuleInput-RecoveryPointTags"></a>
分配给资源的标签。  
类型：字符串到字符串映射  
必需：否

 ** ScanActions **   <a name="Backup-Type-BackupRuleInput-ScanActions"></a>
包含备份规则的扫描配置，包括恶意软件扫描程序以及完整或增量扫描模式。  
类型：[ScanAction](API_ScanAction.md) 对象数组  
必需：否

 ** ScheduleExpression **   <a name="Backup-Type-BackupRuleInput-ScheduleExpression"></a>
UTC 格式的 CRON 表达式，用于指定何时 AWS Backup 启动备份作业。当未提供 CRON 表达式时， AWS Backup 将使用默认表达式`cron(0 5 ? * * *)`。  
类型：字符串  
必需：否

 ** ScheduleExpressionTimezone **   <a name="Backup-Type-BackupRuleInput-ScheduleExpressionTimezone"></a>
设置计划表达式所在的时区。默认情况下，以 UTC ScheduleExpressions 为单位。您可以将其修改为指定的时区。  
类型：字符串  
必需：否

 ** StartWindowMinutes **   <a name="Backup-Type-BackupRuleInput-StartWindowMinutes"></a>
一个时间值（以分钟为单位），用于指定在安排了备份之后，必须在多长时间内成功启动作业，否则将会被取消。该值为可选项。如果包含此值，则必须至少为 60 分钟才能避免错误。  
此参数的最大值为 100 年（52,560,000 分钟）。  
在启动时段内，备份作业的状态将保持 `CREATED` 状态，直到成功启动或启动时段结束为止。如果在启动窗口内 AWS Backup 收到允许重试作业的错误消息， AWS Backup 则至少每 10 分钟自动重试一次以开始作业，直到备份成功开始（任务状态更改为`RUNNING`）或任务状态更改为`EXPIRED`（预计在启动窗口时间结束时发生）。  
类型：长整型  
必需：否

 ** TargetLogicallyAirGappedBackupVaultArn **   <a name="Backup-Type-BackupRuleInput-TargetLogicallyAirGappedBackupVaultArn"></a>
逻辑上存在气隙的保管库的 ARN。ARN 必须位于同一个账户和区域中。如果提供，则支持的完全托管资源将直接备份到逻辑上空隙的保管库，而其他支持的资源则在备份保管库中创建临时（可计费）快照，然后将其复制到逻辑上空隙的保管库中。不支持的资源只能备份到指定的备份存储库。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_BackupRuleInput_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupRuleInput) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupRuleInput) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/BackupRuleInput) 

# BackupSelection
<a name="API_BackupSelection"></a>

用于为备份计划指定一组资源。

建议您指定要包含或排除的条件、标签或资源。否则，Backup 将尝试选择所有支持和选择加入的存储资源，这可能会产生意想不到的成本影响。

有关更多信息，请参阅[以编程方式分配资源](https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-json)。

## 内容
<a name="API_BackupSelection_Contents"></a>

 ** IamRoleArn **   <a name="Backup-Type-BackupSelection-IamRoleArn"></a>
备份目标资源时 AWS Backup 用于进行身份验证的 IAM 角色的 ARN；例如，。`arn:aws:iam::123456789012:role/S3Access`  
类型：字符串  
是否必需：是

 ** SelectionName **   <a name="Backup-Type-BackupSelection-SelectionName"></a>
资源选择文档的显示名称。必须包含 1 到 50 个字母数字或“-\$1.” 字符。  
类型：字符串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
是否必需：是

 ** Conditions **   <a name="Backup-Type-BackupSelection-Conditions"></a>
您定义的使用标签将资源分配给备份计划的条件。例如 `"StringEquals": { "ConditionKey": "aws:ResourceTag/backup", "ConditionValue": "daily" }`。  
 `Conditions` 支持 `StringEquals`、`StringLike`、`StringNotEquals` 和 `StringNotLike`。条件运算符区分大小写。  
如果指定多个条件，则资源必须匹配所有条件（AND 逻辑）。  
类型：[Conditions](API_Conditions.md) 对象  
必需：否

 ** ListOfTags **   <a name="Backup-Type-BackupSelection-ListOfTags"></a>
建议您使用 `Conditions` 参数，而不是此参数。  
您定义的使用标签将资源分配给备份计划的条件。例如 `"StringEquals": { "ConditionKey": "backup", "ConditionValue": "daily"}`。  
 `ListOfTags` 仅支持 `StringEquals`。条件运算符区分大小写。  
如果指定多个条件，则资源必须匹配任一条件（OR 逻辑）。  
类型：[Condition](API_Condition.md) 对象数组  
必需：否

 ** NotResources **   <a name="Backup-Type-BackupSelection-NotResources"></a>
要从备份计划中排除的资源的 Amazon 资源名称 (ARNs)。不带通配符的最大数量 ARNs 为 500， ARNs 带通配符的最大数量为 30。  
如果需要从备份计划中排除许多资源，请考虑使用不同的资源选择策略，例如仅分配一种或几种资源类型或使用标签细化资源选择。  
类型：字符串数组  
必需：否

 ** Resources **   <a name="Backup-Type-BackupSelection-Resources"></a>
要分配给备份计划的资源的 Amazon 资源名称 (ARNs)。不带通配符的最大数量 ARNs 为 500， ARNs 带通配符的最大数量为 30。  
如果需要为备份计划分配许多资源，请考虑使用不同的资源选择策略，例如分配一种资源类型的所有资源或使用标签细化资源选择。  
如果指定多个 ARNs，则资源与任何 ARNs （OR 逻辑）都非常匹配。  
在 ARN 模式中使用通配符进行备份选择时，星号 (\$1) 必须出现在 ARN 字符串（前缀模式）的末尾。例如，`arn:aws:s3:::my-bucket-*`有效，但`arn:aws:s3:::*-logs`不支持。
类型：字符串数组  
必需：否

## 另请参阅
<a name="API_BackupSelection_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupSelection) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupSelection) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/BackupSelection) 

# BackupSelectionsListMember
<a name="API_BackupSelectionsListMember"></a>

包含有关 `BackupSelection` 对象的元数据。

## 目录
<a name="API_BackupSelectionsListMember_Contents"></a>

 ** BackupPlanId **   <a name="Backup-Type-BackupSelectionsListMember-BackupPlanId"></a>
唯一标识备份计划。  
类型：字符串  
必需：否

 ** CreationDate **   <a name="Backup-Type-BackupSelectionsListMember-CreationDate"></a>
创建备份计划的日期和时间，采用 Unix 格式和协调世界时 (UTC)。`CreationDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** CreatorRequestId **   <a name="Backup-Type-BackupSelectionsListMember-CreatorRequestId"></a>
唯一字符串，用于标识请求并允许重试失败的请求，同时避免发生两次运行操作的风险。此参数为可选的。  
如果使用，则此参数必须包含 1 到 50 个字母数字或“-\$1.” 字符。  
类型：字符串  
必需：否

 ** IamRoleArn **   <a name="Backup-Type-BackupSelectionsListMember-IamRoleArn"></a>
指定用于创建目标恢复点的 IAM 角色 Amazon 资源名称 (ARN)；例如，`arn:aws:iam::123456789012:role/S3Access`。  
类型：字符串  
必需：否

 ** SelectionId **   <a name="Backup-Type-BackupSelectionsListMember-SelectionId"></a>
唯一标识将一组资源分配给备份计划的请求。  
类型：字符串  
必需：否

 ** SelectionName **   <a name="Backup-Type-BackupSelectionsListMember-SelectionName"></a>
资源选择文档的显示名称。  
类型：字符串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
必需：否

## 另请参阅
<a name="API_BackupSelectionsListMember_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupSelectionsListMember) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupSelectionsListMember) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/BackupSelectionsListMember) 

# BackupVaultListMember
<a name="API_BackupVaultListMember"></a>

包含备份保管库相关的元数据。

## 内容
<a name="API_BackupVaultListMember_Contents"></a>

 ** BackupVaultArn **   <a name="Backup-Type-BackupVaultListMember-BackupVaultArn"></a>
唯一标识备份保管库的 Amazon 资源名称 (ARN)；例如，`arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`。  
类型：字符串  
必需：否

 ** BackupVaultName **   <a name="Backup-Type-BackupVaultListMember-BackupVaultName"></a>
用于存储备份的逻辑容器的名称。备份保管库的名称在创建它们的账户和创建它们的 AWS 区域中是唯一的。  
类型：字符串  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必需：否

 ** CreationDate **   <a name="Backup-Type-BackupVaultListMember-CreationDate"></a>
资源备份的创建日期和时间，采用 Unix 格式和协调世界时 (UTC)。`CreationDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** CreatorRequestId **   <a name="Backup-Type-BackupVaultListMember-CreatorRequestId"></a>
唯一字符串，用于标识请求并允许重试失败的请求，同时避免发生两次运行操作的风险。此参数为可选的。  
如果使用，则此参数必须包含 1 到 50 个字母数字或“-\$1.” 字符。  
类型：字符串  
必需：否

 ** EncryptionKeyArn **   <a name="Backup-Type-BackupVaultListMember-EncryptionKeyArn"></a>
您可以指定的服务器端加密密钥，用于加密来自支持完全 AWS Backup 管理的服务的备份；例如。`arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`如果指定密钥，则必须指定其 ARN，而不是其别名。如果未指定密钥， AWS Backup 默认会为您创建一个 KMS 密钥。  
要了解哪些 AWS Backup 服务支持完全 AWS Backup 管理以及如何 AWS Backup 处理来自尚不支持完全管理的服务的备份的[加密 AWS Backup，请参阅中的备份](https://docs.aws.amazon.com/aws-backup/latest/devguide/encryption.html)加密 AWS Backup  
类型：字符串  
必需：否

 ** EncryptionKeyType **   <a name="Backup-Type-BackupVaultListMember-EncryptionKeyType"></a>
用于备份保管库的加密密钥类型。对于客户管理的密钥，有效值为 CUSTOMER\$1MANAGED\$1KMS\$1KEY，对于客户管理的密钥，有效值为 \$1OWNED\$1KMS\$1KEY。 AWS AWS  
类型：字符串  
有效值：`AWS_OWNED_KMS_KEY | CUSTOMER_MANAGED_KMS_KEY`  
必需：否

 ** LockDate **   <a name="Backup-Type-BackupVaultListMember-LockDate"></a>
 AWS Backup 文件库锁定配置变为不可变的日期和时间，这意味着无法更改或删除。  
如果您在未指定锁定日期的情况下对保管库应用了保管库锁定，则可以随时更改保管库锁定设置，或从保管库中完全删除保管库锁定。  
该值采用 Unix 格式和协调世界时 (UTC)，精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** Locked **   <a name="Backup-Type-BackupVaultListMember-Locked"></a>
一个布尔值，用于指示 AWS Backup 文件库锁定是否适用于选定的备份存储库。如果值为 `true`，则保管库锁定会阻止对选定保管库中的恢复点执行删除和更新操作。  
类型：布尔值  
必需：否

 ** MaxRetentionDays **   <a name="Backup-Type-BackupVaultListMember-MaxRetentionDays"></a>
 AWS Backup 文件库锁定设置，用于指定文件库保留其恢复点的最大保留期。如果不指定此参数，则保管库锁定不会对保管库中的恢复点强制规定最长保留期（允许无限期存储）。  
如果指定了此参数，则备份或复制到保管库的任何作业都必须具有生命周期策略，其保留期等于或小于最长保留期。如果作业的保留期长于该最长保留期，则保管库将无法执行该备份或复制作业，因此您应该修改生命周期设置或使用其他保管库。保管库锁定之前已存储在保管库中的恢复点不受影响。  
类型：长整型  
必需：否

 ** MinRetentionDays **   <a name="Backup-Type-BackupVaultListMember-MinRetentionDays"></a>
 AWS Backup 文件库锁定设置，用于指定文件库保留其恢复点的最短保留期。如果未指定此参数，则保管库锁定不会强制规定最短保留期。  
如果指定了此参数，则备份或复制到保管库的任何作业都必须具有生命周期策略，其保留期等于或大于最短保留期。如果作业的保留期短于该最短保留期，则保管库将无法执行该备份或复制作业，因此，您应该修改生命周期设置或使用其他保管库。保管库锁定之前已存储在保管库中的恢复点不受影响。  
类型：长整型  
必需：否

 ** NumberOfRecoveryPoints **   <a name="Backup-Type-BackupVaultListMember-NumberOfRecoveryPoints"></a>
存储在备份保管库中的恢复点数量。控制台中显示的恢复点计数值可能是近似值。  
类型：长整型  
必需：否

 ** VaultState **   <a name="Backup-Type-BackupVaultListMember-VaultState"></a>
保管库的当前状态。  
类型：字符串  
有效值：`CREATING | AVAILABLE | FAILED`  
必需：否

 ** VaultType **   <a name="Backup-Type-BackupVaultListMember-VaultType"></a>
用于存储所述恢复点的保管库类型。  
类型：字符串  
有效值：`BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT | RESTORE_ACCESS_BACKUP_VAULT`  
必需：否

## 另请参阅
<a name="API_BackupVaultListMember_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupVaultListMember) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupVaultListMember) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/BackupVaultListMember) 

# CalculatedLifecycle
<a name="API_CalculatedLifecycle"></a>

包含 `DeleteAt` 和 `MoveToColdStorageAt` 时间戳，用于指定恢复点的生命周期。

生命周期定义受保护的资源何时转换到冷存储以及何时过期。AWS Backup 将根据您定义的生命周期自动转换备份和使备份过期。

转换到冷存储的备份必须在冷存储中存储至少 90 天。因此，“保留期”设置必须比“转换为冷态前经过的天数”设置多 90 天。在备份转换为冷态后，无法更改“转换为冷态前经过的天数”设置。

可以转换为冷存储的资源类型在[按资源划分的特征可用性](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource)表中列出。对于其他资源类型，AWS Backup 会忽略此表达式。

## 目录
<a name="API_CalculatedLifecycle_Contents"></a>

 ** DeleteAt **   <a name="Backup-Type-CalculatedLifecycle-DeleteAt"></a>
一个时间戳，用于指定何时删除恢复点。  
类型：时间戳  
必需：否

 ** MoveToColdStorageAt **   <a name="Backup-Type-CalculatedLifecycle-MoveToColdStorageAt"></a>
一个时间戳，用于指定何时将恢复点转换到冷存储。  
类型：时间戳  
必需：否

## 另请参阅
<a name="API_CalculatedLifecycle_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CalculatedLifecycle) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CalculatedLifecycle) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CalculatedLifecycle) 

# Condition
<a name="API_Condition"></a>

包含一个三元组数组，该数组由条件类型（如 `StringEquals`）、键和值组成。用于使用资源标签筛选这些资源并将其分配给备份计划。区分大小写。

## 目录
<a name="API_Condition_Contents"></a>

 ** ConditionKey **   <a name="Backup-Type-Condition-ConditionKey"></a>
键/值对中的键。例如，在标签 `Department: Accounting` 中，`Department` 是键。  
类型：字符串  
必需：是

 ** ConditionType **   <a name="Backup-Type-Condition-ConditionType"></a>
一项操作，应用到用于为备份计划分配资源的键/值对。条件仅支持 `StringEquals`。要获得更灵活的分配选项，包括 `StringLike` 以及从备份计划中排除资源的功能，请针对您的 [https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BackupSelection.html](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BackupSelection.html) 使用 `Conditions`（末尾带有 “s”）。  
类型：字符串  
有效值：`STRINGEQUALS`  
必需：是

 ** ConditionValue **   <a name="Backup-Type-Condition-ConditionValue"></a>
键/值对中的值。例如，在标签 `Department: Accounting` 中，`Accounting` 是值。  
类型：字符串  
必需：是

## 另请参阅
<a name="API_Condition_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/Condition) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/Condition) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/Condition) 

# ConditionParameter
<a name="API_ConditionParameter"></a>

包括有关由您定义的用于将标记的资源分配给备份计划的标签的信息。

在标签中包括前缀 `aws:ResourceTag`。例如 `"aws:ResourceTag/TagKey1": "Value1"`。

## 目录
<a name="API_ConditionParameter_Contents"></a>

 ** ConditionKey **   <a name="Backup-Type-ConditionParameter-ConditionKey"></a>
键/值对中的键。例如，在标签 `Department: Accounting` 中，`Department` 是键。  
类型：字符串  
必需：否

 ** ConditionValue **   <a name="Backup-Type-ConditionParameter-ConditionValue"></a>
键/值对中的值。例如，在标签 `Department: Accounting` 中，`Accounting` 是值。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_ConditionParameter_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ConditionParameter) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ConditionParameter) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ConditionParameter) 

# Conditions
<a name="API_Conditions"></a>

包含有关使用资源标签从备份计划中包含或排除哪些资源的信息。条件区分大小写。

## 目录
<a name="API_Conditions_Contents"></a>

 ** StringEquals **   <a name="Backup-Type-Conditions-StringEquals"></a>
仅针对您使用相同值进行标记的资源筛选已标记资源的值。也称为“精确匹配”。  
类型：[ConditionParameter](API_ConditionParameter.md) 对象数组  
必需：否

 ** StringLike **   <a name="Backup-Type-Conditions-StringLike"></a>
通过在字符串中的任何位置使用通配符 (\$1)，针对匹配的标签值筛选已标记资源的值。例如，“prod\$1”或“\$1rod\$1”与标签值“production”相匹配。  
类型：[ConditionParameter](API_ConditionParameter.md) 对象数组  
必需：否

 ** StringNotEquals **   <a name="Backup-Type-Conditions-StringNotEquals"></a>
仅针对您标记的不具有相同值的资源筛选已标记资源的值。也称为“否定匹配”。  
类型：[ConditionParameter](API_ConditionParameter.md) 对象数组  
必需：否

 ** StringNotLike **   <a name="Backup-Type-Conditions-StringNotLike"></a>
通过在字符串中的任何位置使用通配符 (\$1)，针对非匹配的标签值筛选已标记资源的值。  
类型：[ConditionParameter](API_ConditionParameter.md) 对象数组  
必需：否

## 另请参阅
<a name="API_Conditions_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/Conditions) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/Conditions) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/Conditions) 

# ControlInputParameter
<a name="API_ControlInputParameter"></a>

控件的参数。一个控件可以有零个、一个或多个参数。具有两个参数的控件的示例是：“备份计划频率至少为 `daily` 并且保留期至少为 `1 year`”。第一个参数是 `daily`。第二个参数是 `1 year`。

## 目录
<a name="API_ControlInputParameter_Contents"></a>

 ** ParameterName **   <a name="Backup-Type-ControlInputParameter-ParameterName"></a>
参数的名称，例如 `BackupPlanFrequency`。  
类型：字符串  
必需：否

 ** ParameterValue **   <a name="Backup-Type-ControlInputParameter-ParameterValue"></a>
参数的值，例如 `hourly`。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_ControlInputParameter_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ControlInputParameter) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ControlInputParameter) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ControlInputParameter) 

# ControlScope
<a name="API_ControlScope"></a>

框架由一个或多个控件组成。每个控件都有各自的控制范围。控制范围可以包含一种或多种资源类型、标签键值组合、一种资源类型和一个资源 ID 的组合。如果没有指定范围，当记录组中的任何资源更改配置时，将触发对规则的评估。

**注意**  
要设置包含所有特定资源的控制范围，请在调用 `CreateFramework` 时将 `ControlScope` 留空或不传递。

## 目录
<a name="API_ControlScope_Contents"></a>

 ** ComplianceResourceIds **   <a name="Backup-Type-ControlScope-ComplianceResourceIds"></a>
要控制范围包含的唯一 AWS 资源的 ID。  
类型：字符串数组  
数组成员：最少 1 个项目。最多 100 个项目。  
必需：否

 ** ComplianceResourceTypes **   <a name="Backup-Type-ControlScope-ComplianceResourceTypes"></a>
描述控制范围是否包括一种或多种类型的资源，例如 `EFS` 或 `RDS`。  
类型：字符串数组  
必需：否

 ** Tags **   <a name="Backup-Type-ControlScope-Tags"></a>
该标签键值对仅适用于要让其触发规则评估的 AWS 资源。最多可以提供一个键值对。标签值是可选的，但如果您要从控制台创建或编辑框架，则该值不能为空字符串（尽管包含在 CloudFormation 模板中时，该值可以是空字符串）。  
分配给标签的结构是：`[{"Key":"string","Value":"string"}]`。  
类型：字符串到字符串映射  
必需：否

## 另请参阅
<a name="API_ControlScope_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ControlScope) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ControlScope) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ControlScope) 

# CopyAction
<a name="API_CopyAction"></a>

复制操作的详细信息。

## 目录
<a name="API_CopyAction_Contents"></a>

 ** DestinationBackupVaultArn **   <a name="Backup-Type-CopyAction-DestinationBackupVaultArn"></a>
唯一标识复制备份的目的地备份保管库的 Amazon 资源名称 (ARN)。例如 `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`。  
类型：字符串  
必需：是

 ** Lifecycle **   <a name="Backup-Type-CopyAction-Lifecycle"></a>
指定恢复点转换为冷存储或删除前经过的天数。  
转换到冷存储的备份必须在冷存储中存储至少 90 天。因此，在控制台上，“保留期”设置必须比“转换为冷态前经过的天数”设置多 90 天。在备份转换为冷态后，无法更改“转换为冷态前经过的天数”设置。  
可以转换为冷存储的资源类型在[按资源划分的特征可用性](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource)表中列出。对于其他资源类型，AWS Backup 会忽略此表达式。  
要删除现有的生命周期和保留期以便无限期保留恢复点，请为 `MoveToColdStorageAfterDays` 和 `DeleteAfterDays` 指定 -1。  
类型：[Lifecycle](API_Lifecycle.md) 对象  
必需：否

## 另请参阅
<a name="API_CopyAction_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CopyAction) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CopyAction) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CopyAction) 

# CopyJob
<a name="API_CopyJob"></a>

包含有关复制作业的详细信息。

## 内容
<a name="API_CopyJob_Contents"></a>

 ** AccountId **   <a name="Backup-Type-CopyJob-AccountId"></a>
拥有复制作业的账户 ID。  
类型：字符串  
模式：`^[0-9]{12}$`  
必需：否

 ** BackupSizeInBytes **   <a name="Backup-Type-CopyJob-BackupSizeInBytes"></a>
复制作业大小（以字节为单位）。  
类型：长整型  
必需：否

 ** ChildJobsInState **   <a name="Backup-Type-CopyJob-ChildJobsInState"></a>
这将返回包含的子（嵌套）复印作业的统计信息。  
类型：字符串到长整型映射  
有效密钥：`CREATED | RUNNING | COMPLETED | FAILED | PARTIAL`  
必需：否

 ** CompletionDate **   <a name="Backup-Type-CopyJob-CompletionDate"></a>
复印作业的完成日期和时间，采用 Unix 格式和世界协调时 (UTC)。`CompletionDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** CompositeMemberIdentifier **   <a name="Backup-Type-CopyJob-CompositeMemberIdentifier"></a>
复合组中资源的标识符，例如属于复合（父）堆栈的嵌套（子）恢复点。ID 是从堆栈内的[逻辑 ID](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax) 中传输的。  
类型：字符串  
必需：否

 ** CopyJobId **   <a name="Backup-Type-CopyJob-CopyJobId"></a>
唯一标识复制作业。  
类型：字符串  
必需：否

 ** CreatedBy **   <a name="Backup-Type-CopyJob-CreatedBy"></a>
包含有关 AWS Backup 用于启动恢复点备份的备份计划和规则的信息。  
类型：[RecoveryPointCreator](API_RecoveryPointCreator.md) 对象  
必需：否

 ** CreatedByBackupJobId **   <a name="Backup-Type-CopyJob-CreatedByBackupJobId"></a>
启动此复印任务的备份作业 ID。仅适用于定时复印任务和自动复制到逻辑空隙存储库的任务。  
类型：字符串  
必需：否

 ** CreationDate **   <a name="Backup-Type-CopyJob-CreationDate"></a>
复制作业的创建日期和时间，采用 Unix 时间格式和协调世界时 (UTC)。`CreationDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** DestinationBackupVaultArn **   <a name="Backup-Type-CopyJob-DestinationBackupVaultArn"></a>
唯一标识目的地复制保管库的 Amazon 资源名称 (ARN)；例如，`arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`。  
类型：字符串  
必需：否

 ** DestinationEncryptionKeyArn **   <a name="Backup-Type-CopyJob-DestinationEncryptionKeyArn"></a>
用于加密目标保管库中复制的备份的 KMS 密钥的 Amazon 资源名称（ARN）。这可以是客户管理的密钥或托 AWS 管的密钥。  
类型：字符串  
必需：否

 ** DestinationRecoveryPointArn **   <a name="Backup-Type-CopyJob-DestinationRecoveryPointArn"></a>
唯一标识目的地恢复点的 ARN；例如，`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`。  
类型：字符串  
必需：否

 ** DestinationRecoveryPointLifecycle **   <a name="Backup-Type-CopyJob-DestinationRecoveryPointLifecycle"></a>
指定恢复点转换为冷存储或删除前经过的天数。  
过渡到冷存储的备份必须在冷库中存储至少 90 天。因此，在控制台上，“保留期”设置必须比“转换为冷态前经过的天数”设置多 90 天。在备份转换为冷态后，无法更改“转换为冷态前经过的天数”设置。  
按资源划分的[功能可用性表中列出了可以过渡到冷存储的资源](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource)类型。 AWS Backup 对于其他资源类型，将忽略此表达式。  
要删除现有的生命周期和保留期以便无限期保留恢复点，请为 `MoveToColdStorageAfterDays` 和 `DeleteAfterDays` 指定 -1。  
类型：[Lifecycle](API_Lifecycle.md) 对象  
必需：否

 ** DestinationVaultLockState **   <a name="Backup-Type-CopyJob-DestinationVaultLockState"></a>
目标备份保管库的锁定状态。对于逻辑上受物理隔离的保管库，它表示此保管库是否在合规模式下被锁定。有效值包括 `LOCKED` 和 `UNLOCKED`。  
类型：字符串  
必需：否

 ** DestinationVaultType **   <a name="Backup-Type-CopyJob-DestinationVaultType"></a>
存储复制的恢复点的目标备份保管库的类型。标准备份保管库的有效值为 `BACKUP_VAULT`，逻辑上受物理隔离的保管库的有效值为 `LOGICALLY_AIR_GAPPED_BACKUP_VAULT`。  
类型：字符串  
必需：否

 ** IamRoleArn **   <a name="Backup-Type-CopyJob-IamRoleArn"></a>
指定用于复制目标恢复点的 IAM 角色 ARN；例如，`arn:aws:iam::123456789012:role/S3Access`。  
类型：字符串  
必需：否

 ** IsParent **   <a name="Backup-Type-CopyJob-IsParent"></a>
这是一个布尔值，表示这是父（复合）复制作业。  
类型：布尔值  
必需：否

 ** MessageCategory **   <a name="Backup-Type-CopyJob-MessageCategory"></a>
此参数是指定消息类别的作业计数。  
例如，字符串可能包括 `AccessDenied`、`SUCCESS`、`AGGREGATE_ALL` 和 `InvalidParameters`。有关 MessageCategory 字符串列表，请参阅[监控](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html)。  
值 ANY 返回所有消息类别的计数。  
 `AGGREGATE_ALL` 汇总所有消息类别的作业计数并返回总和  
类型：字符串  
必需：否

 ** NumberOfChildJobs **   <a name="Backup-Type-CopyJob-NumberOfChildJobs"></a>
子（嵌套）复制作业的数量。  
类型：长整型  
必需：否

 ** ParentJobId **   <a name="Backup-Type-CopyJob-ParentJobId"></a>
它唯一标识向 AWS Backup 发出的复制资源请求。返回的将是父（复合）作业 ID。  
类型：字符串  
必需：否

 ** ResourceArn **   <a name="Backup-Type-CopyJob-ResourceArn"></a>
要复制的 AWS 资源；例如，亚马逊弹性区块存储 (Amazon EBS) Block Store 卷或亚马逊关系数据库服务 (Amazon RDS) 数据库。  
类型：字符串  
必需：否

 ** ResourceName **   <a name="Backup-Type-CopyJob-ResourceName"></a>
属于指定备份的资源的非唯一名称。  
类型：字符串  
必需：否

 ** ResourceType **   <a name="Backup-Type-CopyJob-ResourceType"></a>
要复制的 AWS 资源类型；例如，亚马逊弹性区块存储 (Amazon EBS) Block Store 卷或亚马逊关系数据库服务 (Amazon RDS) 数据库。  
类型：字符串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
必需：否

 ** SourceBackupVaultArn **   <a name="Backup-Type-CopyJob-SourceBackupVaultArn"></a>
唯一标识源复制保管库的 Amazon 资源名称 (ARN)；例如，`arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`。  
类型：字符串  
必需：否

 ** SourceRecoveryPointArn **   <a name="Backup-Type-CopyJob-SourceRecoveryPointArn"></a>
唯一标识源恢复点的 ARN；例如，`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`。  
类型：字符串  
必需：否

 ** State **   <a name="Backup-Type-CopyJob-State"></a>
复制作业的当前状态。  
类型：字符串  
有效值：`CREATED | RUNNING | COMPLETED | FAILED | PARTIAL`  
必需：否

 ** StatusMessage **   <a name="Backup-Type-CopyJob-StatusMessage"></a>
一条详细消息，说明复制资源作业的状态。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_CopyJob_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CopyJob) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CopyJob) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CopyJob) 

# CopyJobSummary
<a name="API_CopyJobSummary"></a>

此请求提供最近 30 天内创建的或正在运行的复制作业的摘要。

返回的摘要可能包含区域、账户、状态、资源类型、消息类别、开始时间、结束时间和所包含作业的计数。

## 目录
<a name="API_CopyJobSummary_Contents"></a>

 ** AccountId **   <a name="Backup-Type-CopyJobSummary-AccountId"></a>
拥有摘要中作业的账户 ID。  
类型：字符串  
模式：`^[0-9]{12}$`  
必需：否

 ** Count **   <a name="Backup-Type-CopyJobSummary-Count"></a>
该值以作业数量的形式显示在作业摘要中。  
类型：整数  
必需：否

 ** EndTime **   <a name="Backup-Type-CopyJobSummary-EndTime"></a>
以数字格式表示的作业结束时间值。  
该值是采用 Unix 格式表示的时间，它是世界标准时间 (UTC)，精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** MessageCategory **   <a name="Backup-Type-CopyJobSummary-MessageCategory"></a>
此参数是指定消息类别的作业计数。  
示例字符串包括 `AccessDenied`、`Success` 和 `InvalidParameters`。有关 MessageCategory 字符串的列表，请参阅[监控](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html)。  
值 ANY 返回所有消息类别的计数。  
 `AGGREGATE_ALL` 汇总所有消息类别的作业计数并返回总和。  
类型：字符串  
必需：否

 ** Region **   <a name="Backup-Type-CopyJobSummary-Region"></a>
作业摘要中的 AWS 区域。  
类型：字符串  
必需：否

 ** ResourceType **   <a name="Backup-Type-CopyJobSummary-ResourceType"></a>
此值是指定的资源类型的作业计数。请求 `GetSupportedResourceTypes` 返回支持的资源类型的字符串。  
类型：字符串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
必需：否

 ** StartTime **   <a name="Backup-Type-CopyJobSummary-StartTime"></a>
以数字格式表示的作业开始时间值。  
该值是采用 Unix 格式表示的时间，它是世界标准时间 (UTC)，精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** State **   <a name="Backup-Type-CopyJobSummary-State"></a>
此值是处于指定状态的作业的计数。  
类型：字符串  
有效值：`CREATED | RUNNING | ABORTING | ABORTED | COMPLETING | COMPLETED | FAILING | FAILED | PARTIAL | AGGREGATE_ALL | ANY`  
必需：否

## 另请参阅
<a name="API_CopyJobSummary_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CopyJobSummary) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CopyJobSummary) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CopyJobSummary) 

# DateRange
<a name="API_DateRange"></a>

这是一个资源筛选器，包含 FromDate: DateTime 和 ToDate: DateTime。两个值都是必填项。不允许使用将来 DateTime 值。

日期和时间采用 Unix 格式和协调世界时 (UTC)，精确到毫秒（毫秒是可选项）。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。

## 目录
<a name="API_DateRange_Contents"></a>

 ** FromDate **   <a name="Backup-Type-DateRange-FromDate"></a>
此值为起始日期（含在内）。  
日期和时间采用 Unix 格式和协调世界时 (UTC)，精确到毫秒（毫秒是可选项）。  
类型：时间戳  
必需：是

 ** ToDate **   <a name="Backup-Type-DateRange-ToDate"></a>
此值是结束日期（含在内）。  
日期和时间采用 Unix 格式和协调世界时 (UTC)，精确到毫秒（毫秒是可选项）。  
类型：时间戳  
必需：是

## 另请参阅
<a name="API_DateRange_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DateRange) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DateRange) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DateRange) 

# Framework
<a name="API_Framework"></a>

包含有关框架的详细信息。框架包含控件，用于评估和报告您的备份事件和资源。框架每天都会生成合规结果。

## 目录
<a name="API_Framework_Contents"></a>

 ** CreationTime **   <a name="Backup-Type-Framework-CreationTime"></a>
框架的创建日期和时间，以 ISO 8601 表示。`CreationTime` 的值精确到毫秒。例如，2020-07-10T15:00:00.000-08:00 表示 2020 年 7 月 10 日下午 3:00，比 UTC 晚 8 个小时。  
类型：时间戳  
必需：否

 ** DeploymentStatus **   <a name="Backup-Type-Framework-DeploymentStatus"></a>
框架的部署状态。状态包括：  
 `CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED`   
类型：字符串  
必需：否

 ** FrameworkArn **   <a name="Backup-Type-Framework-FrameworkArn"></a>
唯一标识资源的 Amazon 资源名称 (ARN)。ARN 的格式取决于资源类型。  
类型：字符串  
必需：否

 ** FrameworkDescription **   <a name="Backup-Type-Framework-FrameworkDescription"></a>
框架的可选描述，最多 1024 个字符。  
类型：字符串  
长度约束：最小长度为 0。最大长度为 1024。  
模式：`.*\S.*`  
必需：否

 ** FrameworkName **   <a name="Backup-Type-Framework-FrameworkName"></a>
框架的唯一名称。此名称的长度介于 1 到 256 个字符之间，以字母开头，由字母（a-z、A-Z）、数字 (0-9) 和下划线 (\$1) 组成。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 256。  
模式：`[a-zA-Z][_a-zA-Z0-9]*`  
必需：否

 ** NumberOfControls **   <a name="Backup-Type-Framework-NumberOfControls"></a>
框架包含的控件数量。  
类型：整数  
必需：否

## 另请参阅
<a name="API_Framework_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/Framework) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/Framework) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/Framework) 

# FrameworkControl
<a name="API_FrameworkControl"></a>

包含有关框架的所有控件的详细信息。每个框架必须至少包含一个控件。

## 目录
<a name="API_FrameworkControl_Contents"></a>

 ** ControlName **   <a name="Backup-Type-FrameworkControl-ControlName"></a>
控件的名称。此名称介于 1 到 256 个字符之间。  
类型：字符串  
必需：是

 ** ControlInputParameters **   <a name="Backup-Type-FrameworkControl-ControlInputParameters"></a>
名称/值对。  
类型：[ControlInputParameter](API_ControlInputParameter.md) 对象数组  
必需：否

 ** ControlScope **   <a name="Backup-Type-FrameworkControl-ControlScope"></a>
控件的范围。控件范围定义控件将评估的内容。控制范围的三个示例为：特定备份计划、具有特定标签的所有备份计划或所有备份计划。  
有关更多信息，请参阅 [`ControlScope`。](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ControlScope.html)  
类型：[ControlScope](API_ControlScope.md) 对象  
必需：否

## 另请参阅
<a name="API_FrameworkControl_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/FrameworkControl) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/FrameworkControl) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/FrameworkControl) 

# IndexAction
<a name="API_IndexAction"></a>

这是 BackupRule 中的一个可选数组。

IndexAction 由一个 ResourceTypes 组成。

## 目录
<a name="API_IndexAction_Contents"></a>

 ** ResourceTypes **   <a name="Backup-Type-IndexAction-ResourceTypes"></a>
每个 BackupRule 将接受 0 或 1 个索引操作。  
有效值：  
+  `EBS`：表示 Amazon Elastic Block Store
+  `S3`：表示 Amazon Simple Storage Service（Amazon S3）
类型：字符串数组  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
必需：否

## 另请参阅
<a name="API_IndexAction_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/IndexAction) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/IndexAction) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/IndexAction) 

# IndexedRecoveryPoint
<a name="API_IndexedRecoveryPoint"></a>

这是一个具有关联备份索引的恢复点。

只有带备份索引的恢复点才会包含在搜索中。

## 目录
<a name="API_IndexedRecoveryPoint_Contents"></a>

 ** BackupCreationDate **   <a name="Backup-Type-IndexedRecoveryPoint-BackupCreationDate"></a>
备份的创建日期和时间，采用 Unix 时间格式和协调世界时（UTC）。`CreationDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** BackupVaultArn **   <a name="Backup-Type-IndexedRecoveryPoint-BackupVaultArn"></a>
唯一标识存储恢复点索引的备份保管库的 ARN。  
例如 `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`。  
类型：字符串  
必需：否

 ** IamRoleArn **   <a name="Backup-Type-IndexedRecoveryPoint-IamRoleArn"></a>
该值指定用于此操作的 IAM 角色 ARN。  
示例：arn:aws:iam::123456789012:role/S3Access  
类型：字符串  
必需：否

 ** IndexCreationDate **   <a name="Backup-Type-IndexedRecoveryPoint-IndexCreationDate"></a>
备份索引的创建日期和时间，采用 Unix 时间格式和协调世界时（UTC）。`CreationDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** IndexStatus **   <a name="Backup-Type-IndexedRecoveryPoint-IndexStatus"></a>
这是与指定恢复点关联的备份索引的当前状态。  
状态为：`PENDING` \$1 `ACTIVE` \$1 `FAILED` \$1 `DELETING`   
关联有状态为 `ACTIVE` 的索引的恢复点可以包含在搜索中。  
类型：字符串  
有效值：`PENDING | ACTIVE | FAILED | DELETING`  
必需：否

 ** IndexStatusMessage **   <a name="Backup-Type-IndexedRecoveryPoint-IndexStatusMessage"></a>
一个以详细消息形式呈现的字符串，说明与恢复点关联的备份索引的状态。  
类型：字符串  
必需：否

 ** RecoveryPointArn **   <a name="Backup-Type-IndexedRecoveryPoint-RecoveryPointArn"></a>
唯一标识恢复点的 ARN；例如，`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`  
类型：字符串  
必需：否

 ** ResourceType **   <a name="Backup-Type-IndexedRecoveryPoint-ResourceType"></a>
已编制索引的恢复点的资源类型。  
+  `EBS`：表示 Amazon Elastic Block Store
+  `S3`：表示 Amazon Simple Storage Service（Amazon S3）
类型：字符串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
必需：否

 ** SourceResourceArn **   <a name="Backup-Type-IndexedRecoveryPoint-SourceResourceArn"></a>
一个 Amazon 资源名称（ARN）字符串，用于唯一标识源资源。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_IndexedRecoveryPoint_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/IndexedRecoveryPoint) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/IndexedRecoveryPoint) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/IndexedRecoveryPoint) 

# KeyValue
<a name="API_KeyValue"></a>

由两个相关字符串组成的对。允许的字符包括字母、空格、可采用 UTF-8 格式表示的数字以及下列字符：` + - = . _ : /`。

## 目录
<a name="API_KeyValue_Contents"></a>

 ** Key **   <a name="Backup-Type-KeyValue-Key"></a>
标签键（字符串）。键不能以 `aws:` 开头。  
长度限制：长度下限为 1。最大长度为 128。  
模式：`^(?![aA]{1}[wW]{1}[sS]{1}:)([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$`  
类型：字符串  
必需：是

 ** Value **   <a name="Backup-Type-KeyValue-Value"></a>
键的值。  
长度约束：最大长度为 256。  
模式：`^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
类型：字符串  
必需：是

## 另请参阅
<a name="API_KeyValue_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/KeyValue) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/KeyValue) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/KeyValue) 

# LatestMpaApprovalTeamUpdate
<a name="API_LatestMpaApprovalTeamUpdate"></a>

包含 MPA 审批团队关联信息的最新更新信息。

## 目录
<a name="API_LatestMpaApprovalTeamUpdate_Contents"></a>

 ** ExpiryDate **   <a name="Backup-Type-LatestMpaApprovalTeamUpdate-ExpiryDate"></a>
MPA 审批团队更新到期的日期和时间。  
类型：时间戳  
必需：否

 ** InitiationDate **   <a name="Backup-Type-LatestMpaApprovalTeamUpdate-InitiationDate"></a>
MPA 审批团队更新启动的日期和时间。  
类型：时间戳  
必需：否

 ** MpaSessionArn **   <a name="Backup-Type-LatestMpaApprovalTeamUpdate-MpaSessionArn"></a>
与此更新相关联的 MPA 会话的 ARN。  
类型：字符串  
必需：否

 ** Status **   <a name="Backup-Type-LatestMpaApprovalTeamUpdate-Status"></a>
MPA 审批团队更新的当前状态。  
类型：字符串  
有效值：`PENDING | APPROVED | FAILED`  
必需：否

 ** StatusMessage **   <a name="Backup-Type-LatestMpaApprovalTeamUpdate-StatusMessage"></a>
描述 MPA 审批团队更新的当前状态的消息。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_LatestMpaApprovalTeamUpdate_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/LatestMpaApprovalTeamUpdate) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/LatestMpaApprovalTeamUpdate) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/LatestMpaApprovalTeamUpdate) 

# LatestRevokeRequest
<a name="API_LatestRevokeRequest"></a>

包含有关撤消对此备份保管库的访问权限的最新请求的信息。

## 目录
<a name="API_LatestRevokeRequest_Contents"></a>

 ** ExpiryDate **   <a name="Backup-Type-LatestRevokeRequest-ExpiryDate"></a>
撤消请求到期的日期和时间。  
类型：时间戳  
必需：否

 ** InitiationDate **   <a name="Backup-Type-LatestRevokeRequest-InitiationDate"></a>
撤消请求发起的日期和时间。  
类型：时间戳  
必需：否

 ** MpaSessionArn **   <a name="Backup-Type-LatestRevokeRequest-MpaSessionArn"></a>
与此撤消请求相关联的 MPA 会话的 ARN。  
类型：字符串  
必需：否

 ** Status **   <a name="Backup-Type-LatestRevokeRequest-Status"></a>
撤消请求的当前状态。  
类型：字符串  
有效值：`PENDING | FAILED`  
必需：否

 ** StatusMessage **   <a name="Backup-Type-LatestRevokeRequest-StatusMessage"></a>
描述撤消请求的当前状态的消息。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_LatestRevokeRequest_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/LatestRevokeRequest) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/LatestRevokeRequest) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/LatestRevokeRequest) 

# LegalHold
<a name="API_LegalHold"></a>

法定保留是一种管理工具，可帮助防止备份在保留状态下被删除。设置保留后，将无法删除处于保留状态的备份，并且会更改备份状态（例如转换为冷存储状态）的生命周期策略会延迟到法定保留被删除为止。备份可以包含多个法定保留。法定保留适用于一个或多个备份（也称为恢复点）。可以按资源类型和资源 ID 筛选这些备份。

## 目录
<a name="API_LegalHold_Contents"></a>

 ** CancellationDate **   <a name="Backup-Type-LegalHold-CancellationDate"></a>
法定保留的取消时间。  
类型：时间戳  
必需：否

 ** CreationDate **   <a name="Backup-Type-LegalHold-CreationDate"></a>
法定保留的创建时间。  
类型：时间戳  
必需：否

 ** Description **   <a name="Backup-Type-LegalHold-Description"></a>
法定保留的描述。  
类型：字符串  
必需：否

 ** LegalHoldArn **   <a name="Backup-Type-LegalHold-LegalHoldArn"></a>
法定保留的 Amazon 资源名称（ARN）；例如 `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`。  
类型：字符串  
必需：否

 ** LegalHoldId **   <a name="Backup-Type-LegalHold-LegalHoldId"></a>
法定保留的 ID。  
类型：字符串  
必需：否

 ** Status **   <a name="Backup-Type-LegalHold-Status"></a>
法定保留的状态。  
类型：字符串  
有效值：`CREATING | ACTIVE | CANCELING | CANCELED`  
必需：否

 ** Title **   <a name="Backup-Type-LegalHold-Title"></a>
法定保留的标题。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_LegalHold_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/LegalHold) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/LegalHold) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/LegalHold) 

# Lifecycle
<a name="API_Lifecycle"></a>

指定恢复点转换为冷存储或删除前经过的天数。

过渡到冷存储的备份必须在冷库中存储至少 90 天。因此，在控制台上，“保留期”设置必须比“转换为冷态前经过的天数”设置多 90 天。在备份转换为冷态后，无法更改“转换为冷态前经过的天数”设置。

按资源划分的[功能可用性表中列出了可以过渡到冷存储的资源](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource)类型。 AWS Backup 对于其他资源类型，将忽略此表达式。

要删除现有的生命周期和保留期以便无限期保留恢复点，请为 `MoveToColdStorageAfterDays` 和 `DeleteAfterDays` 指定 -1。

## 内容
<a name="API_Lifecycle_Contents"></a>

 ** DeleteAfterDays **   <a name="Backup-Type-Lifecycle-DeleteAfterDays"></a>
恢复点从创建到被删除所经过的天数。此值必须是 `MoveToColdStorageAfterDays` 中指定的天数后至少 90 天。  
类型：长整型  
必需：否

 ** DeleteAfterEvent **   <a name="Backup-Type-Lifecycle-DeleteAfterEvent"></a>
之后删除恢复点的事件。同时包含`DeleteAfterDays`和的恢复点`DeleteAfterEvent`将在先满足任一条件后删除。作为输入无效。  
类型：字符串  
有效值：`DELETE_AFTER_COPY`  
必需：否

 ** MoveToColdStorageAfterDays **   <a name="Backup-Type-Lifecycle-MoveToColdStorageAfterDays"></a>
恢复点从创建到移至冷存储所经过的天数。  
类型：长整型  
必需：否

 ** OptInToArchiveForSupportedResources **   <a name="Backup-Type-Lifecycle-OptInToArchiveForSupportedResources"></a>
如果该值为 True，您的备份计划将根据生命周期设置，将支持的资源转移到归档（冷）存储层。  
类型：布尔值  
必需：否

## 另请参阅
<a name="API_Lifecycle_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/Lifecycle) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/Lifecycle) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/Lifecycle) 

# ProtectedResource
<a name="API_ProtectedResource"></a>

一种包含有关备份资源信息的结构。

## 目录
<a name="API_ProtectedResource_Contents"></a>

 ** LastBackupTime **   <a name="Backup-Type-ProtectedResource-LastBackupTime"></a>
资源的上次备份日期和时间，采用 Unix 格式和协调世界时 (UTC)。`LastBackupTime` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** LastBackupVaultArn **   <a name="Backup-Type-ProtectedResource-LastBackupVaultArn"></a>
包含最新备份恢复点的备份保管库的 ARN（Amazon 资源名称）。  
类型：字符串  
必需：否

 ** LastRecoveryPointArn **   <a name="Backup-Type-ProtectedResource-LastRecoveryPointArn"></a>
最新恢复点的 ARN（Amazon 资源名称）。  
类型：字符串  
必需：否

 ** ResourceArn **   <a name="Backup-Type-ProtectedResource-ResourceArn"></a>
唯一标识资源的 Amazon 资源名称 (ARN)。ARN 的格式取决于资源类型。  
类型：字符串  
必需：否

 ** ResourceName **   <a name="Backup-Type-ProtectedResource-ResourceName"></a>
属于指定备份的资源的非唯一名称。  
类型：字符串  
必需：否

 ** ResourceType **   <a name="Backup-Type-ProtectedResource-ResourceType"></a>
AWS 资源类型；例如 Amazon Elastic Block Store (Amazon EBS) 卷或 Amazon Relational Database Service (Amazon RDS) 数据库。对于 Windows 卷影复制服务 (VSS) 备份，唯一支持的资源类型是 Amazon EC2。  
类型：字符串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
必需：否

## 另请参阅
<a name="API_ProtectedResource_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ProtectedResource) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ProtectedResource) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ProtectedResource) 

# ProtectedResourceConditions
<a name="API_ProtectedResourceConditions"></a>

您使用标签为还原测试计划中的资源定义的条件。

## 目录
<a name="API_ProtectedResourceConditions_Contents"></a>

 ** StringEquals **   <a name="Backup-Type-ProtectedResourceConditions-StringEquals"></a>
仅针对您使用相同值进行标记的资源筛选已标记资源的值。也称为“精确匹配”。  
类型：[KeyValue](API_KeyValue.md) 对象数组  
必需：否

 ** StringNotEquals **   <a name="Backup-Type-ProtectedResourceConditions-StringNotEquals"></a>
仅针对您标记的不具有相同值的资源筛选已标记资源的值。也称为“否定匹配”。  
类型：[KeyValue](API_KeyValue.md) 对象数组  
必需：否

## 另请参阅
<a name="API_ProtectedResourceConditions_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ProtectedResourceConditions) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ProtectedResourceConditions) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ProtectedResourceConditions) 

# RecoveryPointByBackupVault
<a name="API_RecoveryPointByBackupVault"></a>

包含有关存储在备份保管库中的恢复点的详细信息。

## 内容
<a name="API_RecoveryPointByBackupVault_Contents"></a>

 ** AggregatedScanResult **   <a name="Backup-Type-RecoveryPointByBackupVault-AggregatedScanResult"></a>
包含针对恢复点的最新扫描结果，当前包括`FailedScan`、`Findings`、`LastComputed`。  
类型：[AggregatedScanResult](API_AggregatedScanResult.md) 对象  
必需：否

 ** BackupSizeInBytes **   <a name="Backup-Type-RecoveryPointByBackupVault-BackupSizeInBytes"></a>
备份的大小（以字节为单位）。  
类型：长整型  
必需：否

 ** BackupVaultArn **   <a name="Backup-Type-RecoveryPointByBackupVault-BackupVaultArn"></a>
唯一标识备份保管库的 ARN；例如，`arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`。  
类型：字符串  
必需：否

 ** BackupVaultName **   <a name="Backup-Type-RecoveryPointByBackupVault-BackupVaultName"></a>
用于存储备份的逻辑容器的名称。备份保管库的名称在创建它们的账户和创建它们的 AWS 区域中是唯一的。  
类型：字符串  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必需：否

 ** CalculatedLifecycle **   <a name="Backup-Type-RecoveryPointByBackupVault-CalculatedLifecycle"></a>
包含 `DeleteAt` 和 `MoveToColdStorageAt` 时间戳的 `CalculatedLifecycle` 对象。  
类型：[CalculatedLifecycle](API_CalculatedLifecycle.md) 对象  
必需：否

 ** CompletionDate **   <a name="Backup-Type-RecoveryPointByBackupVault-CompletionDate"></a>
恢复点还原作业的完成日期和时间，采用 Unix 格式和协调世界时 (UTC)。`CompletionDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** CompositeMemberIdentifier **   <a name="Backup-Type-RecoveryPointByBackupVault-CompositeMemberIdentifier"></a>
复合组中资源的标识符，例如属于复合（父）堆栈的嵌套（子）恢复点。ID 是从堆栈内的[逻辑 ID](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax) 中传输的。  
类型：字符串  
必需：否

 ** CreatedBy **   <a name="Backup-Type-RecoveryPointByBackupVault-CreatedBy"></a>
包含有关创建恢复点的标识信息，包括用于创建该恢复点的备份计划的 `BackupPlanArn`、`BackupPlanId`、`BackupPlanVersion` 和 `BackupRuleId`。  
类型：[RecoveryPointCreator](API_RecoveryPointCreator.md) 对象  
必需：否

 ** CreationDate **   <a name="Backup-Type-RecoveryPointByBackupVault-CreationDate"></a>
恢复点的创建日期和时间，采用 Unix 时间格式和协调世界时 (UTC)。`CreationDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** EncryptionKeyArn **   <a name="Backup-Type-RecoveryPointByBackupVault-EncryptionKeyArn"></a>
用于保护备份的服务器端加密密钥；例如，`arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`。  
类型：字符串  
必需：否

 ** EncryptionKeyType **   <a name="Backup-Type-RecoveryPointByBackupVault-EncryptionKeyType"></a>
用于恢复点的加密密钥的类型。对于客户管理的密钥，有效值为 CUSTOMER\$1MANAGED\$1KMS\$1KEY，对于客户管理的密钥，有效值为 \$1OWNED\$1KMS\$1KEY。 AWS AWS  
类型：字符串  
有效值：`AWS_OWNED_KMS_KEY | CUSTOMER_MANAGED_KMS_KEY`  
必需：否

 ** IamRoleArn **   <a name="Backup-Type-RecoveryPointByBackupVault-IamRoleArn"></a>
指定用于创建目标恢复点的 IAM 角色 ARN；例如，`arn:aws:iam::123456789012:role/S3Access`。  
类型：字符串  
必需：否

 ** IndexStatus **   <a name="Backup-Type-RecoveryPointByBackupVault-IndexStatus"></a>
这是与指定恢复点关联的备份索引的当前状态。  
状态为：`PENDING` \$1 `ACTIVE` \$1 `FAILED` \$1 `DELETING`   
具有状态为 `ACTIVE` 的索引的恢复点可包含在搜索中。  
类型：字符串  
有效值：`PENDING | ACTIVE | FAILED | DELETING`  
必需：否

 ** IndexStatusMessage **   <a name="Backup-Type-RecoveryPointByBackupVault-IndexStatusMessage"></a>
一个以详细消息形式呈现的字符串，说明与恢复点关联的备份索引的状态。  
类型：字符串  
必需：否

 ** InitiationDate **   <a name="Backup-Type-RecoveryPointByBackupVault-InitiationDate"></a>
创建此恢复点的备份作业的启动日期和时间，采用 Unix 时间格式和协调世界时（UTC）。  
类型：时间戳  
必需：否

 ** IsEncrypted **   <a name="Backup-Type-RecoveryPointByBackupVault-IsEncrypted"></a>
一个布尔值，如果指定的恢复点已加密，则返回 `TRUE`，如果恢复点未加密，则返回 `FALSE`。  
类型：布尔值  
必需：否

 ** IsParent **   <a name="Backup-Type-RecoveryPointByBackupVault-IsParent"></a>
这是一个布尔值，表示这是父（复合）恢复点。  
类型：布尔值  
必需：否

 ** LastRestoreTime **   <a name="Backup-Type-RecoveryPointByBackupVault-LastRestoreTime"></a>
恢复点的上次还原日期和时间，采用 Unix 格式和协调世界时 (UTC)。`LastRestoreTime` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** Lifecycle **   <a name="Backup-Type-RecoveryPointByBackupVault-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 **   <a name="Backup-Type-RecoveryPointByBackupVault-ParentRecoveryPointArn"></a>
父（复合）恢复点的 Amazon 资源名称（ARN）。  
类型：字符串  
必需：否

 ** RecoveryPointArn **   <a name="Backup-Type-RecoveryPointByBackupVault-RecoveryPointArn"></a>
唯一标识恢复点的 Amazon 资源名称 (ARN)；例如，`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`。  
类型：字符串  
必需：否

 ** ResourceArn **   <a name="Backup-Type-RecoveryPointByBackupVault-ResourceArn"></a>
唯一标识资源的 ARN。ARN 的格式取决于资源类型。  
类型：字符串  
必需：否

 ** ResourceName **   <a name="Backup-Type-RecoveryPointByBackupVault-ResourceName"></a>
属于指定备份的资源的非唯一名称。  
类型：字符串  
必需：否

 ** ResourceType **   <a name="Backup-Type-RecoveryPointByBackupVault-ResourceType"></a>
保存为恢复点的 AWS 资源类型；例如，亚马逊弹性区块存储 (Amazon EBS) Block Store 卷或亚马逊关系数据库服务 (Amazon RDS) 数据库。对于 Windows 卷影复制服务 (VSS) 备份，唯一支持的资源类型是亚马逊 EC2。  
类型：字符串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
必需：否

 ** SourceBackupVaultArn **   <a name="Backup-Type-RecoveryPointByBackupVault-SourceBackupVaultArn"></a>
最初从中复制恢复点的备份保管库。如果将恢复点还原到相同的账户，则该值将是 `null`。  
类型：字符串  
必需：否

 ** Status **   <a name="Backup-Type-RecoveryPointByBackupVault-Status"></a>
指定恢复点状态的状态码。  
类型：字符串  
有效值：`COMPLETED | PARTIAL | DELETING | EXPIRED | AVAILABLE | STOPPED | CREATING`  
必需：否

 ** StatusMessage **   <a name="Backup-Type-RecoveryPointByBackupVault-StatusMessage"></a>
解释恢复点当前状态的消息。  
类型：字符串  
必需：否

 ** VaultType **   <a name="Backup-Type-RecoveryPointByBackupVault-VaultType"></a>
用于存储所述恢复点的保管库类型。  
类型：字符串  
有效值：`BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT | RESTORE_ACCESS_BACKUP_VAULT`  
必需：否

## 另请参阅
<a name="API_RecoveryPointByBackupVault_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RecoveryPointByBackupVault) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RecoveryPointByBackupVault) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RecoveryPointByBackupVault) 

# RecoveryPointByResource
<a name="API_RecoveryPointByResource"></a>

包含有关已保存恢复点的详细信息。

## 内容
<a name="API_RecoveryPointByResource_Contents"></a>

 ** AggregatedScanResult **   <a name="Backup-Type-RecoveryPointByResource-AggregatedScanResult"></a>
包含针对恢复点的最新扫描结果，当前包括`FailedScan`、`Findings`、`LastComputed`。  
类型：[AggregatedScanResult](API_AggregatedScanResult.md) 对象  
必需：否

 ** BackupSizeBytes **   <a name="Backup-Type-RecoveryPointByResource-BackupSizeBytes"></a>
备份的大小（以字节为单位）。  
类型：长整型  
必需：否

 ** BackupVaultName **   <a name="Backup-Type-RecoveryPointByResource-BackupVaultName"></a>
用于存储备份的逻辑容器的名称。备份保管库的名称在创建它们的账户和创建它们的 AWS 区域中是唯一的。  
类型：字符串  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必需：否

 ** CreationDate **   <a name="Backup-Type-RecoveryPointByResource-CreationDate"></a>
恢复点的创建日期和时间，采用 Unix 时间格式和协调世界时 (UTC)。`CreationDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** EncryptionKeyArn **   <a name="Backup-Type-RecoveryPointByResource-EncryptionKeyArn"></a>
用于保护备份的服务器端加密密钥；例如，`arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`。  
类型：字符串  
必需：否

 ** EncryptionKeyType **   <a name="Backup-Type-RecoveryPointByResource-EncryptionKeyType"></a>
用于恢复点的加密密钥的类型。对于客户管理的密钥，有效值为 CUSTOMER\$1MANAGED\$1KMS\$1KEY，对于客户管理的密钥，有效值为 \$1OWNED\$1KMS\$1KEY。 AWS AWS  
类型：字符串  
有效值：`AWS_OWNED_KMS_KEY | CUSTOMER_MANAGED_KMS_KEY`  
必需：否

 ** IndexStatus **   <a name="Backup-Type-RecoveryPointByResource-IndexStatus"></a>
这是与指定恢复点关联的备份索引的当前状态。  
状态为：`PENDING` \$1 `ACTIVE` \$1 `FAILED` \$1 `DELETING`   
具有状态为 `ACTIVE` 的索引的恢复点可包含在搜索中。  
类型：字符串  
有效值：`PENDING | ACTIVE | FAILED | DELETING`  
必需：否

 ** IndexStatusMessage **   <a name="Backup-Type-RecoveryPointByResource-IndexStatusMessage"></a>
一个以详细消息形式呈现的字符串，说明与恢复点关联的备份索引的状态。  
类型：字符串  
必需：否

 ** IsParent **   <a name="Backup-Type-RecoveryPointByResource-IsParent"></a>
这是一个布尔值，表示这是父（复合）恢复点。  
类型：布尔值  
必需：否

 ** ParentRecoveryPointArn **   <a name="Backup-Type-RecoveryPointByResource-ParentRecoveryPointArn"></a>
父（复合）恢复点的 Amazon 资源名称（ARN）。  
类型：字符串  
必需：否

 ** RecoveryPointArn **   <a name="Backup-Type-RecoveryPointByResource-RecoveryPointArn"></a>
唯一标识恢复点的 Amazon 资源名称 (ARN)；例如，`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`。  
类型：字符串  
必需：否

 ** ResourceName **   <a name="Backup-Type-RecoveryPointByResource-ResourceName"></a>
属于指定备份的资源的非唯一名称。  
类型：字符串  
必需：否

 ** Status **   <a name="Backup-Type-RecoveryPointByResource-Status"></a>
指定恢复点状态的状态码。  
类型：字符串  
有效值：`COMPLETED | PARTIAL | DELETING | EXPIRED | AVAILABLE | STOPPED | CREATING`  
必需：否

 ** StatusMessage **   <a name="Backup-Type-RecoveryPointByResource-StatusMessage"></a>
解释恢复点当前状态的消息。  
类型：字符串  
必需：否

 ** VaultType **   <a name="Backup-Type-RecoveryPointByResource-VaultType"></a>
用于存储所述恢复点的保管库类型。  
类型：字符串  
有效值：`BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT | RESTORE_ACCESS_BACKUP_VAULT`  
必需：否

## 另请参阅
<a name="API_RecoveryPointByResource_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RecoveryPointByResource) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RecoveryPointByResource) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RecoveryPointByResource) 

# RecoveryPointCreator
<a name="API_RecoveryPointCreator"></a>

包含有关 AWS Backup 用于启动恢复点备份的备份计划和规则的信息。

## 目录
<a name="API_RecoveryPointCreator_Contents"></a>

 ** BackupPlanArn **   <a name="Backup-Type-RecoveryPointCreator-BackupPlanArn"></a>
唯一标识备份计划的 Amazon 资源名称 (ARN)；例如，`arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50`。  
类型：字符串  
必需：否

 ** BackupPlanId **   <a name="Backup-Type-RecoveryPointCreator-BackupPlanId"></a>
唯一标识备份计划。  
类型：字符串  
必需：否

 ** BackupPlanName **   <a name="Backup-Type-RecoveryPointCreator-BackupPlanName"></a>
创建此恢复点的备份计划的名称。该值提供人类可读的上下文，说明哪个备份计划负责备份作业。  
类型：字符串  
必需：否

 ** BackupPlanVersion **   <a name="Backup-Type-RecoveryPointCreator-BackupPlanVersion"></a>
版本 ID 是唯一的、随机生成的、Unicode、UTF-8 编码字符串，长度最大为 1024 个字节。无法对其进行编辑。  
类型：字符串  
必需：否

 ** BackupRuleCron **   <a name="Backup-Type-RecoveryPointCreator-BackupRuleCron"></a>
定义备份规则计划的 cron 表达式。该表达式显示自动触发备份的频率和时间。  
类型：字符串  
必需：否

 ** BackupRuleId **   <a name="Backup-Type-RecoveryPointCreator-BackupRuleId"></a>
唯一标识用于安排所选资源备份的规则。  
类型：字符串  
必需：否

 ** BackupRuleName **   <a name="Backup-Type-RecoveryPointCreator-BackupRuleName"></a>
创建此恢复点的备份计划中备份规则的名称。该值可帮助确定哪条特定规则触发了备份作业。  
类型：字符串  
必需：否

 ** BackupRuleTimezone **   <a name="Backup-Type-RecoveryPointCreator-BackupRuleTimezone"></a>
备份规则计划使用的时区。该值为备份在指定时区内计划运行的时间提供了背景信息。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_RecoveryPointCreator_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RecoveryPointCreator) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RecoveryPointCreator) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RecoveryPointCreator) 

# RecoveryPointMember
<a name="API_RecoveryPointMember"></a>

这是一个恢复点，它是父（复合）恢复点的子（嵌套）恢复点。这些恢复点可以与其父（复合）恢复点断开关联，在这种情况下，它们将不再是其成员。

## 目录
<a name="API_RecoveryPointMember_Contents"></a>

 ** BackupVaultName **   <a name="Backup-Type-RecoveryPointMember-BackupVaultName"></a>
备份保管库（存储备份的逻辑容器）的名称。  
类型：字符串  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
必需：否

 ** RecoveryPointArn **   <a name="Backup-Type-RecoveryPointMember-RecoveryPointArn"></a>
父（复合）恢复点的 Amazon 资源名称（ARN）。  
类型：字符串  
必需：否

 ** ResourceArn **   <a name="Backup-Type-RecoveryPointMember-ResourceArn"></a>
唯一标识所保存资源的 Amazon 资源名称（ARN）。  
类型：字符串  
必需：否

 ** ResourceType **   <a name="Backup-Type-RecoveryPointMember-ResourceType"></a>
保存为恢复点的 AWS 资源类型。  
类型：字符串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
必需：否

## 另请参阅
<a name="API_RecoveryPointMember_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RecoveryPointMember) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RecoveryPointMember) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RecoveryPointMember) 

# RecoveryPointSelection
<a name="API_RecoveryPointSelection"></a>

这会指定分配一组资源的标准，例如资源类型或备份保管库。

## 目录
<a name="API_RecoveryPointSelection_Contents"></a>

 ** DateRange **   <a name="Backup-Type-RecoveryPointSelection-DateRange"></a>
这是一个资源筛选器，包含 FromDate: DateTime 和 ToDate: DateTime。两个值都是必填项。不允许使用将来 DateTime 值。  
日期和时间采用 Unix 格式和协调世界时 (UTC)，精确到毫秒（毫秒是可选项）。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：[DateRange](API_DateRange.md) 对象  
必需：否

 ** ResourceIdentifiers **   <a name="Backup-Type-RecoveryPointSelection-ResourceIdentifiers"></a>
这些是资源选择中包含的资源（包括资源和保管库的类型）。  
类型：字符串数组  
必需：否

 ** VaultNames **   <a name="Backup-Type-RecoveryPointSelection-VaultNames"></a>
这些是包含所选恢复点的保管库的名称。  
类型：字符串数组  
必需：否

## 另请参阅
<a name="API_RecoveryPointSelection_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RecoveryPointSelection) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RecoveryPointSelection) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RecoveryPointSelection) 

# ReportDeliveryChannel
<a name="API_ReportDeliveryChannel"></a>

包含您报告计划中的有关在何处交付报告的信息，特别是 Amazon S3 存储桶名称、S3 密钥前缀和报告格式。

## 目录
<a name="API_ReportDeliveryChannel_Contents"></a>

 ** S3BucketName **   <a name="Backup-Type-ReportDeliveryChannel-S3BucketName"></a>
接收报告的 S3 存储桶的唯一名称。  
类型：字符串  
必需：是

 ** Formats **   <a name="Backup-Type-ReportDeliveryChannel-Formats"></a>
报告格式：`CSV`、`JSON` 或两者兼有。如未指定，则默认格式为 `CSV`。  
类型：字符串数组  
必需：否

 ** S3KeyPrefix **   <a name="Backup-Type-ReportDeliveryChannel-S3KeyPrefix"></a>
AWS Backup Audit Manager 将报告交付给 Amazon S3 的位置的前缀。前缀是以下路径的这一部分：s3://your-bucket-name/`prefix`/Backup/us-west-2/year/month/day/report-name。如未指定，则没有前缀。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_ReportDeliveryChannel_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ReportDeliveryChannel) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ReportDeliveryChannel) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ReportDeliveryChannel) 

# ReportDestination
<a name="API_ReportDestination"></a>

包含报告作业中有关报告目的地的信息。

## 目录
<a name="API_ReportDestination_Contents"></a>

 ** S3BucketName **   <a name="Backup-Type-ReportDestination-S3BucketName"></a>
接收报告的 Amazon S3 存储桶的唯一名称。  
类型：字符串  
必需：否

 ** S3Keys **   <a name="Backup-Type-ReportDestination-S3Keys"></a>
唯一标识 S3 存储桶中报告的对象密钥。  
类型：字符串数组  
必需：否

## 另请参阅
<a name="API_ReportDestination_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ReportDestination) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ReportDestination) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ReportDestination) 

# ReportJob
<a name="API_ReportJob"></a>

包含有关报告作业的详细信息。报告作业根据报告计划编译报告并将其发布到 Amazon S3。

## 目录
<a name="API_ReportJob_Contents"></a>

 ** CompletionTime **   <a name="Backup-Type-ReportJob-CompletionTime"></a>
报告作业的完成日期和时间，采用 Unix 格式和协调世界时 (UTC)。`CompletionTime` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** CreationTime **   <a name="Backup-Type-ReportJob-CreationTime"></a>
报告作业的创建日期和时间，采用 Unix 时间格式和协调世界时 (UTC)。`CreationTime` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** ReportDestination **   <a name="Backup-Type-ReportJob-ReportDestination"></a>
报告作业发布报告的目的地的 S3 存储桶名称和 S3 密钥。  
类型：[ReportDestination](API_ReportDestination.md) 对象  
必需：否

 ** ReportJobId **   <a name="Backup-Type-ReportJob-ReportJobId"></a>
报告作业的标识符。唯一的、随机生成的、Unicode、UTF-8 编码字符串，长度最大为 1024 个字节。无法编辑报告作业 ID。  
类型：字符串  
必需：否

 ** ReportPlanArn **   <a name="Backup-Type-ReportJob-ReportPlanArn"></a>
唯一标识资源的 Amazon 资源名称 (ARN)。ARN 的格式取决于资源类型。  
类型：字符串  
必需：否

 ** ReportTemplate **   <a name="Backup-Type-ReportJob-ReportTemplate"></a>
标识报告的报告模板。报告使用报告模板构建。报告模板包括：  
 `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT`   
类型：字符串  
必需：否

 ** Status **   <a name="Backup-Type-ReportJob-Status"></a>
报告作业的状态。状态包括：  
 `CREATED | RUNNING | COMPLETED | FAILED`   
 `COMPLETED` 表示报告可在您指定的目的地供您查看。如果状态为 `FAILED`，请查看 `StatusMessage` 以了解原因。  
类型：字符串  
必需：否

 ** StatusMessage **   <a name="Backup-Type-ReportJob-StatusMessage"></a>
一条说明报告作业状态的消息。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_ReportJob_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ReportJob) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ReportJob) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ReportJob) 

# ReportPlan
<a name="API_ReportPlan"></a>

包含有关报告计划的详细信息。

## 目录
<a name="API_ReportPlan_Contents"></a>

 ** CreationTime **   <a name="Backup-Type-ReportPlan-CreationTime"></a>
报告计划的创建日期和时间，采用 Unix 格式和协调世界时 (UTC)。`CreationTime` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** DeploymentStatus **   <a name="Backup-Type-ReportPlan-DeploymentStatus"></a>
报告计划的部署状态。状态包括：  
 `CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED`   
类型：字符串  
必需：否

 ** LastAttemptedExecutionTime **   <a name="Backup-Type-ReportPlan-LastAttemptedExecutionTime"></a>
与此报告计划关联的报告作业的上次尝试运行的日期和时间，采用 Unix 格式和协调世界时 (UTC)。`LastAttemptedExecutionTime` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** LastSuccessfulExecutionTime **   <a name="Backup-Type-ReportPlan-LastSuccessfulExecutionTime"></a>
与此报告计划关联的报告作业的上次成功运行日期和时间，采用 Unix 格式和协调世界时 (UTC)。`LastSuccessfulExecutionTime` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** ReportDeliveryChannel **   <a name="Backup-Type-ReportPlan-ReportDeliveryChannel"></a>
包含有关在何处以及如何交付报告的信息，特别是 Amazon S3 桶名称、S3 密钥前缀和报告格式。  
类型：[ReportDeliveryChannel](API_ReportDeliveryChannel.md) 对象  
必需：否

 ** ReportPlanArn **   <a name="Backup-Type-ReportPlan-ReportPlanArn"></a>
唯一标识资源的 Amazon 资源名称 (ARN)。ARN 的格式取决于资源类型。  
类型：字符串  
必需：否

 ** ReportPlanDescription **   <a name="Backup-Type-ReportPlan-ReportPlanDescription"></a>
报告计划的可选描述，最多 1024 个字符。  
类型：字符串  
长度约束：最小长度为 0。最大长度为 1024。  
模式：`.*\S.*`  
必需：否

 ** ReportPlanName **   <a name="Backup-Type-ReportPlan-ReportPlanName"></a>
报告计划的唯一名称。此名称的长度介于 1 到 256 个字符之间，以字母开头，由字母（a-z、A-Z）、数字 (0-9) 和下划线 (\$1) 组成。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 256。  
模式：`[a-zA-Z][_a-zA-Z0-9]*`  
必需：否

 ** ReportSetting **   <a name="Backup-Type-ReportPlan-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_ReportPlan_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ReportPlan) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ReportPlan) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ReportPlan) 

# ReportSetting
<a name="API_ReportSetting"></a>

包含有关报告设置的详细信息。

## 内容
<a name="API_ReportSetting_Contents"></a>

 ** ReportTemplate **   <a name="Backup-Type-ReportSetting-ReportTemplate"></a>
标识报告的报告模板。报告使用报告模板构建。报告模板包括：  
 `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT | SCAN_JOB_REPORT`   
类型：字符串  
是否必需：是

 ** Accounts **   <a name="Backup-Type-ReportSetting-Accounts"></a>
这些是要列入报告的账户。  
使用字符串值 `ROOT` 以包含所有组织单位。  
类型：字符串数组  
必需：否

 ** FrameworkArns **   <a name="Backup-Type-ReportSetting-FrameworkArns"></a>
报告涵盖的框架的 Amazon 资源名称 (ARNs)。  
类型：字符串数组  
必需：否

 ** NumberOfFrameworks **   <a name="Backup-Type-ReportSetting-NumberOfFrameworks"></a>
报告涵盖的框架数量。  
类型：整数  
必需：否

 ** OrganizationUnits **   <a name="Backup-Type-ReportSetting-OrganizationUnits"></a>
这些是要列入报告的组织单元。  
类型：字符串数组  
必需：否

 ** Regions **   <a name="Backup-Type-ReportSetting-Regions"></a>
这些是要列入报告的区域。  
使用通配符作为包含所有区域的字符串值。  
类型：字符串数组  
必需：否

## 另请参阅
<a name="API_ReportSetting_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ReportSetting) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ReportSetting) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ReportSetting) 

# ResourceSelection
<a name="API_ResourceSelection"></a>

其中包含有关分层配置资源选择的元数据。

每个分层配置最多可以指定 5 种不同的资源选择。移动到较低成本层的数据会一直保留在那里，直到删除（单向过渡）。

## 内容
<a name="API_ResourceSelection_Contents"></a>

 ** Resources **   <a name="Backup-Type-ResourceSelection-Resources"></a>
包含关联资源或包含 ARNs 用于指定所有资源的通配符`*`的字符串数组。每个分层配置最多可以指定 100 个特定资源。  
类型：字符串数组  
是否必需：是

 ** ResourceType **   <a name="Backup-Type-ResourceSelection-ResourceType"></a>
 AWS 资源的类型；`S3`例如，用于 Amazon S3。对于分层配置，目前仅限于。`S3`  
类型：字符串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
是否必需：是

 ** TieringDownSettingsInDays **   <a name="Backup-Type-ResourceSelection-TieringDownSettingsInDays"></a>
在备份保管库中创建对象后，可以过渡到低成本的温存储层的天数。必须是介于 60 到 36500 天之间的正整数。  
类型：整数  
有效范围：最小值为 60。最大值为 36500。  
是否必需：是

## 另请参阅
<a name="API_ResourceSelection_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ResourceSelection) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ResourceSelection) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ResourceSelection) 

# RestoreAccessBackupVaultListMember
<a name="API_RestoreAccessBackupVaultListMember"></a>

包含有关恢复访问权限备份保管库的信息。

## 目录
<a name="API_RestoreAccessBackupVaultListMember_Contents"></a>

 ** ApprovalDate **   <a name="Backup-Type-RestoreAccessBackupVaultListMember-ApprovalDate"></a>
恢复访问权限备份保管库的批准日期和时间。  
类型：时间戳  
必需：否

 ** CreationDate **   <a name="Backup-Type-RestoreAccessBackupVaultListMember-CreationDate"></a>
恢复访问权限备份保管库的创建日期和时间。  
类型：时间戳  
必需：否

 ** LatestRevokeRequest **   <a name="Backup-Type-RestoreAccessBackupVaultListMember-LatestRevokeRequest"></a>
有关撤消对此备份保管库的访问权限的最新请求的信息。  
类型：[LatestRevokeRequest](API_LatestRevokeRequest.md) 对象  
必需：否

 ** RestoreAccessBackupVaultArn **   <a name="Backup-Type-RestoreAccessBackupVaultListMember-RestoreAccessBackupVaultArn"></a>
恢复访问权限备份保管库的 ARN。  
类型：字符串  
必需：否

 ** VaultState **   <a name="Backup-Type-RestoreAccessBackupVaultListMember-VaultState"></a>
恢复访问权限备份保管库的当前状态。  
类型：字符串  
有效值：`CREATING | AVAILABLE | FAILED`  
必需：否

## 另请参阅
<a name="API_RestoreAccessBackupVaultListMember_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreAccessBackupVaultListMember) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreAccessBackupVaultListMember) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreAccessBackupVaultListMember) 

# RestoreJobCreator
<a name="API_RestoreJobCreator"></a>

包含有关 AWS Backup 用于启动还原作业的还原测试计划的信息。

## 目录
<a name="API_RestoreJobCreator_Contents"></a>

 ** RestoreTestingPlanArn **   <a name="Backup-Type-RestoreJobCreator-RestoreTestingPlanArn"></a>
可唯一标识还原测试计划的 Amazon 资源名称（ARN）。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_RestoreJobCreator_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreJobCreator) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreJobCreator) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreJobCreator) 

# RestoreJobsListMember
<a name="API_RestoreJobsListMember"></a>

包含还原作业相关元数据。

## 内容
<a name="API_RestoreJobsListMember_Contents"></a>

 ** AccountId **   <a name="Backup-Type-RestoreJobsListMember-AccountId"></a>
拥有还原作业的账户 ID。  
类型：字符串  
模式：`^[0-9]{12}$`  
必需：否

 ** BackupSizeInBytes **   <a name="Backup-Type-RestoreJobsListMember-BackupSizeInBytes"></a>
还原资源的大小（以字节为单位）。  
类型：长整型  
必需：否

 ** BackupVaultArn **   <a name="Backup-Type-RestoreJobsListMember-BackupVaultArn"></a>
包含正在恢复的恢复点的备份保管库的 Amazon 资源名称（ARN）。此值有助于确定保管库访问策略和权限。  
类型：字符串  
必需：否

 ** CompletionDate **   <a name="Backup-Type-RestoreJobsListMember-CompletionDate"></a>
恢复点还原作业的完成日期和时间，采用 Unix 格式和协调世界时 (UTC)。`CompletionDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** CreatedBy **   <a name="Backup-Type-RestoreJobsListMember-CreatedBy"></a>
包含有关创建还原作业的标识信息。  
类型：[RestoreJobCreator](API_RestoreJobCreator.md) 对象  
必需：否

 ** CreatedResourceArn **   <a name="Backup-Type-RestoreJobsListMember-CreatedResourceArn"></a>
唯一标识资源的 Amazon 资源名称 (ARN)。ARN 的格式取决于资源类型。  
类型：字符串  
必需：否

 ** CreationDate **   <a name="Backup-Type-RestoreJobsListMember-CreationDate"></a>
还原作业的创建日期和时间，采用 Unix 时间格式和协调世界时 (UTC)。`CreationDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** DeletionStatus **   <a name="Backup-Type-RestoreJobsListMember-DeletionStatus"></a>
这记录了还原测试生成的数据的状态。状态可以是 `Deleting`、`Failed` 或 `Successful`。  
类型：字符串  
有效值：`DELETING | FAILED | SUCCESSFUL`  
必需：否

 ** DeletionStatusMessage **   <a name="Backup-Type-RestoreJobsListMember-DeletionStatusMessage"></a>
这描述了还原作业的删除状态。  
类型：字符串  
必需：否

 ** ExpectedCompletionTimeMinutes **   <a name="Backup-Type-RestoreJobsListMember-ExpectedCompletionTimeMinutes"></a>
恢复点还原作业预计要花费的时间（以分钟为单位）。  
类型：长整型  
必需：否

 ** IamRoleArn **   <a name="Backup-Type-RestoreJobsListMember-IamRoleArn"></a>
用于创建目标恢复点的 IAM 角色 ARN；例如 `arn:aws:iam::123456789012:role/S3Access`。  
类型：字符串  
必需：否

 ** IsParent **   <a name="Backup-Type-RestoreJobsListMember-IsParent"></a>
这是一个布尔值，表示还原作业是否为父（复合）还原作业。  
类型：布尔值  
必需：否

 ** ParentJobId **   <a name="Backup-Type-RestoreJobsListMember-ParentJobId"></a>
这是所选还原作业的父还原作业的唯一标识符。  
类型：字符串  
必需：否

 ** PercentDone **   <a name="Backup-Type-RestoreJobsListMember-PercentDone"></a>
包含查询作业状态时作业完成的估计百分比。  
类型：字符串  
必需：否

 ** RecoveryPointArn **   <a name="Backup-Type-RestoreJobsListMember-RecoveryPointArn"></a>
唯一标识恢复点的 ARN；例如，`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`。  
类型：字符串  
必需：否

 ** RecoveryPointCreationDate **   <a name="Backup-Type-RestoreJobsListMember-RecoveryPointCreationDate"></a>
创建恢复点的日期。  
类型：时间戳  
必需：否

 ** ResourceType **   <a name="Backup-Type-RestoreJobsListMember-ResourceType"></a>
列出的还原作业的资源类型；例如 Amazon Elastic Block Store (Amazon EBS) 卷或 Amazon Relational Database Service (Amazon RDS) 数据库。对于 Windows 卷影复制服务 (VSS) 备份，唯一支持的资源类型是亚马逊 EC2。  
类型：字符串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
必需：否

 ** RestoreJobId **   <a name="Backup-Type-RestoreJobsListMember-RestoreJobId"></a>
唯一标识还原恢复点的作业。  
类型：字符串  
必需：否

 ** SourceResourceArn **   <a name="Backup-Type-RestoreJobsListMember-SourceResourceArn"></a>
备份的原始资源的 Amazon 资源名称（ARN）。此值提供了有关正在恢复的资源的背景信息。  
类型：字符串  
必需：否

 ** Status **   <a name="Backup-Type-RestoreJobsListMember-Status"></a>
一种状态码，用于指定为恢复恢复点 AWS Backup 而启动的任务的状态。  
类型：字符串  
有效值：`PENDING | RUNNING | COMPLETED | ABORTED | FAILED`  
必需：否

 ** StatusMessage **   <a name="Backup-Type-RestoreJobsListMember-StatusMessage"></a>
一条详细消息，说明恢复点还原作业的状态。  
类型：字符串  
必需：否

 ** ValidationStatus **   <a name="Backup-Type-RestoreJobsListMember-ValidationStatus"></a>
针对指定还原作业运行的验证的状态。  
类型：字符串  
有效值：`FAILED | SUCCESSFUL | TIMED_OUT | VALIDATING`  
必需：否

 ** ValidationStatusMessage **   <a name="Backup-Type-RestoreJobsListMember-ValidationStatusMessage"></a>
这描述了针对指定的还原作业运行的验证的状态。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_RestoreJobsListMember_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreJobsListMember) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreJobsListMember) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreJobsListMember) 

# RestoreJobSummary
<a name="API_RestoreJobSummary"></a>

此请求提供最近 30 天内创建的或正在运行的还原作业的摘要。

返回的摘要可能包含以下内容：区域、账户、状态、资源类型、消息类别、开始时间、结束时间和所包含作业的计数。

## 目录
<a name="API_RestoreJobSummary_Contents"></a>

 ** AccountId **   <a name="Backup-Type-RestoreJobSummary-AccountId"></a>
拥有摘要中作业的账户 ID。  
类型：字符串  
模式：`^[0-9]{12}$`  
必需：否

 ** Count **   <a name="Backup-Type-RestoreJobSummary-Count"></a>
该值以作业数量的形式显示在作业摘要中。  
类型：整数  
必需：否

 ** EndTime **   <a name="Backup-Type-RestoreJobSummary-EndTime"></a>
以数字格式表示的作业结束时间值。  
该值是采用 Unix 格式表示的时间，它是世界标准时间 (UTC)，精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** Region **   <a name="Backup-Type-RestoreJobSummary-Region"></a>
作业摘要中的 AWS 区域。  
类型：字符串  
必需：否

 ** ResourceType **   <a name="Backup-Type-RestoreJobSummary-ResourceType"></a>
此值是指定的资源类型的作业计数。请求 `GetSupportedResourceTypes` 返回支持的资源类型的字符串。  
类型：字符串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
必需：否

 ** StartTime **   <a name="Backup-Type-RestoreJobSummary-StartTime"></a>
以数字格式表示的作业开始时间值。  
该值是采用 Unix 格式表示的时间，它是世界标准时间 (UTC)，精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** State **   <a name="Backup-Type-RestoreJobSummary-State"></a>
此值是处于指定状态的作业的计数。  
类型：字符串  
有效值：`CREATED | PENDING | RUNNING | ABORTED | COMPLETED | FAILED | AGGREGATE_ALL | ANY`  
必需：否

## 另请参阅
<a name="API_RestoreJobSummary_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreJobSummary) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreJobSummary) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreJobSummary) 

# RestoreTestingPlanForCreate
<a name="API_RestoreTestingPlanForCreate"></a>

其中包含有关还原测试计划的元数据。

## 目录
<a name="API_RestoreTestingPlanForCreate_Contents"></a>

 ** RecoveryPointSelection **   <a name="Backup-Type-RestoreTestingPlanForCreate-RecoveryPointSelection"></a>
 `RecoveryPointSelection` 有五个参数（三个必需参数和两个可选参数）。您指定的值决定了要在还原测试中包括的恢复点。您必须使用 `Algorithm` 指明是想要 `SelectionWindowDays` 内的最新恢复点，还是想要一个随机恢复点，并且您必须通过 `IncludeVaults` 指明可以从哪些保管库中选择恢复点。  
 `Algorithm`（*必需*）有效值：“`LATEST_WITHIN_WINDOW`”或“`RANDOM_WITHIN_WINDOW`”。  
 `Recovery point types`（*必需*）有效值：“`SNAPSHOT`”和/或“`CONTINUOUS`”。包括 `SNAPSHOT` 只能还原快照恢复点；包括 `CONTINUOUS` 只能还原连续恢复点（时间点还原/PITR）；同时使用两者可还原快照恢复点或连续恢复点。恢复点将由 `Algorithm` 的值确定。  
 `IncludeVaults`（*必需*）。必须包含一个或多个备份保管库。使用通配符 [“\$1”] 或特定 ARN。  
 `SelectionWindowDays`（*可选*）值必须是 1 到 365 的整数（以天为单位）。如果未包含，则该值默认为 `30`。  
 `ExcludeVaults`（*可选*）。您可以选择输入一个或多个特定的备份保管库 ARN，以将这些保管库的内容排除在还原资格之外。或者，您可以包含选择器列表。如果不包含此参数及其值，则默认为空列表。  
类型：[RestoreTestingRecoveryPointSelection](API_RestoreTestingRecoveryPointSelection.md) 对象  
必需：是

 ** RestoreTestingPlanName **   <a name="Backup-Type-RestoreTestingPlanForCreate-RestoreTestingPlanName"></a>
RestoreTestingPlanName 是唯一字符串，即还原测试计划的名称。创建后无法对其进行更改，并且只能由字母数字字符和下划线组成。  
类型：字符串  
必需：是

 ** ScheduleExpression **   <a name="Backup-Type-RestoreTestingPlanForCreate-ScheduleExpression"></a>
在指定时区执行还原测试计划的 CRON 表达式。当未提供 CRON 表达式时，AWS Backup 将使用默认表达式 `cron(0 5 ? * * *)`。  
类型：字符串  
必需：是

 ** ScheduleExpressionTimezone **   <a name="Backup-Type-RestoreTestingPlanForCreate-ScheduleExpressionTimezone"></a>
可选。这是设置安排表达式的时区。默认情况下，ScheduleExpressions 用 UTC 表示。您可以将其修改为指定的时区。  
类型：字符串  
必需：否

 ** StartWindowHours **   <a name="Backup-Type-RestoreTestingPlanForCreate-StartWindowHours"></a>
默认为 24 小时。  
一个时间值（以小时为单位），用于指定在安排了还原测试之后，必须在多长时间内成功启动作业，否则将会被取消。该值为可选项。如果包含此值，则此参数的最大值为 168 小时（一周）。  
类型：整数  
必需：否

## 另请参阅
<a name="API_RestoreTestingPlanForCreate_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreTestingPlanForCreate) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreTestingPlanForCreate) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreTestingPlanForCreate) 

# RestoreTestingPlanForGet
<a name="API_RestoreTestingPlanForGet"></a>

其中包含有关还原测试计划的元数据。

## 目录
<a name="API_RestoreTestingPlanForGet_Contents"></a>

 ** CreationTime **   <a name="Backup-Type-RestoreTestingPlanForGet-CreationTime"></a>
还原测试计划的创建日期和时间，以 Unix 格式和世界标准时间 (UTC) 格式表示。`CreationTime` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：是

 ** RecoveryPointSelection **   <a name="Backup-Type-RestoreTestingPlanForGet-RecoveryPointSelection"></a>
用于分配一组资源的指定标准，例如恢复点类型或备份保管库。  
类型：[RestoreTestingRecoveryPointSelection](API_RestoreTestingRecoveryPointSelection.md) 对象  
必需：是

 ** RestoreTestingPlanArn **   <a name="Backup-Type-RestoreTestingPlanForGet-RestoreTestingPlanArn"></a>
可唯一标识还原测试计划的 Amazon 资源名称（ARN）。  
类型：字符串  
必需：是

 ** RestoreTestingPlanName **   <a name="Backup-Type-RestoreTestingPlanForGet-RestoreTestingPlanName"></a>
还原测试计划名称。  
类型：字符串  
必需：是

 ** ScheduleExpression **   <a name="Backup-Type-RestoreTestingPlanForGet-ScheduleExpression"></a>
在指定时区执行还原测试计划的 CRON 表达式。当未提供 CRON 表达式时，AWS Backup 将使用默认表达式 `cron(0 5 ? * * *)`。  
类型：字符串  
必需：是

 ** CreatorRequestId **   <a name="Backup-Type-RestoreTestingPlanForGet-CreatorRequestId"></a>
这用于标识请求并允许重试失败的请求，而不存在两次运行操作的风险。如果请求中包含与现有备份计划匹配的 `CreatorRequestId`，则会返回该计划。此参数为可选的。  
如果使用，则此参数必须包含 1 到 50 个字母数字或“-\$1.” 字符。  
类型：字符串  
必需：否

 ** LastExecutionTime **   <a name="Backup-Type-RestoreTestingPlanForGet-LastExecutionTime"></a>
上次使用指定的还原测试计划运行还原测试的时间。日期和时间，采用 Unix 格式和协调世界时 (UTC)。`LastExecutionDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** LastUpdateTime **   <a name="Backup-Type-RestoreTestingPlanForGet-LastUpdateTime"></a>
更新还原测试计划的日期和时间。此更新采用 Unix 格式和协调世界时 (UTC)。`LastUpdateTime` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** ScheduleExpressionTimezone **   <a name="Backup-Type-RestoreTestingPlanForGet-ScheduleExpressionTimezone"></a>
可选。这是设置安排表达式的时区。默认情况下，ScheduleExpressions 用 UTC 表示。您可以将其修改为指定的时区。  
类型：字符串  
必需：否

 ** StartWindowHours **   <a name="Backup-Type-RestoreTestingPlanForGet-StartWindowHours"></a>
默认为 24 小时。  
一个时间值（以小时为单位），用于指定在安排了还原测试之后，必须在多长时间内成功启动作业，否则将会被取消。该值为可选项。如果包含此值，则此参数的最大值为 168 小时（一周）。  
类型：整数  
必需：否

## 另请参阅
<a name="API_RestoreTestingPlanForGet_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreTestingPlanForGet) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreTestingPlanForGet) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreTestingPlanForGet) 

# RestoreTestingPlanForList
<a name="API_RestoreTestingPlanForList"></a>

其中包含有关还原测试计划的元数据。

## 目录
<a name="API_RestoreTestingPlanForList_Contents"></a>

 ** CreationTime **   <a name="Backup-Type-RestoreTestingPlanForList-CreationTime"></a>
还原测试计划的创建日期和时间，以 Unix 格式和世界标准时间 (UTC) 格式表示。`CreationTime` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：是

 ** RestoreTestingPlanArn **   <a name="Backup-Type-RestoreTestingPlanForList-RestoreTestingPlanArn"></a>
可唯一标识还原测试计划的 Amazon 资源名称（ARN）。  
类型：字符串  
必需：是

 ** RestoreTestingPlanName **   <a name="Backup-Type-RestoreTestingPlanForList-RestoreTestingPlanName"></a>
还原测试计划名称。  
类型：字符串  
必需：是

 ** ScheduleExpression **   <a name="Backup-Type-RestoreTestingPlanForList-ScheduleExpression"></a>
在指定时区执行还原测试计划的 CRON 表达式。当未提供 CRON 表达式时，AWS Backup 将使用默认表达式 `cron(0 5 ? * * *)`。  
类型：字符串  
必需：是

 ** LastExecutionTime **   <a name="Backup-Type-RestoreTestingPlanForList-LastExecutionTime"></a>
上次使用指定的还原测试计划运行还原测试的时间。日期和时间，采用 Unix 格式和协调世界时 (UTC)。`LastExecutionDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** LastUpdateTime **   <a name="Backup-Type-RestoreTestingPlanForList-LastUpdateTime"></a>
更新还原测试计划的日期和时间。此更新采用 Unix 格式和协调世界时 (UTC)。`LastUpdateTime` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** ScheduleExpressionTimezone **   <a name="Backup-Type-RestoreTestingPlanForList-ScheduleExpressionTimezone"></a>
可选。这是设置安排表达式的时区。默认情况下，ScheduleExpressions 用 UTC 表示。您可以将其修改为指定的时区。  
类型：字符串  
必需：否

 ** StartWindowHours **   <a name="Backup-Type-RestoreTestingPlanForList-StartWindowHours"></a>
默认为 24 小时。  
一个时间值（以小时为单位），用于指定在安排了还原测试之后，必须在多长时间内成功启动作业，否则将会被取消。该值为可选项。如果包含此值，则此参数的最大值为 168 小时（一周）。  
类型：整数  
必需：否

## 另请参阅
<a name="API_RestoreTestingPlanForList_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreTestingPlanForList) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreTestingPlanForList) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreTestingPlanForList) 

# RestoreTestingPlanForUpdate
<a name="API_RestoreTestingPlanForUpdate"></a>

其中包含有关还原测试计划的元数据。

## 目录
<a name="API_RestoreTestingPlanForUpdate_Contents"></a>

 ** RecoveryPointSelection **   <a name="Backup-Type-RestoreTestingPlanForUpdate-RecoveryPointSelection"></a>
必需：`Algorithm`；`RecoveryPointTypes`；`IncludeVaults`（*一个或多个*）。  
可选：*SelectionWindowDays*（*如果未指定，则为“30”*）；`ExcludeVaults`（如果未列出，则默认为空列表）。  
类型：[RestoreTestingRecoveryPointSelection](API_RestoreTestingRecoveryPointSelection.md) 对象  
必需：否

 ** ScheduleExpression **   <a name="Backup-Type-RestoreTestingPlanForUpdate-ScheduleExpression"></a>
在指定时区执行还原测试计划的 CRON 表达式。当未提供 CRON 表达式时，AWS Backup 将使用默认表达式 `cron(0 5 ? * * *)`。  
类型：字符串  
必需：否

 ** ScheduleExpressionTimezone **   <a name="Backup-Type-RestoreTestingPlanForUpdate-ScheduleExpressionTimezone"></a>
可选。这是设置安排表达式的时区。默认情况下，ScheduleExpressions 用 UTC 表示。您可以将其修改为指定的时区。  
类型：字符串  
必需：否

 ** StartWindowHours **   <a name="Backup-Type-RestoreTestingPlanForUpdate-StartWindowHours"></a>
默认为 24 小时。  
一个时间值（以小时为单位），用于指定在安排了还原测试之后，必须在多长时间内成功启动作业，否则将会被取消。该值为可选项。如果包含此值，则此参数的最大值为 168 小时（一周）。  
类型：整数  
必需：否

## 另请参阅
<a name="API_RestoreTestingPlanForUpdate_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreTestingPlanForUpdate) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreTestingPlanForUpdate) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreTestingPlanForUpdate) 

# RestoreTestingRecoveryPointSelection
<a name="API_RestoreTestingRecoveryPointSelection"></a>

 `RecoveryPointSelection` 有五个参数（三个必需参数和两个可选参数）。您指定的值决定了要在还原测试中包括的恢复点。您必须使用 `Algorithm` 指明是想要 `SelectionWindowDays` 内的最新恢复点，还是想要一个随机恢复点，并且您必须通过 `IncludeVaults` 指明可以从哪些保管库中选择恢复点。

 `Algorithm`（*必需*）有效值：“`LATEST_WITHIN_WINDOW`”或“`RANDOM_WITHIN_WINDOW`”。

 `Recovery point types`（*必需*）有效值：“`SNAPSHOT`”和/或“`CONTINUOUS`”。包括 `SNAPSHOT` 只能还原快照恢复点；包括 `CONTINUOUS` 只能还原连续恢复点（时间点还原/PITR）；同时使用两者可还原快照恢复点或连续恢复点。恢复点将由 `Algorithm` 的值确定。

 `IncludeVaults`（*必需*）。必须包含一个或多个备份保管库。使用通配符 [“\$1”] 或特定 ARN。

 `SelectionWindowDays`（*可选*）值必须是 1 到 365 的整数（以天为单位）。如果未包含，则该值默认为 `30`。

 `ExcludeVaults`（*可选*） 您可以选择输入一个或多个特定的备份保管库 ARN，以将这些保管库的内容排除在还原资格之外。或者，您可以包含选择器列表。如果不包含此参数及其值，则默认为空列表。

## 目录
<a name="API_RestoreTestingRecoveryPointSelection_Contents"></a>

 ** Algorithm **   <a name="Backup-Type-RestoreTestingRecoveryPointSelection-Algorithm"></a>
可接受的值包括“LATEST\$1WITHIN\$1WINDOW”或“RANDOM\$1WITHIN\$1WINDOW”  
类型：字符串  
有效值：`LATEST_WITHIN_WINDOW | RANDOM_WITHIN_WINDOW`  
必需：否

 ** ExcludeVaults **   <a name="Backup-Type-RestoreTestingRecoveryPointSelection-ExcludeVaults"></a>
可接受的值包括特定的 ARN 或选择器列表。如果未列出，则默认为空列表。  
类型：字符串数组  
必需：否

 ** IncludeVaults **   <a name="Backup-Type-RestoreTestingRecoveryPointSelection-IncludeVaults"></a>
可接受的值包括通配符 ["\$1"]、特定 ARN 或 ARN 通配符替换值 ["arn:aws:backup:us-west-2:123456789012:backup-vault:asdf", ...] ["arn:aws:backup:\$1:\$1:backup-vault:asdf-\$1", ...]  
类型：字符串数组  
必需：否

 ** RecoveryPointTypes **   <a name="Backup-Type-RestoreTestingRecoveryPointSelection-RecoveryPointTypes"></a>
这些是恢复点的类型。  
包括 `SNAPSHOT` 只能还原快照恢复点；包括 `CONTINUOUS` 只能还原连续恢复点（时间点还原/PITR）；同时使用两者可还原快照恢复点或连续恢复点。恢复点将由 `Algorithm` 的值确定。  
类型：字符串数组  
有效值：`CONTINUOUS | SNAPSHOT`  
必需：否

 ** SelectionWindowDays **   <a name="Backup-Type-RestoreTestingRecoveryPointSelection-SelectionWindowDays"></a>
可接受的值是介于 1 到 365 之间的整数。  
类型：整数  
必需：否

## 另请参阅
<a name="API_RestoreTestingRecoveryPointSelection_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreTestingRecoveryPointSelection) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreTestingRecoveryPointSelection) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreTestingRecoveryPointSelection) 

# RestoreTestingSelectionForCreate
<a name="API_RestoreTestingSelectionForCreate"></a>

其中包含有关特定还原测试选择的元数据。

ProtectedResourceType 是必填项，例如亚马逊 EBS 或亚马逊 EC2。

它包括 `RestoreTestingSelectionName`、`ProtectedResourceType` 和以下项之一：
+  `ProtectedResourceArns` 
+  `ProtectedResourceConditions` 

每种受保护的资源类型可以具有一个单一值。

还原测试选择可以包括带通配符值（“\$1”）的 `ProtectedResourceArns` 以及 `ProtectedResourceConditions`。或者，您最多可以在其中包含 30 个特定的受保护资源 ARNs `ProtectedResourceArns`。

 `ProtectedResourceConditions` 示例包括 `StringEquals` 和 `StringNotEquals`。

## 内容
<a name="API_RestoreTestingSelectionForCreate_Contents"></a>

 ** IamRoleArn **   <a name="Backup-Type-RestoreTestingSelectionForCreate-IamRoleArn"></a>
 AWS Backup 用于创建目标资源的 IAM 角色的 Amazon 资源名称 (ARN)；例如：`arn:aws:iam::123456789012:role/S3Access`  
类型：字符串  
是否必需：是

 ** ProtectedResourceType **   <a name="Backup-Type-RestoreTestingSelectionForCreate-ProtectedResourceType"></a>
还原测试选项中包含的 AWS 资源类型；例如，Amazon EBS 卷或 Amazon RDS 数据库。  
接受的受支持资源类型包括：  
+  适用于 Amazon Aurora 的 `Aurora`
+  适用于 Amazon DocumentDB（与 MongoDB 兼容）的 `DocumentDB`
+  `DynamoDB`：表示 Amazon DynamoDB
+  `EBS`：表示 Amazon Elastic Block Store
+  `EC2`：表示 Amazon Elastic Compute Cloud
+  `EFS`：表示 Amazon Elastic File System
+  `FSx`适用于亚马逊 FSx
+  适用于 Amazon Neptune 的 `Neptune`
+  适用于 Amazon Relational Database Service 的 `RDS`
+  `S3`：表示 Amazon S3
类型：字符串  
是否必需：是

 ** RestoreTestingSelectionName **   <a name="Backup-Type-RestoreTestingSelectionForCreate-RestoreTestingSelectionName"></a>
属于相关还原测试计划的还原测试选择的唯一名称。  
名称只能包含字母数字字符和下划线。最大长度为 50。  
类型：字符串  
是否必需：是

 ** ProtectedResourceArns **   <a name="Backup-Type-RestoreTestingSelectionForCreate-ProtectedResourceArns"></a>
每个受保护的资源都可以按其特定资源进行筛选 ARNs，例如`ProtectedResourceArns: ["arn:aws:...", "arn:aws:..."]`或使用通配符:进行筛选`ProtectedResourceArns: ["*"]`，但不能同时使用两者。  
类型：字符串数组  
必需：否

 ** ProtectedResourceConditions **   <a name="Backup-Type-RestoreTestingSelectionForCreate-ProtectedResourceConditions"></a>
如果您在中包含了通配符 ProtectedResourceArns，则可以包括资源条件，例如`ProtectedResourceConditions: { StringEquals: [{ key: "XXXX", value: "YYYY" }]`。  
类型：[ProtectedResourceConditions](API_ProtectedResourceConditions.md) 对象  
必需：否

 ** RestoreMetadataOverrides **   <a name="Backup-Type-RestoreTestingSelectionForCreate-RestoreMetadataOverrides"></a>
您可以通过在 `RestoreTestingSelection` 的正文中添加参数 `RestoreMetadataOverrides` 来覆盖某些还原元数据键。键值不区分大小写。  
请参阅[还原测试推断出的元数据](https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-testing-inferred-metadata.html)的完整列表。  
类型：字符串到字符串映射  
必需：否

 ** ValidationWindowHours **   <a name="Backup-Type-RestoreTestingSelectionForCreate-ValidationWindowHours"></a>
这是可用于对数据运行验证脚本的小时数（0 到 168）。在验证脚本完成时或指定保留期结束时（以先到者为准），数据将被删除。  
类型：整数  
必需：否

## 另请参阅
<a name="API_RestoreTestingSelectionForCreate_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreTestingSelectionForCreate) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreTestingSelectionForCreate) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreTestingSelectionForCreate) 

# RestoreTestingSelectionForGet
<a name="API_RestoreTestingSelectionForGet"></a>

其中包含有关特定还原测试选择的元数据。

## 内容
<a name="API_RestoreTestingSelectionForGet_Contents"></a>

 ** CreationTime **   <a name="Backup-Type-RestoreTestingSelectionForGet-CreationTime"></a>
还原测试选择的创建日期和时间，以 Unix 格式和世界标准时间（UTC）格式表示。`CreationTime` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
是否必需：是

 ** IamRoleArn **   <a name="Backup-Type-RestoreTestingSelectionForGet-IamRoleArn"></a>
 AWS Backup 用于创建目标资源的 IAM 角色的 Amazon 资源名称 (ARN)；例如：`arn:aws:iam::123456789012:role/S3Access`  
类型：字符串  
是否必需：是

 ** ProtectedResourceType **   <a name="Backup-Type-RestoreTestingSelectionForGet-ProtectedResourceType"></a>
资源测试选项中包含的 AWS 资源类型；例如，Amazon EBS 卷或 Amazon RDS 数据库。  
类型：字符串  
是否必需：是

 ** RestoreTestingPlanName **   <a name="Backup-Type-RestoreTestingSelectionForGet-RestoreTestingPlanName"></a>
 RestoreTestingPlanName 是一个唯一的字符串，是还原测试计划的名称。  
类型：字符串  
是否必需：是

 ** RestoreTestingSelectionName **   <a name="Backup-Type-RestoreTestingSelectionForGet-RestoreTestingSelectionName"></a>
属于相关还原测试计划的还原测试选择的唯一名称。  
名称只能包含字母数字字符和下划线。最大长度为 50。  
类型：字符串  
是否必需：是

 ** CreatorRequestId **   <a name="Backup-Type-RestoreTestingSelectionForGet-CreatorRequestId"></a>
这用于标识请求并允许重试失败的请求，而不存在两次运行操作的风险。如果请求中包含与现有备份计划匹配的 `CreatorRequestId`，则会返回该计划。此参数为可选的。  
如果使用，则此参数必须包含 1 到 50 个字母数字或“-\$1.” 字符。  
类型：字符串  
必需：否

 ** ProtectedResourceArns **   <a name="Backup-Type-RestoreTestingSelectionForGet-ProtectedResourceArns"></a>
您可以包括特定的通配符 ARNs，例如`ProtectedResourceArns: ["arn:aws:...", "arn:aws:..."]`也可以包含通配符:`ProtectedResourceArns: ["*"]`，但不能同时包含两者。  
类型：字符串数组  
必需：否

 ** ProtectedResourceConditions **   <a name="Backup-Type-RestoreTestingSelectionForGet-ProtectedResourceConditions"></a>
在资源测试选项中，此参数按特定条件（例如 `StringEquals` 或 `StringNotEquals`）进行筛选。  
类型：[ProtectedResourceConditions](API_ProtectedResourceConditions.md) 对象  
必需：否

 ** RestoreMetadataOverrides **   <a name="Backup-Type-RestoreTestingSelectionForGet-RestoreMetadataOverrides"></a>
您可以通过在 `RestoreTestingSelection` 的正文中添加参数 `RestoreMetadataOverrides` 来覆盖某些还原元数据键。键值不区分大小写。  
请参阅[还原测试推断出的元数据](https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-testing-inferred-metadata.html)的完整列表。  
类型：字符串到字符串映射  
必需：否

 ** ValidationWindowHours **   <a name="Backup-Type-RestoreTestingSelectionForGet-ValidationWindowHours"></a>
这是可用于对数据运行验证脚本的小时数（1 到 168）。在验证脚本完成时或指定保留期结束时（以先到者为准），数据将被删除。  
类型：整数  
必需：否

## 另请参阅
<a name="API_RestoreTestingSelectionForGet_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreTestingSelectionForGet) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreTestingSelectionForGet) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreTestingSelectionForGet) 

# RestoreTestingSelectionForList
<a name="API_RestoreTestingSelectionForList"></a>

其中包含有关特定还原测试选择的元数据。

## 内容
<a name="API_RestoreTestingSelectionForList_Contents"></a>

 ** CreationTime **   <a name="Backup-Type-RestoreTestingSelectionForList-CreationTime"></a>
还原测试选择的创建日期和时间，以 Unix 格式和世界标准时间（UTC）格式表示。`CreationTime` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
是否必需：是

 ** IamRoleArn **   <a name="Backup-Type-RestoreTestingSelectionForList-IamRoleArn"></a>
 AWS Backup 用于创建目标资源的 IAM 角色的 Amazon 资源名称 (ARN)；例如：`arn:aws:iam::123456789012:role/S3Access`  
类型：字符串  
是否必需：是

 ** ProtectedResourceType **   <a name="Backup-Type-RestoreTestingSelectionForList-ProtectedResourceType"></a>
还原测试选项中包含的 AWS 资源类型；例如，Amazon EBS 卷或 Amazon RDS 数据库。  
类型：字符串  
是否必需：是

 ** RestoreTestingPlanName **   <a name="Backup-Type-RestoreTestingSelectionForList-RestoreTestingPlanName"></a>
唯一的字符串，即还原测试计划的名称。  
名称一经创建便无法更改。名称只能包含字母数字字符和下划线。最大长度为 50。  
类型：字符串  
是否必需：是

 ** RestoreTestingSelectionName **   <a name="Backup-Type-RestoreTestingSelectionForList-RestoreTestingSelectionName"></a>
还原测试选择的唯一名称。  
名称只能包含字母数字字符和下划线。最大长度为 50。  
类型：字符串  
是否必需：是

 ** ValidationWindowHours **   <a name="Backup-Type-RestoreTestingSelectionForList-ValidationWindowHours"></a>
此值表示在还原测试之后数据会保留的时间（以小时为单位），以便可以完成可选的验证。  
接受的值是 0 到 168（即七天的小时数）之间的整数。  
类型：整数  
必需：否

## 另请参阅
<a name="API_RestoreTestingSelectionForList_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreTestingSelectionForList) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreTestingSelectionForList) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreTestingSelectionForList) 

# RestoreTestingSelectionForUpdate
<a name="API_RestoreTestingSelectionForUpdate"></a>

其中包含有关特定还原测试选择的元数据。

## 目录
<a name="API_RestoreTestingSelectionForUpdate_Contents"></a>

 ** IamRoleArn **   <a name="Backup-Type-RestoreTestingSelectionForUpdate-IamRoleArn"></a>
AWS Backup 用于创建目标资源的 IAM 角色的 Amazon 资源名称 (ARN)；例如：`arn:aws:iam::123456789012:role/S3Access`  
类型：字符串  
必需：否

 ** ProtectedResourceArns **   <a name="Backup-Type-RestoreTestingSelectionForUpdate-ProtectedResourceArns"></a>
您可以包括特定的 ARN（例如 `ProtectedResourceArns: ["arn:aws:...", "arn:aws:..."]`），也可以包括通配符 `ProtectedResourceArns: ["*"]`，但不能同时包括这两者。  
类型：字符串数组  
必需：否

 ** ProtectedResourceConditions **   <a name="Backup-Type-RestoreTestingSelectionForUpdate-ProtectedResourceConditions"></a>
您使用标签为还原测试计划中的资源定义的条件。  
类型：[ProtectedResourceConditions](API_ProtectedResourceConditions.md) 对象  
必需：否

 ** RestoreMetadataOverrides **   <a name="Backup-Type-RestoreTestingSelectionForUpdate-RestoreMetadataOverrides"></a>
您可以通过在 `RestoreTestingSelection` 的正文中添加参数 `RestoreMetadataOverrides` 来覆盖某些还原元数据键。键值不区分大小写。  
请参阅[还原测试推断出的元数据](https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-testing-inferred-metadata.html)的完整列表。  
类型：字符串到字符串映射  
必需：否

 ** ValidationWindowHours **   <a name="Backup-Type-RestoreTestingSelectionForUpdate-ValidationWindowHours"></a>
此值表示在还原测试之后数据会保留的时间（以小时为单位），以便可以完成可选的验证。  
接受的值是 0 到 168（即七天的小时数）之间的整数。  
类型：整数  
必需：否

## 另请参阅
<a name="API_RestoreTestingSelectionForUpdate_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreTestingSelectionForUpdate) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreTestingSelectionForUpdate) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreTestingSelectionForUpdate) 

# ScanAction
<a name="API_ScanAction"></a>

定义扫描操作，用于指定要使用的恶意软件扫描程序和扫描模式。

## 内容
<a name="API_ScanAction_Contents"></a>

 ** MalwareScanner **   <a name="Backup-Type-ScanAction-MalwareScanner"></a>
用于扫描操作的恶意软件扫描程序。目前仅支持 `GUARDDUTY`。  
类型：字符串  
有效值：`GUARDDUTY`  
必需：否

 ** ScanMode **   <a name="Backup-Type-ScanAction-ScanMode"></a>
用于扫描操作的扫描模式。  
有效值：`FULL_SCAN` \$1 `INCREMENTAL_SCAN`。  
类型：字符串  
有效值：`FULL_SCAN | INCREMENTAL_SCAN`  
必需：否

## 另请参阅
<a name="API_ScanAction_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ScanAction) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ScanAction) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ScanAction) 

# ScanJob
<a name="API_ScanJob"></a>

包含有关扫描任务的元数据，包括有关扫描过程、结果和关联资源的信息。

## 内容
<a name="API_ScanJob_Contents"></a>

 ** AccountId **   <a name="Backup-Type-ScanJob-AccountId"></a>
拥有扫描任务的账户 ID。  
类型：字符串  
是否必需：是

 ** BackupVaultArn **   <a name="Backup-Type-ScanJob-BackupVaultArn"></a>
唯一标识备份保管库的 Amazon 资源名称 (ARN)；例如，`arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`。  
类型：字符串  
是否必需：是

 ** BackupVaultName **   <a name="Backup-Type-ScanJob-BackupVaultName"></a>
用于存储备份的逻辑容器的名称。备份保管库的名称在创建它们的账户和创建它们的 AWS 区域中是唯一的。  
类型：字符串  
是否必需：是

 ** CreatedBy **   <a name="Backup-Type-ScanJob-CreatedBy"></a>
包含有关创建扫描任务的识别信息。  
类型：[ScanJobCreator](API_ScanJobCreator.md) 对象  
是否必需：是

 ** CreationDate **   <a name="Backup-Type-ScanJob-CreationDate"></a>
创建扫描任务的日期和时间，采用 Unix 格式和协调世界时 (UTC)。`CreationDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
是否必需：是

 ** IamRoleArn **   <a name="Backup-Type-ScanJob-IamRoleArn"></a>
指定用于创建扫描任务的 IAM 角色 ARN；例如。`arn:aws:iam::123456789012:role/S3Access`  
类型：字符串  
是否必需：是

 ** MalwareScanner **   <a name="Backup-Type-ScanJob-MalwareScanner"></a>
用于扫描任务的扫描引擎。目前仅支持 `GUARDDUTY`。  
类型：字符串  
有效值：`GUARDDUTY`  
是否必需：是

 ** RecoveryPointArn **   <a name="Backup-Type-ScanJob-RecoveryPointArn"></a>
用于唯一标识正在扫描的恢复点的 ARN；例如，。`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`  
类型：字符串  
是否必需：是

 ** ResourceArn **   <a name="Backup-Type-ScanJob-ResourceArn"></a>
一个 ARN，用于唯一标识正在扫描的恢复点的源资源。  
类型：字符串  
是否必需：是

 ** ResourceName **   <a name="Backup-Type-ScanJob-ResourceName"></a>
属于指定备份的资源的非唯一名称。  
类型：字符串  
是否必需：是

 ** ResourceType **   <a name="Backup-Type-ScanJob-ResourceType"></a>
正在扫描的 AWS 资源类型；例如，亚马逊弹性区块存储 (Amazon EBS) Block Store 卷或亚马逊关系数据库服务 (Amazon RDS) 数据库。  
类型：字符串  
有效值：`EBS | EC2 | S3`  
是否必需：是

 ** ScanJobId **   <a name="Backup-Type-ScanJob-ScanJobId"></a>
用于标识扫描任务请求的唯一标识符 AWS Backup。  
类型：字符串  
是否必需：是

 ** ScanMode **   <a name="Backup-Type-ScanJob-ScanMode"></a>
指定扫描作业使用的扫描类型。  
包含：  
 `FULL_SCAN`将扫描备份中的整个数据谱系。  
 `INCREMENTAL_SCAN`将扫描目标恢复点和基本恢复点 ARN 之间的数据差异。  
类型：字符串  
有效值：`FULL_SCAN | INCREMENTAL_SCAN`  
是否必需：是

 ** ScannerRoleArn **   <a name="Backup-Type-ScanJob-ScannerRoleArn"></a>
指定用于扫描任务的扫描器 IAM 角色 ARN。  
类型：字符串  
是否必需：是

 ** CompletionDate **   <a name="Backup-Type-ScanJob-CompletionDate"></a>
扫描任务完成的日期和时间，采用 Unix 格式和协调世界时 (UTC)。`CompletionDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** ScanBaseRecoveryPointArn **   <a name="Backup-Type-ScanJob-ScanBaseRecoveryPointArn"></a>
一个 ARN，用于唯一标识扫描的基本恢复点。执行增量扫描任务后，将填充此字段。  
类型：字符串  
必需：否

 ** ScanId **   <a name="Backup-Type-ScanJob-ScanId"></a>
恶意软件扫描程序为相应扫描任务生成的扫描 ID。  
类型：字符串  
必需：否

 ** ScanResult **   <a name="Backup-Type-ScanJob-ScanResult"></a>
包含扫描结果信息，包括扫描期间发现的威胁的状态。  
类型：[ScanResultInfo](API_ScanResultInfo.md) 对象  
必需：否

 ** State **   <a name="Backup-Type-ScanJob-State"></a>
扫描任务的当前状态。  
有效值：`CREATED`\$1 `RUNNING` \$1 `COMPLETED` \$1 `COMPLETED_WITH_ISSUES` \$1 `FAILED` \$1 `CANCELED`。  
类型：字符串  
有效值：`CANCELED | COMPLETED | COMPLETED_WITH_ISSUES | CREATED | FAILED | RUNNING`  
必需：否

 ** StatusMessage **   <a name="Backup-Type-ScanJob-StatusMessage"></a>
解释扫描任务状态的详细消息。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_ScanJob_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ScanJob) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ScanJob) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ScanJob) 

# ScanJobCreator
<a name="API_ScanJobCreator"></a>

包含有关创建扫描任务的识别信息，包括启动扫描的备份计划和规则。

## 内容
<a name="API_ScanJobCreator_Contents"></a>

 ** BackupPlanArn **   <a name="Backup-Type-ScanJobCreator-BackupPlanArn"></a>
唯一标识备份计划的 Amazon 资源名称 (ARN)；例如，`arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50`。  
类型：字符串  
是否必需：是

 ** BackupPlanId **   <a name="Backup-Type-ScanJobCreator-BackupPlanId"></a>
备份计划的 ID。  
类型：字符串  
是否必需：是

 ** BackupPlanVersion **   <a name="Backup-Type-ScanJobCreator-BackupPlanVersion"></a>
唯一的、随机生成的、Unicode、UTF-8 编码字符串，长度最大为 1024 个字节。版本 IDs 无法编辑。  
类型：字符串  
是否必需：是

 ** BackupRuleId **   <a name="Backup-Type-ScanJobCreator-BackupRuleId"></a>
唯一标识启动扫描任务的备份规则。  
类型：字符串  
必需：是

## 另请参阅
<a name="API_ScanJobCreator_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ScanJobCreator) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ScanJobCreator) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ScanJobCreator) 

# ScanJobSummary
<a name="API_ScanJobSummary"></a>

包含有关扫描任务的摘要信息，包括特定时间段和标准的计数和元数据。

## 内容
<a name="API_ScanJobSummary_Contents"></a>

 ** AccountId **   <a name="Backup-Type-ScanJobSummary-AccountId"></a>
拥有此摘要中包含的扫描任务的账户 ID。  
类型：字符串  
模式：`^[0-9]{12}$`  
必需：否

 ** Count **   <a name="Backup-Type-ScanJobSummary-Count"></a>
符合指定条件的扫描任务数量。  
类型：整数  
必需：否

 ** EndTime **   <a name="Backup-Type-ScanJobSummary-EndTime"></a>
以数字格式表示的作业结束时间值。  
该值是采用 Unix 格式表示的时间，它是世界标准时间 (UTC)，精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** MalwareScanner **   <a name="Backup-Type-ScanJobSummary-MalwareScanner"></a>
指定扫描作业期间使用的恶意软件扫描程序。目前仅支持`GUARDDUTY`。  
类型：字符串  
有效值：`GUARDDUTY`  
必需：否

 ** Region **   <a name="Backup-Type-ScanJobSummary-Region"></a>
执行扫描任务的 AWS 区域。  
类型：字符串  
必需：否

 ** ResourceType **   <a name="Backup-Type-ScanJobSummary-ResourceType"></a>
此摘要中包含的扫描任务的 AWS 资源类型。  
类型：字符串  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
必需：否

 ** ScanResultStatus **   <a name="Backup-Type-ScanJobSummary-ScanResultStatus"></a>
此摘要中包含的扫描任务的扫描结果状态。  
有效值：`THREATS_FOUND` \$1 `NO_THREATS_FOUND`。  
类型：字符串  
有效值：`NO_THREATS_FOUND | THREATS_FOUND`  
必需：否

 ** StartTime **   <a name="Backup-Type-ScanJobSummary-StartTime"></a>
以数字格式表示的作业开始时间值。  
该值是采用 Unix 格式表示的时间，它是世界标准时间 (UTC)，精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** State **   <a name="Backup-Type-ScanJobSummary-State"></a>
此摘要中包含的扫描任务的状态。  
有效值：`CREATED`\$1 `RUNNING` \$1 `COMPLETED` \$1 `COMPLETED_WITH_ISSUES` \$1 `FAILED` \$1 `CANCELED`。  
类型：字符串  
有效值：`CREATED | COMPLETED | COMPLETED_WITH_ISSUES | RUNNING | FAILED | CANCELED | AGGREGATE_ALL | ANY`  
必需：否

## 另请参阅
<a name="API_ScanJobSummary_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ScanJobSummary) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ScanJobSummary) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ScanJobSummary) 

# ScanResult
<a name="API_ScanResult"></a>

包含安全扫描的结果，包括扫描仪信息、扫描状态和发现的任何发现。

## 内容
<a name="API_ScanResult_Contents"></a>

 ** Findings **   <a name="Backup-Type-ScanResult-Findings"></a>
扫描期间发现的一系列发现。  
类型：字符串数组  
有效值：`MALWARE`  
必需：否

 ** LastScanTimestamp **   <a name="Backup-Type-ScanResult-LastScanTimestamp"></a>
上次执行扫描的时间戳，采用 Unix 格式和协调世界时 (UTC)。  
类型：时间戳  
必需：否

 ** MalwareScanner **   <a name="Backup-Type-ScanResult-MalwareScanner"></a>
用于执行扫描的恶意软件扫描程序。目前仅支持 `GUARDDUTY`。  
类型：字符串  
有效值：`GUARDDUTY`  
必需：否

 ** ScanJobState **   <a name="Backup-Type-ScanResult-ScanJobState"></a>
扫描任务的最终状态。  
有效值：`COMPLETED` \$1 `FAILED` \$1 `CANCELED`。  
类型：字符串  
有效值：`COMPLETED | COMPLETED_WITH_ISSUES | FAILED | CANCELED`  
必需：否

## 另请参阅
<a name="API_ScanResult_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ScanResult) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ScanResult) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ScanResult) 

# ScanResultInfo
<a name="API_ScanResultInfo"></a>

包含有关扫描任务结果的信息。

## 内容
<a name="API_ScanResultInfo_Contents"></a>

 ** ScanResultStatus **   <a name="Backup-Type-ScanResultInfo-ScanResultStatus"></a>
扫描结果的状态。  
有效值：`THREATS_FOUND` \$1 `NO_THREATS_FOUND`。  
类型：字符串  
有效值：`NO_THREATS_FOUND | THREATS_FOUND`  
是否必需：是

## 另请参阅
<a name="API_ScanResultInfo_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ScanResultInfo) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ScanResultInfo) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ScanResultInfo) 

# ScanSetting
<a name="API_ScanSetting"></a>

包含恶意软件扫描的配置设置，包括扫描器类型、目标资源类型和扫描器角色。

## 内容
<a name="API_ScanSetting_Contents"></a>

 ** MalwareScanner **   <a name="Backup-Type-ScanSetting-MalwareScanner"></a>
用于扫描的恶意软件扫描程序。目前仅支持 `GUARDDUTY`。  
类型：字符串  
有效值：`GUARDDUTY`  
必需：否

 ** ResourceTypes **   <a name="Backup-Type-ScanSetting-ResourceTypes"></a>
一系列要扫描恶意软件的资源类型。  
类型：字符串数组  
模式：`^[a-zA-Z0-9\-\_\.]{1,50}$`  
必需：否

 ** ScannerRoleArn **   <a name="Backup-Type-ScanSetting-ScannerRoleArn"></a>
扫描器用于访问资源的 IAM 角色的 Amazon 资源名称 (ARN)；例如，。`arn:aws:iam::123456789012:role/ScannerRole`  
类型：字符串  
必需：否

## 另请参阅
<a name="API_ScanSetting_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ScanSetting) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ScanSetting) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ScanSetting) 

# ScheduledPlanExecutionMember
<a name="API_ScheduledPlanExecutionMember"></a>

包含有关计划的备份计划执行的信息，包括执行时间、规则类型和关联的规则标识符。

## 目录
<a name="API_ScheduledPlanExecutionMember_Contents"></a>

 ** ExecutionTime **   <a name="Backup-Type-ScheduledPlanExecutionMember-ExecutionTime"></a>
计划运行备份的时间戳，采用 Unix 时间格式和协调世界时（UTC）。值精确到毫秒。  
类型：时间戳  
必需：否

 ** RuleExecutionType **   <a name="Backup-Type-ScheduledPlanExecutionMember-RuleExecutionType"></a>
备份规则执行的类型。有效值为 `CONTINUOUS`（时间点恢复）、`SNAPSHOTS`（快照备份）或 `CONTINUOUS_AND_SNAPSHOTS`（两种类型结合）。  
类型：字符串  
有效值：`CONTINUOUS | SNAPSHOTS | CONTINUOUS_AND_SNAPSHOTS`  
必需：否

 ** RuleId **   <a name="Backup-Type-ScheduledPlanExecutionMember-RuleId"></a>
将在计划时间执行的备份规则的唯一标识符。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_ScheduledPlanExecutionMember_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ScheduledPlanExecutionMember) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ScheduledPlanExecutionMember) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ScheduledPlanExecutionMember) 

# TieringConfiguration
<a name="API_TieringConfiguration"></a>

它包含有关分层配置的元数据。

## 内容
<a name="API_TieringConfiguration_Contents"></a>

 ** BackupVaultName **   <a name="Backup-Type-TieringConfiguration-BackupVaultName"></a>
应用分层配置的备份存储库的名称。用于应用`*`于所有备份存储库。  
类型：字符串  
模式：`^(\*|[a-zA-Z0-9\-\_]{2,50})$`  
是否必需：是

 ** ResourceSelection **   <a name="Backup-Type-TieringConfiguration-ResourceSelection"></a>
一组资源选择对象，用于指定分层配置中包含哪些资源及其分层设置。  
类型：[ResourceSelection](API_ResourceSelection.md) 对象数组  
是否必需：是

 ** TieringConfigurationName **   <a name="Backup-Type-TieringConfiguration-TieringConfigurationName"></a>
分层配置的唯一名称。创建后无法对其进行更改，并且只能由字母数字字符和下划线组成。  
类型：字符串  
模式：`^[a-zA-Z0-9_]{1,200}$`  
是否必需：是

 ** CreationTime **   <a name="Backup-Type-TieringConfiguration-CreationTime"></a>
分层配置的创建日期和时间，采用 Unix 格式和协调世界时 (UTC)。`CreationTime` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** CreatorRequestId **   <a name="Backup-Type-TieringConfiguration-CreatorRequestId"></a>
这是一个唯一的字符串，用于标识请求并允许重试失败的请求，而不会有运行两次操作的风险。  
类型：字符串  
必需：否

 ** LastUpdatedTime **   <a name="Backup-Type-TieringConfiguration-LastUpdatedTime"></a>
分层配置的更新日期和时间，采用 Unix 格式和协调世界时 (UTC)。`LastUpdatedTime` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** TieringConfigurationArn **   <a name="Backup-Type-TieringConfiguration-TieringConfigurationArn"></a>
唯一标识分层配置的 Amazon 资源名称 (ARN)。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_TieringConfiguration_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/TieringConfiguration) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/TieringConfiguration) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/TieringConfiguration) 

# TieringConfigurationInputForCreate
<a name="API_TieringConfigurationInputForCreate"></a>

它包含有关创建操作的分层配置的元数据。

## 内容
<a name="API_TieringConfigurationInputForCreate_Contents"></a>

 ** BackupVaultName **   <a name="Backup-Type-TieringConfigurationInputForCreate-BackupVaultName"></a>
应用分层配置的备份存储库的名称。用于应用`*`于所有备份存储库。  
类型：字符串  
模式：`^(\*|[a-zA-Z0-9\-\_]{2,50})$`  
是否必需：是

 ** ResourceSelection **   <a name="Backup-Type-TieringConfigurationInputForCreate-ResourceSelection"></a>
一组资源选择对象，用于指定分层配置中包含哪些资源及其分层设置。  
类型：[ResourceSelection](API_ResourceSelection.md) 对象数组  
是否必需：是

 ** TieringConfigurationName **   <a name="Backup-Type-TieringConfigurationInputForCreate-TieringConfigurationName"></a>
分层配置的唯一名称。创建后无法对其进行更改，并且只能由字母数字字符和下划线组成。  
类型：字符串  
模式：`^[a-zA-Z0-9_]{1,200}$`  
必需：是

## 另请参阅
<a name="API_TieringConfigurationInputForCreate_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/TieringConfigurationInputForCreate) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/TieringConfigurationInputForCreate) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/TieringConfigurationInputForCreate) 

# TieringConfigurationInputForUpdate
<a name="API_TieringConfigurationInputForUpdate"></a>

它包含有关更新操作分层配置的元数据。

## 内容
<a name="API_TieringConfigurationInputForUpdate_Contents"></a>

 ** BackupVaultName **   <a name="Backup-Type-TieringConfigurationInputForUpdate-BackupVaultName"></a>
应用分层配置的备份存储库的名称。用于应用`*`于所有备份存储库。  
类型：字符串  
模式：`^(\*|[a-zA-Z0-9\-\_]{2,50})$`  
是否必需：是

 ** ResourceSelection **   <a name="Backup-Type-TieringConfigurationInputForUpdate-ResourceSelection"></a>
一组资源选择对象，用于指定分层配置中包含哪些资源及其分层设置。  
类型：[ResourceSelection](API_ResourceSelection.md) 对象数组  
是否必需：是

## 另请参阅
<a name="API_TieringConfigurationInputForUpdate_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/TieringConfigurationInputForUpdate) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/TieringConfigurationInputForUpdate) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/TieringConfigurationInputForUpdate) 

# TieringConfigurationsListMember
<a name="API_TieringConfigurationsListMember"></a>

它包含列表中返回的有关分层配置的元数据。

## 内容
<a name="API_TieringConfigurationsListMember_Contents"></a>

 ** BackupVaultName **   <a name="Backup-Type-TieringConfigurationsListMember-BackupVaultName"></a>
应用分层配置的备份存储库的名称。用于应用`*`于所有备份存储库。  
类型：字符串  
模式：`^(\*|[a-zA-Z0-9\-\_]{2,50})$`  
必需：否

 ** CreationTime **   <a name="Backup-Type-TieringConfigurationsListMember-CreationTime"></a>
分层配置的创建日期和时间，采用 Unix 格式和协调世界时 (UTC)。`CreationTime` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** LastUpdatedTime **   <a name="Backup-Type-TieringConfigurationsListMember-LastUpdatedTime"></a>
分层配置的更新日期和时间，采用 Unix 格式和协调世界时 (UTC)。`LastUpdatedTime` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。  
类型：时间戳  
必需：否

 ** TieringConfigurationArn **   <a name="Backup-Type-TieringConfigurationsListMember-TieringConfigurationArn"></a>
唯一标识分层配置的 Amazon 资源名称 (ARN)。  
类型：字符串  
必需：否

 ** TieringConfigurationName **   <a name="Backup-Type-TieringConfigurationsListMember-TieringConfigurationName"></a>
分层配置的唯一名称。  
类型：字符串  
模式：`^[a-zA-Z0-9_]{1,200}$`  
必需：否

## 另请参阅
<a name="API_TieringConfigurationsListMember_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/TieringConfigurationsListMember) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/TieringConfigurationsListMember) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/TieringConfigurationsListMember) 

# AWS Backup gateway
<a name="API_Types_AWS_Backup_Gateway"></a>

AWS Backup gateway 支持以下数据类型：
+  [BandwidthRateLimitInterval](API_BGW_BandwidthRateLimitInterval.md) 
+  [Gateway](API_BGW_Gateway.md) 
+  [GatewayDetails](API_BGW_GatewayDetails.md) 
+  [Hypervisor](API_BGW_Hypervisor.md) 
+  [HypervisorDetails](API_BGW_HypervisorDetails.md) 
+  [MaintenanceStartTime](API_BGW_MaintenanceStartTime.md) 
+  [Tag](API_BGW_Tag.md) 
+  [VirtualMachine](API_BGW_VirtualMachine.md) 
+  [VirtualMachineDetails](API_BGW_VirtualMachineDetails.md) 
+  [VmwareTag](API_BGW_VmwareTag.md) 
+  [VmwareToAwsTagMapping](API_BGW_VmwareToAwsTagMapping.md) 

# BandwidthRateLimitInterval
<a name="API_BGW_BandwidthRateLimitInterval"></a>

描述网关的带宽速率限制间隔。带宽速率限制计划由一个或多个带宽速率限制间隔组成。带宽速率限制间隔定义一周中一天或多天的一段时间，在此期间为上传指定带宽速率限制。

## 内容
<a name="API_BGW_BandwidthRateLimitInterval_Contents"></a>

 ** DaysOfWeek **   <a name="Backup-Type-BGW_BandwidthRateLimitInterval-DaysOfWeek"></a>
带宽速率限制间隔的星期几组成部分，用从 0 到 6 的序数表示，其中 0 表示星期日，6 表示星期六。  
类型：整数数组  
数组成员：最少 1 个物品。最多 7 个项目。  
有效范围：最小值为 0。最大值为 6。  
是否必需：是

 ** EndHourOfDay **   <a name="Backup-Type-BGW_BandwidthRateLimitInterval-EndHourOfDay"></a>
一天中结束带宽速率限制间隔的小时时间。  
类型：整数  
有效范围：最小值为 0。最大值为 23。  
是否必需：是

 ** EndMinuteOfHour **   <a name="Backup-Type-BGW_BandwidthRateLimitInterval-EndMinuteOfHour"></a>
一小时中结束带宽速率限制间隔的分钟时间。  
带宽速率限制间隔在分钟结束时结束。要在小时结束时结束间隔，请使用值 `59`。
类型：整数  
有效范围：最小值为 0。最大值为 59。  
是否必需：是

 ** StartHourOfDay **   <a name="Backup-Type-BGW_BandwidthRateLimitInterval-StartHourOfDay"></a>
一天中开始带宽速率限制间隔的小时时间。  
类型：整数  
有效范围：最小值为 0。最大值为 23。  
是否必需：是

 ** StartMinuteOfHour **   <a name="Backup-Type-BGW_BandwidthRateLimitInterval-StartMinuteOfHour"></a>
一小时中开始带宽速率限制间隔的分钟时间。间隔从该分钟开始时开始。要精确地在小时开始时段开始间隔，请使用值 `0`。  
类型：整数  
有效范围：最小值为 0。最大值为 59。  
是否必需：是

 ** AverageUploadRateLimitInBitsPerSec **   <a name="Backup-Type-BGW_BandwidthRateLimitInterval-AverageUploadRateLimitInBitsPerSec"></a>
带宽速率限制间隔的平均上传速率限制部分，以每秒位元数为单位。如果未设置上传速率限制，则此字段不会显示在响应中。  
类型：长整型  
有效范围：最小值为 51200。最大值为 8000000000000。  
必需：否

## 另请参阅
<a name="API_BGW_BandwidthRateLimitInterval_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/BandwidthRateLimitInterval) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/BandwidthRateLimitInterval) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/BandwidthRateLimitInterval) 

# Gateway
<a name="API_BGW_Gateway"></a>

网关是 AWS Backup Gateway 设备，在客户网络上运行，可提供与 AWS 云中备份存储的无缝连接。

## 目录
<a name="API_BGW_Gateway_Contents"></a>

 ** GatewayArn **   <a name="Backup-Type-BGW_Gateway-GatewayArn"></a>
网关的 Amazon 资源名称 (ARN)。使用 `ListGateways` 操作以返回账户和 AWS 区域的网关列表。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：否

 ** GatewayDisplayName **   <a name="Backup-Type-BGW_Gateway-GatewayDisplayName"></a>
网关的显示名称。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[a-zA-Z0-9-]*`  
必需：否

 ** GatewayType **   <a name="Backup-Type-BGW_Gateway-GatewayType"></a>
网关的类型。  
类型：字符串  
有效值：`BACKUP_VM`  
必需：否

 ** HypervisorId **   <a name="Backup-Type-BGW_Gateway-HypervisorId"></a>
网关的管理程序 ID。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
必需：否

 ** LastSeenTime **   <a name="Backup-Type-BGW_Gateway-LastSeenTime"></a>
AWS Backup 网关上次与网关通信的时间，采用 Unix 格式和 UTC 时间。  
类型：时间戳  
必需：否

## 另请参阅
<a name="API_BGW_Gateway_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/Gateway) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/Gateway) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/Gateway) 

# GatewayDetails
<a name="API_BGW_GatewayDetails"></a>

网关的详细信息。

## 内容
<a name="API_BGW_GatewayDetails_Contents"></a>

 ** DeprecationDate **   <a name="Backup-Type-BGW_GatewayDetails-DeprecationDate"></a>
在此日期之后，此网关将无法收到有关新功能和错误修复的软件更新。  
类型：时间戳  
必需：否

 ** GatewayArn **   <a name="Backup-Type-BGW_GatewayDetails-GatewayArn"></a>
网关的 Amazon 资源名称 (ARN)。使用 `ListGateways` 操作以返回账户和 AWS 区域的网关列表。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：否

 ** GatewayDisplayName **   <a name="Backup-Type-BGW_GatewayDetails-GatewayDisplayName"></a>
网关的显示名称。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[a-zA-Z0-9-]*`  
必需：否

 ** GatewayType **   <a name="Backup-Type-BGW_GatewayDetails-GatewayType"></a>
网关的类型。  
类型：字符串  
有效值：`BACKUP_VM`  
必需：否

 ** HypervisorId **   <a name="Backup-Type-BGW_GatewayDetails-HypervisorId"></a>
网关的管理程序 ID。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
必需：否

 ** LastSeenTime **   <a name="Backup-Type-BGW_GatewayDetails-LastSeenTime"></a>
详细信息以 Unix 格式和 UTC 时间显示 AWS Backup 网关上次与云端通信的时间。  
类型：时间戳  
必需：否

 ** MaintenanceStartTime **   <a name="Backup-Type-BGW_GatewayDetails-MaintenanceStartTime"></a>
返回网关每周维护的起始时间信息，包括星期几以及时间。请注意，这些值采用网关时区的时间。可以是每周或每月。  
类型：[MaintenanceStartTime](API_BGW_MaintenanceStartTime.md) 对象  
必需：否

 ** NextUpdateAvailabilityTime **   <a name="Backup-Type-BGW_GatewayDetails-NextUpdateAvailabilityTime"></a>
显示网关下次更新可用时间的详细信息。  
类型：时间戳  
必需：否

 ** SoftwareVersion **   <a name="Backup-Type-BGW_GatewayDetails-SoftwareVersion"></a>
在网关设备上运行的软件的版本号。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[a-zA-Z0-9-]*`  
必需：否

 ** VpcEndpoint **   <a name="Backup-Type-BGW_GatewayDetails-VpcEndpoint"></a>
网关用来连接到云作为备份网关的虚拟私有云 (VPC） 端点的 DNS 名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。  
必需：否

## 另请参阅
<a name="API_BGW_GatewayDetails_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GatewayDetails) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GatewayDetails) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/GatewayDetails) 

# Hypervisor
<a name="API_BGW_Hypervisor"></a>

表示网关将要连接到的管理程序的权限。

管理程序是用于创建和管理虚拟机并为其分配资源的硬件、软件或固件。

## 目录
<a name="API_BGW_Hypervisor_Contents"></a>

 ** Host **   <a name="Backup-Type-BGW_Hypervisor-Host"></a>
管理程序的服务器主机。这可以是 IP 地址或完全限定域名 (FQDN)。  
类型：字符串  
长度约束：最小长度为 3。最大长度为 128。  
模式：`.+`  
必需：否

 ** HypervisorArn **   <a name="Backup-Type-BGW_Hypervisor-HypervisorArn"></a>
管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：否

 ** KmsKeyArn **   <a name="Backup-Type-BGW_Hypervisor-KmsKeyArn"></a>
用于加密管理程序的 AWS Key Management Service 的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`(^arn:(aws|aws-cn|aws-us-gov):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)`  
必需：否

 ** Name **   <a name="Backup-Type-BGW_Hypervisor-Name"></a>
管理程序的名称。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[a-zA-Z0-9-]*`  
必需：否

 ** State **   <a name="Backup-Type-BGW_Hypervisor-State"></a>
管理程序的状态。  
类型：字符串  
有效值：`PENDING | ONLINE | OFFLINE | ERROR`  
必需：否

## 另请参阅
<a name="API_BGW_Hypervisor_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/Hypervisor) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/Hypervisor) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/Hypervisor) 

# HypervisorDetails
<a name="API_BGW_HypervisorDetails"></a>

这些是指定管理程序的详细信息。管理程序是用于创建和管理虚拟机并为其分配资源的硬件、软件或固件。

## 目录
<a name="API_BGW_HypervisorDetails_Contents"></a>

 ** Host **   <a name="Backup-Type-BGW_HypervisorDetails-Host"></a>
管理程序的服务器主机。这可以是 IP 地址或完全限定域名 (FQDN)。  
类型：字符串  
长度约束：最小长度为 3。最大长度为 128。  
模式：`.+`  
必需：否

 ** HypervisorArn **   <a name="Backup-Type-BGW_HypervisorDetails-HypervisorArn"></a>
管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：否

 ** KmsKeyArn **   <a name="Backup-Type-BGW_HypervisorDetails-KmsKeyArn"></a>
用于加密管理程序的 AWS KMS 的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`(^arn:(aws|aws-cn|aws-us-gov):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)`  
必需：否

 ** LastSuccessfulMetadataSyncTime **   <a name="Backup-Type-BGW_HypervisorDetails-LastSuccessfulMetadataSyncTime"></a>
这是最近一次成功同步元数据的时间。  
类型：时间戳  
必需：否

 ** LatestMetadataSyncStatus **   <a name="Backup-Type-BGW_HypervisorDetails-LatestMetadataSyncStatus"></a>
这是指定元数据同步的最新状态。  
类型：字符串  
有效值：`CREATED | RUNNING | FAILED | PARTIALLY_FAILED | SUCCEEDED`  
必需：否

 ** LatestMetadataSyncStatusMessage **   <a name="Backup-Type-BGW_HypervisorDetails-LatestMetadataSyncStatusMessage"></a>
这是指定元数据同步的最新状态。  
类型：字符串  
必需：否

 ** LogGroupArn **   <a name="Backup-Type-BGW_HypervisorDetails-LogGroupArn"></a>
请求日志中网关组的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 0。最大长度为 2048。  
模式：`$|^arn:(aws|aws-cn|aws-us-gov):logs:([a-zA-Z0-9-]+):([0-9]+):log-group:[a-zA-Z0-9_\-\/\.]+:\*`  
必需：否

 ** Name **   <a name="Backup-Type-BGW_HypervisorDetails-Name"></a>
这是指定管理程序的名称。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[a-zA-Z0-9-]*`  
必需：否

 ** State **   <a name="Backup-Type-BGW_HypervisorDetails-State"></a>
这是指定管理程序的当前状态。  
可能的状态包括 `PENDING`、`ONLINE`、`OFFLINE` 或 `ERROR`。  
类型：字符串  
有效值：`PENDING | ONLINE | OFFLINE | ERROR`  
必需：否

## 另请参阅
<a name="API_BGW_HypervisorDetails_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/HypervisorDetails) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/HypervisorDetails) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/HypervisorDetails) 

# MaintenanceStartTime
<a name="API_BGW_MaintenanceStartTime"></a>

这是网关的每周维护开始时间，包括一周中的星期几以及时间。请注意，这些值采用网关时区的时间。可以是每周或每月。

## 目录
<a name="API_BGW_MaintenanceStartTime_Contents"></a>

 ** HourOfDay **   <a name="Backup-Type-BGW_MaintenanceStartTime-HourOfDay"></a>
维护开始时间的小时部分以 *hh* 表示，其中 *hh* 是小时数（0 到 23）。一天中的时间以网关所在的时区为准。  
类型：整数  
有效范围：最小值为 0。最大值为 23。  
必需：是

 ** MinuteOfHour **   <a name="Backup-Type-BGW_MaintenanceStartTime-MinuteOfHour"></a>
维护开始时间的分钟部分以 *mm* 表示，其中 *mm* 是分钟数（0 到 59）。小时中的分钟以网关所在的时区为准。  
类型：整数  
有效范围：最小值为 0。最大值为 59。  
必需：是

 ** DayOfMonth **   <a name="Backup-Type-BGW_MaintenanceStartTime-DayOfMonth"></a>
维护开始时间的日期的组成部分表示为从 1 到 28 的序数，其中 1 表示该月的第一天，28 表示该月的最后一天。  
类型：整数  
有效范围：最小值为 1。最大值为 31。  
必需：否

 ** DayOfWeek **   <a name="Backup-Type-BGW_MaintenanceStartTime-DayOfWeek"></a>
介于 0 和 6 之间的序数，代表一周中的某一天，其中 0 代表星期日，6 代表星期六。星期数以网关所在的时区为准。  
类型：整数  
有效范围：最小值为 0。最大值为 6。  
必需：否

## 另请参阅
<a name="API_BGW_MaintenanceStartTime_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/MaintenanceStartTime) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/MaintenanceStartTime) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/MaintenanceStartTime) 

# Tag
<a name="API_BGW_Tag"></a>

一个用于管理、筛选和搜索资源的键值对。可以使用的字符包括 UTF-8 字母、数字以及以下字符：\$1 - = . \$1 : /。标签值中不得使用空格。

## 目录
<a name="API_BGW_Tag_Contents"></a>

 ** Key **   <a name="Backup-Type-BGW_Tag-Key"></a>
标签键值对中的键部分。键不能以 `aws:` 开头。  
类型：字符串  
长度限制：长度下限为 1。最大长度为 128。  
模式：`([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`  
必需：是

 ** Value **   <a name="Backup-Type-BGW_Tag-Value"></a>
标签键值对中的值部分。  
类型：字符串  
长度约束：最小长度为 0。最大长度为 256。  
模式：`[^\x00]*`  
必需：是

## 另请参阅
<a name="API_BGW_Tag_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/Tag) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/Tag) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/Tag) 

# VirtualMachine
<a name="API_BGW_VirtualMachine"></a>

位于管理程序上的虚拟机。

## 目录
<a name="API_BGW_VirtualMachine_Contents"></a>

 ** HostName **   <a name="Backup-Type-BGW_VirtualMachine-HostName"></a>
虚拟机的主机名称。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[a-zA-Z0-9-]*`  
必需：否

 ** HypervisorId **   <a name="Backup-Type-BGW_VirtualMachine-HypervisorId"></a>
虚拟机的管理程序的 ID。  
类型：字符串  
必需：否

 ** LastBackupDate **   <a name="Backup-Type-BGW_VirtualMachine-LastBackupDate"></a>
虚拟机的最新备份日期，采用 Unix 格式和 UTC 时间。  
类型：时间戳  
必需：否

 ** Name **   <a name="Backup-Type-BGW_VirtualMachine-Name"></a>
虚拟机的名称。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[a-zA-Z0-9-]*`  
必需：否

 ** Path **   <a name="Backup-Type-BGW_VirtualMachine-Path"></a>
虚拟机的路径。  
类型：字符串  
长度限制：长度下限为 1。最大长度为 4096。  
模式：`[^\x00]+`  
必需：否

 ** ResourceArn **   <a name="Backup-Type-BGW_VirtualMachine-ResourceArn"></a>
虚拟机的 Amazon 资源名称 (ARN)。例如 `arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL`。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：否

## 另请参阅
<a name="API_BGW_VirtualMachine_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/VirtualMachine) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/VirtualMachine) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/VirtualMachine) 

# VirtualMachineDetails
<a name="API_BGW_VirtualMachineDetails"></a>

您的 `VirtualMachine` 对象，按其 Amazon 资源名称 (ARN) 排序。

## 目录
<a name="API_BGW_VirtualMachineDetails_Contents"></a>

 ** HostName **   <a name="Backup-Type-BGW_VirtualMachineDetails-HostName"></a>
虚拟机的主机名称。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[a-zA-Z0-9-]*`  
必需：否

 ** HypervisorId **   <a name="Backup-Type-BGW_VirtualMachineDetails-HypervisorId"></a>
虚拟机的管理程序的 ID。  
类型：字符串  
必需：否

 ** LastBackupDate **   <a name="Backup-Type-BGW_VirtualMachineDetails-LastBackupDate"></a>
虚拟机的最新备份日期，采用 Unix 格式和 UTC 时间。  
类型：时间戳  
必需：否

 ** Name **   <a name="Backup-Type-BGW_VirtualMachineDetails-Name"></a>
虚拟机的名称。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[a-zA-Z0-9-]*`  
必需：否

 ** Path **   <a name="Backup-Type-BGW_VirtualMachineDetails-Path"></a>
虚拟机的路径。  
类型：字符串  
长度限制：长度下限为 1。最大长度为 4096。  
模式：`[^\x00]+`  
必需：否

 ** ResourceArn **   <a name="Backup-Type-BGW_VirtualMachineDetails-ResourceArn"></a>
虚拟机的 Amazon 资源名称 (ARN)。例如 `arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL`。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：否

 ** VmwareTags **   <a name="Backup-Type-BGW_VirtualMachineDetails-VmwareTags"></a>
这些是与指定虚拟机关联的 VMware 标签的详细信息。  
类型：[VmwareTag](API_BGW_VmwareTag.md) 对象数组  
必需：否

## 另请参阅
<a name="API_BGW_VirtualMachineDetails_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/VirtualMachineDetails) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/VirtualMachineDetails) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/VirtualMachineDetails) 

# VmwareTag
<a name="API_BGW_VmwareTag"></a>

VMware 标签是附加到特定虚拟机的标签。[标签](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_Tag.html)是您可用来管理、筛选和搜索资源的键值对。

可以将 VMware 标签的内容与 AWS 标签进行匹配。

## 目录
<a name="API_BGW_VmwareTag_Contents"></a>

 ** VmwareCategory **   <a name="Backup-Type-BGW_VmwareTag-VmwareCategory"></a>
这是 VMware 的类别。  
类型：字符串  
长度限制：长度下限为 1。最大长度为 80。  
必需：否

 ** VmwareTagDescription **   <a name="Backup-Type-BGW_VmwareTag-VmwareTagDescription"></a>
这是用户定义的 VMware 标签描述。  
类型：字符串  
必需：否

 ** VmwareTagName **   <a name="Backup-Type-BGW_VmwareTag-VmwareTagName"></a>
这是用户定义的 VMware 标签名称。  
类型：字符串  
长度限制：长度下限为 1。最大长度为 80。  
必需：否

## 另请参阅
<a name="API_BGW_VmwareTag_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/VmwareTag) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/VmwareTag) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/VmwareTag) 

# VmwareToAwsTagMapping
<a name="API_BGW_VmwareToAwsTagMapping"></a>

这将显示标签与相应 VMware AWS 标签的映射。

## 内容
<a name="API_BGW_VmwareToAwsTagMapping_Contents"></a>

 ** AwsTagKey **   <a name="Backup-Type-BGW_VmwareToAwsTagMapping-AwsTagKey"></a>
 AWS 标签键值对的关键部分。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 128。  
模式：`([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`  
是否必需：是

 ** AwsTagValue **   <a name="Backup-Type-BGW_VmwareToAwsTagMapping-AwsTagValue"></a>
 AWS 标签键值对的值部分。  
类型：字符串  
长度限制：最小长度为 0。最大长度为 256。  
模式：`[^\x00]*`  
是否必需：是

 ** VmwareCategory **   <a name="Backup-Type-BGW_VmwareToAwsTagMapping-VmwareCategory"></a>
是的类别 VMware。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 80。  
是否必需：是

 ** VmwareTagName **   <a name="Backup-Type-BGW_VmwareToAwsTagMapping-VmwareTagName"></a>
这是用户定义的 VMware 标签名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 80。  
是否必需：是

## 另请参阅
<a name="API_BGW_VmwareToAwsTagMapping_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/VmwareToAwsTagMapping) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/VmwareToAwsTagMapping) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/VmwareToAwsTagMapping) 

# AWS Backup 搜索
<a name="API_Types_AWS_Backup_Search"></a>

支持以下数据类型 AWS Backup 搜索：
+  [BackupCreationTimeFilter](API_BKS_BackupCreationTimeFilter.md) 
+  [CurrentSearchProgress](API_BKS_CurrentSearchProgress.md) 
+  [EBSItemFilter](API_BKS_EBSItemFilter.md) 
+  [EBSResultItem](API_BKS_EBSResultItem.md) 
+  [ExportJobSummary](API_BKS_ExportJobSummary.md) 
+  [ExportSpecification](API_BKS_ExportSpecification.md) 
+  [ItemFilters](API_BKS_ItemFilters.md) 
+  [LongCondition](API_BKS_LongCondition.md) 
+  [ResultItem](API_BKS_ResultItem.md) 
+  [S3ExportSpecification](API_BKS_S3ExportSpecification.md) 
+  [S3ItemFilter](API_BKS_S3ItemFilter.md) 
+  [S3ResultItem](API_BKS_S3ResultItem.md) 
+  [SearchJobBackupsResult](API_BKS_SearchJobBackupsResult.md) 
+  [SearchJobSummary](API_BKS_SearchJobSummary.md) 
+  [SearchScope](API_BKS_SearchScope.md) 
+  [SearchScopeSummary](API_BKS_SearchScopeSummary.md) 
+  [StringCondition](API_BKS_StringCondition.md) 
+  [TimeCondition](API_BKS_TimeCondition.md) 

# BackupCreationTimeFilter
<a name="API_BKS_BackupCreationTimeFilter"></a>

这将按 CreatedAfter 和 CreatedBefore 时间戳内的恢复点进行筛选。

## 内容
<a name="API_BKS_BackupCreationTimeFilter_Contents"></a>

 ** CreatedAfter **   <a name="Backup-Type-BKS_BackupCreationTimeFilter-CreatedAfter"></a>
此时间戳仅包含在指定时间之后创建的恢复点。  
类型：时间戳  
必需：否

 ** CreatedBefore **   <a name="Backup-Type-BKS_BackupCreationTimeFilter-CreatedBefore"></a>
此时间戳仅包含在指定时间之前创建的恢复点。  
类型：时间戳  
必需：否

## 另请参阅
<a name="API_BKS_BackupCreationTimeFilter_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/BackupCreationTimeFilter) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/BackupCreationTimeFilter) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/BackupCreationTimeFilter) 

# CurrentSearchProgress
<a name="API_BKS_CurrentSearchProgress"></a>

此值包含从可能尚未完成的搜索作业中检索到的信息结果。

## 内容
<a name="API_BKS_CurrentSearchProgress_Contents"></a>

 ** ItemsMatchedCount **   <a name="Backup-Type-BKS_CurrentSearchProgress-ItemsMatchedCount"></a>
该数值是指当前正在执行的搜索作业中，所有符合项目筛选条件的项目的总和。  
类型：长整型  
必需：否

 ** ItemsScannedCount **   <a name="Backup-Type-BKS_CurrentSearchProgress-ItemsScannedCount"></a>
该数值是指搜索作业中迄今为止已扫描的所有项目的总和。  
类型：长整型  
必需：否

 ** RecoveryPointsScannedCount **   <a name="Backup-Type-BKS_CurrentSearchProgress-RecoveryPointsScannedCount"></a>
该数值是指搜索作业中迄今为止已扫描的所有备份的总和。  
类型：整数  
必需：否

## 另请参阅
<a name="API_BKS_CurrentSearchProgress_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/CurrentSearchProgress) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/CurrentSearchProgress) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/CurrentSearchProgress) 

# EBSItemFilter
<a name="API_BKS_EBSItemFilter"></a>

它包含对象数组，其中可能包括 CreationTimes 时间条件对象、 FilePaths 字符串对象、 LastModificationTimes 时间条件对象、

## 内容
<a name="API_BKS_EBSItemFilter_Contents"></a>

 ** CreationTimes **   <a name="Backup-Type-BKS_EBSItemFilter-CreationTimes"></a>
您可以包含 1 到 10 个值。  
如果包含一个值，则结果将仅返回匹配的项目。  
如果包含多个值，则结果将返回与任何包含值匹配的所有项目。  
类型：[TimeCondition](API_BKS_TimeCondition.md) 对象数组  
数组成员：最少 1 个物品。最多 10 个物品。  
必需：否

 ** FilePaths **   <a name="Backup-Type-BKS_EBSItemFilter-FilePaths"></a>
您可以包含 1 到 10 个值。  
如果包含一个文件路径，则结果将仅返回与该文件路径匹配的项目。  
如果包含多个文件路径，则结果将返回与包含的所有文件路径匹配的所有项目。  
类型：[StringCondition](API_BKS_StringCondition.md) 对象数组  
数组成员：最少 1 个物品。最多 10 个物品。  
必需：否

 ** LastModificationTimes **   <a name="Backup-Type-BKS_EBSItemFilter-LastModificationTimes"></a>
您可以包含 1 到 10 个值。  
如果包含一个值，则结果将仅返回匹配的项目。  
如果包含多个值，则结果将返回与任何包含值匹配的所有项目。  
类型：[TimeCondition](API_BKS_TimeCondition.md) 对象数组  
数组成员：最少 1 个物品。最多 10 个物品。  
必需：否

 ** Sizes **   <a name="Backup-Type-BKS_EBSItemFilter-Sizes"></a>
您可以包含 1 到 10 个值。  
如果包含一个值，则结果将仅返回匹配的项目。  
如果包含多个值，则结果将返回与任何包含值匹配的所有项目。  
类型：[LongCondition](API_BKS_LongCondition.md) 对象数组  
数组成员：最少 1 个物品。最多 10 个物品。  
必需：否

## 另请参阅
<a name="API_BKS_EBSItemFilter_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/EBSItemFilter) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/EBSItemFilter) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/EBSItemFilter) 

# EBSResultItem
<a name="API_BKS_EBSResultItem"></a>

此值表示在 Amazon EBS 备份元数据的搜索结果中返回的项目。

## 内容
<a name="API_BKS_EBSResultItem_Contents"></a>

 ** BackupResourceArn **   <a name="Backup-Type-BKS_EBSResultItem-BackupResourceArn"></a>
此值表示在 Amazon EBS 备份元数据的搜索结果中返回的与恢复点的 Amazon 资源名称（ARN）值匹配的一个或多个项目。  
类型：字符串  
必需：否

 ** BackupVaultName **   <a name="Backup-Type-BKS_EBSResultItem-BackupVaultName"></a>
备份保管库的名称。  
类型：字符串  
必需：否

 ** CreationTime **   <a name="Backup-Type-BKS_EBSResultItem-CreationTime"></a>
此值表示在 Amazon EBS 备份元数据的搜索结果中返回的与创建时间值匹配的一个或多个项目。  
类型：时间戳  
必需：否

 ** FilePath **   <a name="Backup-Type-BKS_EBSResultItem-FilePath"></a>
该值是指 Amazon EBS 备份元数据搜索结果中返回的与文件路径值匹配的一个或多个项目。  
类型：字符串  
必需：否

 ** FileSize **   <a name="Backup-Type-BKS_EBSResultItem-FileSize"></a>
该值是指 Amazon EBS 备份元数据搜索结果中返回的与文件大小值匹配的一个或多个项目。  
类型：长整型  
必需：否

 ** FileSystemIdentifier **   <a name="Backup-Type-BKS_EBSResultItem-FileSystemIdentifier"></a>
该值是指 Amazon EBS 备份元数据搜索结果中返回的与文件系统值匹配的一个或多个项目。  
类型：字符串  
必需：否

 ** LastModifiedTime **   <a name="Backup-Type-BKS_EBSResultItem-LastModifiedTime"></a>
该值是指 Amazon EBS 备份元数据搜索结果中返回的与上次修改时间值匹配的一个或多个项目。  
类型：时间戳  
必需：否

 ** SourceResourceArn **   <a name="Backup-Type-BKS_EBSResultItem-SourceResourceArn"></a>
该值是指 Amazon EBS 备份元数据搜索结果中返回的与源资源的 Amazon 资源名称（ARN）值匹配的一个或多个项目。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_BKS_EBSResultItem_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/EBSResultItem) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/EBSResultItem) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/EBSResultItem) 

# ExportJobSummary
<a name="API_BKS_ExportJobSummary"></a>

这是导出作业的摘要。

## 内容
<a name="API_BKS_ExportJobSummary_Contents"></a>

 ** ExportJobIdentifier **   <a name="Backup-Type-BKS_ExportJobSummary-ExportJobIdentifier"></a>
这是标识特定导出作业的唯一字符串。  
类型：字符串  
是否必需：是

 ** CompletionTime **   <a name="Backup-Type-BKS_ExportJobSummary-CompletionTime"></a>
这是表示导出作业完成时间的时间戳。  
类型：时间戳  
必需：否

 ** CreationTime **   <a name="Backup-Type-BKS_ExportJobSummary-CreationTime"></a>
这是表示导出作业创建时间的时间戳。  
类型：时间戳  
必需：否

 ** ExportJobArn **   <a name="Backup-Type-BKS_ExportJobSummary-ExportJobArn"></a>
这是属于新导出作业的唯一 Amazon 资源名称（ARN）。  
类型：字符串  
必需：否

 ** SearchJobArn **   <a name="Backup-Type-BKS_ExportJobSummary-SearchJobArn"></a>
用于标识指定搜索作业的 Amazon 资源名称（ARN）的唯一字符串。  
类型：字符串  
必需：否

 ** Status **   <a name="Backup-Type-BKS_ExportJobSummary-Status"></a>
导出作业的状态为以下项之一：  
 `CREATED`、`RUNNING`、`FAILED` 或 `COMPLETED`。  
类型：字符串  
有效值：`RUNNING | FAILED | COMPLETED`  
必需：否

 ** StatusMessage **   <a name="Backup-Type-BKS_ExportJobSummary-StatusMessage"></a>
状态消息是针对导出作业返回的一个字符串。  
对于除 `COMPLETED`（无任何问题）之外的任何状态，系统都会提供一条状态消息。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_BKS_ExportJobSummary_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/ExportJobSummary) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/ExportJobSummary) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/ExportJobSummary) 

# ExportSpecification
<a name="API_BKS_ExportSpecification"></a>

它包含导出规范对象。

## 内容
<a name="API_BKS_ExportSpecification_Contents"></a>

**重要**  
此数据类型为 UNION，因此在使用或返回时只能指定以下成员之一。

 ** s3ExportSpecification **   <a name="Backup-Type-BKS_ExportSpecification-s3ExportSpecification"></a>
此值用于指定导出作业的目标 Amazon S3 存储桶。此外，如果提供了此值，则它还会指定目标前缀。  
类型：[S3ExportSpecification](API_BKS_S3ExportSpecification.md) 对象  
必需：否

## 另请参阅
<a name="API_BKS_ExportSpecification_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/ExportSpecification) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/ExportSpecification) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/ExportSpecification) 

# ItemFilters
<a name="API_BKS_ItemFilters"></a>

项目筛选条件表示创建搜索时指定的所有输入项目属性。

包含 EBSItem过滤器或 S3 ItemFilters

## 内容
<a name="API_BKS_ItemFilters_Contents"></a>

 ** EBSItemFilters **   <a name="Backup-Type-BKS_ItemFilters-EBSItemFilters"></a>
此数组可以包含 CreationTimes、 FilePaths LastModificationTimes、或 Sizes 对象。  
类型：[EBSItemFilter](API_BKS_EBSItemFilter.md) 对象数组  
数组成员：最少 0 个物品。最多 10 个物品。  
必需：否

 ** S3ItemFilters **   <a name="Backup-Type-BKS_ItemFilters-S3ItemFilters"></a>
此数组可以包含 CreationTimes ETags、 ObjectKeys、、大小或 VersionIds 对象。  
类型：[S3ItemFilter](API_BKS_S3ItemFilter.md) 对象数组  
数组成员：最少 0 个物品。最多 10 个物品。  
必需：否

## 另请参阅
<a name="API_BKS_ItemFilters_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/ItemFilters) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/ItemFilters) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/ItemFilters) 

# LongCondition
<a name="API_BKS_LongCondition"></a>

长整型条件包含一个 `Value`，并且还可以选择包含一个 `Operator`。

## 内容
<a name="API_BKS_LongCondition_Contents"></a>

 ** Value **   <a name="Backup-Type-BKS_LongCondition-Value"></a>
在一个搜索项目筛选条件中包含的项目的值。  
类型：长整型  
是否必需：是

 ** Operator **   <a name="Backup-Type-BKS_LongCondition-Operator"></a>
定义将返回哪些值的字符串。  
若包含此字符串，请避免使用会返回所有可能值的运算符组合。例如，同时包含值为 `4` 的 `EQUALS_TO` 和 `NOT_EQUALS_TO` 会返回所有值。  
类型：字符串  
有效值：`EQUALS_TO | NOT_EQUALS_TO | LESS_THAN_EQUAL_TO | GREATER_THAN_EQUAL_TO`  
必需：否

## 另请参阅
<a name="API_BKS_LongCondition_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/LongCondition) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/LongCondition) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/LongCondition) 

# ResultItem
<a name="API_BKS_ResultItem"></a>

这是一个对象，表示在特定资源类型搜索结果中返回的项目。

## 内容
<a name="API_BKS_ResultItem_Contents"></a>

**重要**  
此数据类型为 UNION，因此在使用或返回时只能指定以下成员之一。

 ** EBSResultItem **   <a name="Backup-Type-BKS_ResultItem-EBSResultItem"></a>
此值表示在 Amazon EBS 搜索结果中返回的项目。  
类型：[EBSResultItem](API_BKS_EBSResultItem.md) 对象  
必需：否

 ** S3ResultItem **   <a name="Backup-Type-BKS_ResultItem-S3ResultItem"></a>
该值是 Amazon S3 搜索结果中返回的项目。  
类型：[S3ResultItem](API_BKS_S3ResultItem.md) 对象  
必需：否

## 另请参阅
<a name="API_BKS_ResultItem_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/ResultItem) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/ResultItem) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/ResultItem) 

# S3ExportSpecification
<a name="API_BKS_S3ExportSpecification"></a>

此规范包含目标存储桶的必填字符串；您也可以选择包含目标前缀。

## 内容
<a name="API_BKS_S3ExportSpecification_Contents"></a>

 ** DestinationBucket **   <a name="Backup-Type-BKS_S3ExportSpecification-DestinationBucket"></a>
此值用于指定导出作业的目标 Amazon S3 存储桶。  
类型：字符串  
是否必需：是

 ** DestinationPrefix **   <a name="Backup-Type-BKS_S3ExportSpecification-DestinationPrefix"></a>
该值指定导出作业的目标 Amazon S3 存储桶的前缀。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_BKS_S3ExportSpecification_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/S3ExportSpecification) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/S3ExportSpecification) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/S3ExportSpecification) 

# S3ItemFilter
<a name="API_BKS_S3ItemFilter"></a>

它包含对象数组，其中可能包括大小 ObjectKeys、、 CreationTimes VersionIds、 and/or Etags。

## 内容
<a name="API_BKS_S3ItemFilter_Contents"></a>

 ** CreationTimes **   <a name="Backup-Type-BKS_S3ItemFilter-CreationTimes"></a>
您可以包含 1 到 10 个值。  
如果包含一个值，则结果将仅返回与该值匹配的项目。  
如果包含多个值，则结果将返回与任何包含值匹配的所有项目。  
类型：[TimeCondition](API_BKS_TimeCondition.md) 对象数组  
数组成员：最少 1 个物品。最多 10 个物品。  
必需：否

 ** ETags **   <a name="Backup-Type-BKS_S3ItemFilter-ETags"></a>
您可以包含 1 到 10 个值。  
如果包含一个值，则结果将仅返回与该值匹配的项目。  
如果包含多个值，则结果将返回与任何包含值匹配的所有项目。  
类型：[StringCondition](API_BKS_StringCondition.md) 对象数组  
数组成员：最少 1 个物品。最多 10 个物品。  
必需：否

 ** ObjectKeys **   <a name="Backup-Type-BKS_S3ItemFilter-ObjectKeys"></a>
您可以包含 1 到 10 个值。  
如果包含一个值，则结果将仅返回与该值匹配的项目。  
如果包含多个值，则结果将返回与任何包含值匹配的所有项目。  
类型：[StringCondition](API_BKS_StringCondition.md) 对象数组  
数组成员：最少 1 个物品。最多 10 个物品。  
必需：否

 ** Sizes **   <a name="Backup-Type-BKS_S3ItemFilter-Sizes"></a>
您可以包含 1 到 10 个值。  
如果包含一个值，则结果将仅返回与该值匹配的项目。  
如果包含多个值，则结果将返回与任何包含值匹配的所有项目。  
类型：[LongCondition](API_BKS_LongCondition.md) 对象数组  
数组成员：最少 1 个物品。最多 10 个物品。  
必需：否

 ** VersionIds **   <a name="Backup-Type-BKS_S3ItemFilter-VersionIds"></a>
您可以包含 1 到 10 个值。  
如果包含一个值，则结果将仅返回与该值匹配的项目。  
如果包含多个值，则结果将返回与任何包含值匹配的所有项目。  
类型：[StringCondition](API_BKS_StringCondition.md) 对象数组  
数组成员：最少 1 个物品。最多 10 个物品。  
必需：否

## 另请参阅
<a name="API_BKS_S3ItemFilter_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/S3ItemFilter) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/S3ItemFilter) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/S3ItemFilter) 

# S3ResultItem
<a name="API_BKS_S3ResultItem"></a>

该值是指 Amazon S3 备份元数据搜索结果中返回的项目。

## 内容
<a name="API_BKS_S3ResultItem_Contents"></a>

 ** BackupResourceArn **   <a name="Backup-Type-BKS_S3ResultItem-BackupResourceArn"></a>
该值是指返回结果中与在搜索 Amazon S3 备份元数据过程中输入的恢复点 Amazon 资源名称（ARN）匹配的项目。  
类型：字符串  
必需：否

 ** BackupVaultName **   <a name="Backup-Type-BKS_S3ResultItem-BackupVaultName"></a>
备份保管库的名称。  
类型：字符串  
必需：否

 ** CreationTime **   <a name="Backup-Type-BKS_S3ResultItem-CreationTime"></a>
此值表示返回结果中与在搜索 Amazon S3 备份元数据时输入的项目创建时间值匹配的项目。  
类型：时间戳  
必需：否

 ** ETag **   <a name="Backup-Type-BKS_S3ResultItem-ETag"></a>
这些是返回结果中的一个或多个项目，它们与搜索 Amazon S3 备份元数据期间的 ETags 输入值相匹配。  
类型：字符串  
必需：否

 ** ObjectKey **   <a name="Backup-Type-BKS_S3ResultItem-ObjectKey"></a>
该值是指 Amazon S3 备份元数据搜索结果中返回的与输入的对象键值匹配的项目。  
类型：字符串  
必需：否

 ** ObjectSize **   <a name="Backup-Type-BKS_S3ResultItem-ObjectSize"></a>
此值表示返回结果中与在搜索 Amazon S3 备份元数据时输入的对象大小值匹配的项目。  
类型：长整型  
必需：否

 ** SourceResourceArn **   <a name="Backup-Type-BKS_S3ResultItem-SourceResourceArn"></a>
该值是指返回结果中与在搜索 Amazon S3 备份元数据过程中输入的源 Amazon 资源名称（ARN）匹配的项目。  
类型：字符串  
必需：否

 ** VersionId **   <a name="Backup-Type-BKS_S3ResultItem-VersionId"></a>
这些是搜索Amazon S3备份元数据期间返回的结果中的一个或多个与版本 IDs 输入值相匹配的项目。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_BKS_S3ResultItem_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/S3ResultItem) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/S3ResultItem) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/S3ResultItem) 

# SearchJobBackupsResult
<a name="API_BKS_SearchJobBackupsResult"></a>

此值包含有关在搜索作业的结果中返回的恢复点的信息。

## 内容
<a name="API_BKS_SearchJobBackupsResult_Contents"></a>

 ** BackupCreationTime **   <a name="Backup-Type-BKS_SearchJobBackupsResult-BackupCreationTime"></a>
这是备份（恢复点）的创建时间。  
类型：时间戳  
必需：否

 ** BackupResourceArn **   <a name="Backup-Type-BKS_SearchJobBackupsResult-BackupResourceArn"></a>
唯一标识备份资源的 Amazon 资源名称（ARN）。  
类型：字符串  
必需：否

 ** IndexCreationTime **   <a name="Backup-Type-BKS_SearchJobBackupsResult-IndexCreationTime"></a>
这是备份索引的创建时间。  
类型：时间戳  
必需：否

 ** ResourceType **   <a name="Backup-Type-BKS_SearchJobBackupsResult-ResourceType"></a>
这是搜索的资源类型。  
类型：字符串  
有效值：`S3 | EBS`  
必需：否

 ** SourceResourceArn **   <a name="Backup-Type-BKS_SearchJobBackupsResult-SourceResourceArn"></a>
唯一标识源资源的 Amazon 资源名称（ARN）。  
类型：字符串  
必需：否

 ** Status **   <a name="Backup-Type-BKS_SearchJobBackupsResult-Status"></a>
这是搜索作业备份结果的状态。  
类型：字符串  
有效值：`RUNNING | COMPLETED | STOPPING | STOPPED | FAILED`  
必需：否

 ** StatusMessage **   <a name="Backup-Type-BKS_SearchJobBackupsResult-StatusMessage"></a>
这是结果中包含的状态消息。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_BKS_SearchJobBackupsResult_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/SearchJobBackupsResult) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/SearchJobBackupsResult) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/SearchJobBackupsResult) 

# SearchJobSummary
<a name="API_BKS_SearchJobSummary"></a>

这是与搜索作业有关的信息。

## 内容
<a name="API_BKS_SearchJobSummary_Contents"></a>

 ** CompletionTime **   <a name="Backup-Type-BKS_SearchJobSummary-CompletionTime"></a>
这是搜索作业的完成时间。  
类型：时间戳  
必需：否

 ** CreationTime **   <a name="Backup-Type-BKS_SearchJobSummary-CreationTime"></a>
这是搜索作业的创建时间。  
类型：时间戳  
必需：否

 ** Name **   <a name="Backup-Type-BKS_SearchJobSummary-Name"></a>
这是搜索作业的名称。  
类型：字符串  
必需：否

 ** SearchJobArn **   <a name="Backup-Type-BKS_SearchJobSummary-SearchJobArn"></a>
用于标识指定搜索作业的 Amazon 资源名称（ARN）的唯一字符串。  
类型：字符串  
必需：否

 ** SearchJobIdentifier **   <a name="Backup-Type-BKS_SearchJobSummary-SearchJobIdentifier"></a>
指定搜索作业的唯一字符串。  
类型：字符串  
必需：否

 ** SearchScopeSummary **   <a name="Backup-Type-BKS_SearchJobSummary-SearchScopeSummary"></a>
返回的指定搜索作业范围的摘要，包括：  
+ TotalBackupsToScanCount，搜索返回的恢复点数。
+ TotalItemsToScanCount，搜索返回的商品数量。
类型：[SearchScopeSummary](API_BKS_SearchScopeSummary.md) 对象  
必需：否

 ** Status **   <a name="Backup-Type-BKS_SearchJobSummary-Status"></a>
这是搜索作业的状态。  
类型：字符串  
有效值：`RUNNING | COMPLETED | STOPPING | STOPPED | FAILED`  
必需：否

 ** StatusMessage **   <a name="Backup-Type-BKS_SearchJobSummary-StatusMessage"></a>
对于状态为 `ERRORED` 的搜索作业或状态为 `COMPLETED` 且存在问题的搜索作业，将返回状态消息。  
例如，一条消息可能会显示，由于权限问题，搜索结果中包含无法扫描的恢复点。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_BKS_SearchJobSummary_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/SearchJobSummary) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/SearchJobSummary) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/SearchJobSummary) 

# SearchScope
<a name="API_BKS_SearchScope"></a>

搜索范围为所有输入到搜索中的备份属性。

## 内容
<a name="API_BKS_SearchScope_Contents"></a>

 ** BackupResourceTypes **   <a name="Backup-Type-BKS_SearchScope-BackupResourceTypes"></a>
搜索内容中包含的资源类型。  
符合条件的资源类型包括 S3 和 EBS。  
类型：字符串数组  
数组成员：固定数量为 1 项。  
有效值：`S3 | EBS`  
是否必需：是

 ** BackupResourceArns **   <a name="Backup-Type-BKS_SearchScope-BackupResourceArns"></a>
唯一标识备份资源的 Amazon 资源名称（ARN）。  
类型：字符串数组  
数组成员：最少 0 项。最多 50 项。  
必需：否

 ** BackupResourceCreationTime **   <a name="Backup-Type-BKS_SearchScope-BackupResourceCreationTime"></a>
这是备份资源的创建时间。  
类型：[BackupCreationTimeFilter](API_BKS_BackupCreationTimeFilter.md) 对象  
必需：否

 ** BackupResourceTags **   <a name="Backup-Type-BKS_SearchScope-BackupResourceTags"></a>
此值表示备份（恢复点）上的一个或多个标签。  
类型：字符串到字符串映射  
必需：否

 ** SourceResourceArns **   <a name="Backup-Type-BKS_SearchScope-SourceResourceArns"></a>
唯一标识源资源的 Amazon 资源名称（ARN）。  
类型：字符串数组  
数组成员：最少 0 项。最多 50 项。  
必需：否

## 另请参阅
<a name="API_BKS_SearchScope_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/SearchScope) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/SearchScope) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/SearchScope) 

# SearchScopeSummary
<a name="API_BKS_SearchScopeSummary"></a>

指定搜索作业范围的摘要，包括：
+ TotalBackupsToScanCount，搜索返回的恢复点数。
+ TotalItemsToScanCount，搜索返回的商品数量。

## 内容
<a name="API_BKS_SearchScopeSummary_Contents"></a>

 ** TotalItemsToScanCount **   <a name="Backup-Type-BKS_SearchScopeSummary-TotalItemsToScanCount"></a>
此值表示要在搜索中扫描的项目总数。  
类型：长整型  
必需：否

 ** TotalRecoveryPointsToScanCount **   <a name="Backup-Type-BKS_SearchScopeSummary-TotalRecoveryPointsToScanCount"></a>
这是将在搜索中扫描的备份总数的计数。  
类型：整数  
必需：否

## 另请参阅
<a name="API_BKS_SearchScopeSummary_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/SearchScopeSummary) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/SearchScopeSummary) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/SearchScopeSummary) 

# StringCondition
<a name="API_BKS_StringCondition"></a>

它包含字符串的值，可以包含一个或多个运算符。

## 内容
<a name="API_BKS_StringCondition_Contents"></a>

 ** Value **   <a name="Backup-Type-BKS_StringCondition-Value"></a>
字符串的值。  
类型：字符串  
是否必需：是

 ** Operator **   <a name="Backup-Type-BKS_StringCondition-Operator"></a>
定义将返回哪些值的字符串。  
若包含此字符串，请避免使用会返回所有可能值的运算符组合。例如，同时包含值为 `4` 的 `EQUALS_TO` 和 `NOT_EQUALS_TO` 会返回所有值。  
类型：字符串  
有效值：`EQUALS_TO | NOT_EQUALS_TO | CONTAINS | DOES_NOT_CONTAIN | BEGINS_WITH | ENDS_WITH | DOES_NOT_BEGIN_WITH | DOES_NOT_END_WITH`  
必需：否

## 另请参阅
<a name="API_BKS_StringCondition_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/StringCondition) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/StringCondition) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/StringCondition) 

# TimeCondition
<a name="API_BKS_TimeCondition"></a>

时间条件表示创建时间、上次修改时间或其他时间。

## 内容
<a name="API_BKS_TimeCondition_Contents"></a>

 ** Value **   <a name="Backup-Type-BKS_TimeCondition-Value"></a>
这是时间条件的时间戳值。  
类型：时间戳  
是否必需：是

 ** Operator **   <a name="Backup-Type-BKS_TimeCondition-Operator"></a>
定义将返回哪些值的字符串。  
若包含此字符串，请避免使用会返回所有可能值的运算符组合。例如，同时包含值为 `4` 的 `EQUALS_TO` 和 `NOT_EQUALS_TO` 会返回所有值。  
类型：字符串  
有效值：`EQUALS_TO | NOT_EQUALS_TO | LESS_THAN_EQUAL_TO | GREATER_THAN_EQUAL_TO`  
必需：否

## 另请参阅
<a name="API_BKS_TimeCondition_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/TimeCondition) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/TimeCondition) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/TimeCondition) 

# 常见参数
<a name="CommonParameters"></a>

以下列表包含所有操作用于使用查询字符串对 Signature Version 4 请求进行签名的参数。任何特定于操作的参数都列在该操作的主题中。有关签名版本 4 的更多信息，请参阅 I *AM 用户指南*中的[签署 AWS API 请求](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)。

 **X-Amz-Algorithm**   <a name="CommonParameters-X-Amz-Algorithm"></a>
您用于创建请求签名的哈希算法。  
条件：当您在查询字符串中而不是 HTTP 授权标头中包括身份验证信息时，请指定此参数。  
类型：字符串  
有效值：`AWS4-HMAC-SHA256`  
必需：条件

 **X-Amz-Credential**   <a name="CommonParameters-X-Amz-Credential"></a>
凭证范围值，该值是一个字符串，其中包含您的访问密钥、日期、您要定位的区域、您请求的服务以及终止字符串（“aws4\$1request”）。值采用以下格式表示：*access\$1key*/*YYYYMMDD*/*region*/*service*/aws4\$1request。  
有关更多信息，请参阅 I *AM 用户指南*中的[创建已签名的 AWS API 请求](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html)。  
条件：当您在查询字符串中而不是 HTTP 授权标头中包括身份验证信息时，请指定此参数。  
类型：字符串  
必需：条件

 **X-Amz-Date**   <a name="CommonParameters-X-Amz-Date"></a>
用于创建签名的日期。格式必须为 ISO 8601 基本格式 (YYYYMMDD'T'HHMMSS'Z')。例如，以下日期时间是有效 X-Amz-Date值：`20120325T120000Z`。  
条件： X-Amz-Date 对所有请求而言是可选的；它可以用于覆盖对请求签名所使用的日期。如果日期标题以 ISO 8601 基本格式指定，则 X-Amz-Date不是必填项。使用 X-Amz-Date时，它总是会覆盖 Date 标题的值。有关更多信息，请参阅 I *AM 用户指南*中的 [AWS API 请求签名元素](https://docs.aws.amazon.com/IAM/latest/UserGuide/signing-elements.html)。  
类型：字符串  
必需：条件

 **X-Amz-Security-Token**   <a name="CommonParameters-X-Amz-Security-Token"></a>
通过调用 AWS Security Token Service (AWS STS) 获得的临时安全令牌。有关支持来自 AWS STS的临时安全凭证的服务列表，请参阅《IAM 用户指南》**中的[使用 IAM 的AWS 服务](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html)。  
条件：如果您使用的是中的临时安全证书 AWS STS，则必须包含安全令牌。  
类型：字符串  
必需：条件

 **X-Amz-Signature**   <a name="CommonParameters-X-Amz-Signature"></a>
指定从要签名的字符串和派生的签名密钥计算的十六进制编码签名。  
条件：当您在查询字符串中而不是 HTTP 授权标头中包括身份验证信息时，请指定此参数。  
类型：字符串  
必需：条件

 **X-Amz-SignedHeaders**   <a name="CommonParameters-X-Amz-SignedHeaders"></a>
指定作为规范请求的一部分包含的所有 HTTP 标头。有关指定签名标头的更多信息，请参阅 I *AM 用户指南*中的[创建已签名的 AWS API 请求](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html)。  
条件：当您在查询字符串中而不是 HTTP 授权标头中包括身份验证信息时，请指定此参数。  
类型：字符串  
必需：条件

# 常见错误类型
<a name="CommonErrors"></a>

本节列出了此 AWS 服务可能返回的常见错误类型。并非所有服务都会返回此处列出的所有错误类型。对于特定于此服务的 API 操作的错误，请参阅该 API 操作的主题。

 **AccessDeniedException**   <a name="CommonErrors-AccessDeniedException"></a>
您无权执行此操作。验证您的 IAM 策略是否包含所需的权限。  
HTTP 状态代码：403

 **ExpiredTokenException**   <a name="CommonErrors-ExpiredTokenException"></a>
请求中包含的安全令牌已过期。申请新的安全令牌并重试。  
HTTP 状态代码：403

 **IncompleteSignature**   <a name="CommonErrors-IncompleteSignature"></a>
请求签名不符合 AWS 标准。确认您使用的是有效的 AWS 凭证，并且您的请求格式是否正确。如果您使用的是 SDK，请确保它是最新的。  
HTTP 状态代码：403

 **InternalFailure**   <a name="CommonErrors-InternalFailure"></a>
由于内部服务器问题，该请求现在无法处理。请稍后重试。如果问题仍然存在，请联系 Supp AWS ort。  
HTTP 状态代码：500

 **MalformedHttpRequestException**   <a name="CommonErrors-MalformedHttpRequestException"></a>
无法处理请求正文。当无法使用指定的内容编码算法对请求正文进行解压缩时，通常会发生这种情况。验证内容编码标头是否与使用的压缩格式相匹配。  
HTTP 状态代码：400

 **NotAuthorized**   <a name="CommonErrors-NotAuthorized"></a>
您无权执行此操作。验证您的 IAM 策略是否包含所需的权限。  
HTTP 状态代码：401

 **OptInRequired**   <a name="CommonErrors-OptInRequired"></a>
您的 AWS 账户需要订阅此服务。确认您已在账户中启用该服务。  
HTTP 状态代码：403

 **RequestAbortedException**   <a name="CommonErrors-RequestAbortedException"></a>
在返回响应之前，请求已中止。这通常发生在客户端关闭连接时。  
HTTP 状态代码：400

 **RequestEntityTooLargeException**   <a name="CommonErrors-RequestEntityTooLargeException"></a>
请求实体太大。请缩小请求正文的大小，然后重试。  
HTTP 状态代码：413

 **RequestTimeoutException**   <a name="CommonErrors-RequestTimeoutException"></a>
请求超时。服务器未在预期的时间范围内收到完整的请求。请重试。  
HTTP 状态代码：408

 **ServiceUnavailable**   <a name="CommonErrors-ServiceUnavailable"></a>
服务暂时不可用。请稍后重试。  
HTTP 状态代码：503

 **ThrottlingException**   <a name="CommonErrors-ThrottlingException"></a>
您的请求率太高。收到此异常的 AWS SDKs 自动重试请求。请降低请求频率。  
HTTP 状态代码：400

 **UnknownOperationException**   <a name="CommonErrors-UnknownOperationException"></a>
无法识别该操作或操作。确认操作名称拼写正确，并且您使用的 API 版本是否支持该名称。  
HTTP 状态代码：404

 **UnrecognizedClientException**   <a name="CommonErrors-UnrecognizedClientException"></a>
您提供的 X.509 证书或 AWS 访问密钥 ID 不在我们的记录中。确认您使用的是有效的凭证，并且这些凭证尚未过期。  
HTTP 状态代码：403

 **ValidationError**   <a name="CommonErrors-ValidationError"></a>
输入不符合要求的格式或限制。检查是否包含所有必需的参数以及值是否有效。  
HTTP 状态代码：400