

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

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

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/AssociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/AssociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/AssociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/AssociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/AssociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/AssociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/AssociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/AssociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/AssociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/AssociateBackupVaultMpaApprovalTeam) 

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

復旧ポイントで指定されたリーガルホールドを削除します。このアクションを実行できるのは、十分な権限を持つユーザーのみです。

## リクエストの構文
<a name="API_CancelLegalHold_RequestSyntax"></a>

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

## URI リクエストパラメータ
<a name="API_CancelLegalHold_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [CancelDescription](#API_CancelLegalHold_RequestSyntax) **   <a name="Backup-CancelLegalHold-request-uri-CancelDescription"></a>
リーガルホールドを削除する理由を説明する文字列。  
必須: はい

 ** [legalHoldId](#API_CancelLegalHold_RequestSyntax) **   <a name="Backup-CancelLegalHold-request-uri-LegalHoldId"></a>
リーガルホールドの ID。  
必須: はい

 ** [RetainRecordInDays](#API_CancelLegalHold_RequestSyntax) **   <a name="Backup-CancelLegalHold-request-uri-RetainRecordInDays"></a>
リーガルホールドを削除するまでの日数 (整数)。

## リクエスト本文
<a name="API_CancelLegalHold_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_CancelLegalHold_ResponseSyntax"></a>

```
HTTP/1.1 201
```

## レスポンス要素
<a name="API_CancelLegalHold_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 201 レスポンスを返します。

## エラー
<a name="API_CancelLegalHold_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** InvalidResourceStateException **   
 AWS Backup は、この復旧ポイントで既にアクションを実行しています。最初のアクションが終了するまで、リクエストしたアクションを実行できません。後でもう一度お試しください。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_CancelLegalHold_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/CancelLegalHold) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/CancelLegalHold) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CancelLegalHold) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CancelLegalHold) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CancelLegalHold) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/CancelLegalHold) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/CancelLegalHold) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CancelLegalHold) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/CancelLegalHold) 
+  [AWS SDK for Ruby V3](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>
バックアッププランの本文。1 つの `BackupPlanName` と1 つ以上の `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>
オペレーションを 2 回実行するリスクなしに、リクエストを識別し、失敗したリクエストを再試行できます。リクエストに既存のバックアッププランと一致する `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>
たとえば、`arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50`などのバックアップ計画を一意に識別する Amazon リソースネーム (ARN) です。  
タイプ: 文字列

 ** [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>
一意のランダムに生成された UTF-8 エンコード Unicode 文字列 (最大 1,024 バイト長)。編集することはできません。  
タイプ: 文字列

## エラー
<a name="API_CreateBackupPlan_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** AlreadyExistsException **   
必要なリソースは既に存在します。    
 ** Arn **   
  
 ** Context **   
  
 ** CreatorRequestId **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** LimitExceededException **   
たとえば、リクエストで許可されるアイテムの最大数などのリクエストの制限を超えました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_CreateBackupPlan_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/CreateBackupPlan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/CreateBackupPlan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CreateBackupPlan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateBackupPlan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CreateBackupPlan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/CreateBackupPlan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/CreateBackupPlan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateBackupPlan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/CreateBackupPlan) 
+  [AWS SDK for Ruby V3](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>
オペレーションを 2 回実行するリスクなしに、失敗したリクエストを再試行できるリクエストを識別する一意の文字列。このパラメータはオプションです。  
使用する場合、このパラメータには 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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/CreateBackupSelection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/CreateBackupSelection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CreateBackupSelection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateBackupSelection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CreateBackupSelection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/CreateBackupSelection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/CreateBackupSelection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateBackupSelection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/CreateBackupSelection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CreateBackupSelection) 

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

バックアップを保存する論理コンテナを作成します。`CreateBackupVault` リクエストは、名前、1 つ以上のリソースタグ (省略可能)、暗号化キー、およびリクエスト 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>
リクエストを識別するための一意の文字列で、失敗したリクエストを再試行する際に、オペレーションを2回実行するリスクを回避することができます。このパラメータはオプションです。  
使用する場合、このパラメータには 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>
`arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`などのバックアップボールトを一意に識別する Amazon リソースネーム (ARN)。  
タイプ: 文字列

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

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/CreateBackupVault) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/CreateBackupVault) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CreateBackupVault) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateBackupVault) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CreateBackupVault) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/CreateBackupVault) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/CreateBackupVault) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateBackupVault) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/CreateBackupVault) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CreateBackupVault) 

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

1 つ以上のコントロールを持つフレームワークを作成します。フレームワークは、バックアッププラクティスを評価するために使用できるコントロールの集まりです。事前に構築されたカスタマイズ可能なコントロールを使用してポリシーを定義することで、バックアッププラクティスがポリシーに準拠しているかどうか、およびまだ準拠していないリソースを評価できます。

## リクエストの構文
<a name="API_CreateFramework_RequestSyntax"></a>

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

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

## URI リクエストパラメータ
<a name="API_CreateFramework_RequestParameters"></a>

リクエストでは URI パラメータを使用しません。

## リクエストボディ
<a name="API_CreateFramework_RequestBody"></a>

リクエストは以下の JSON 形式のデータを受け入れます。

 ** [FrameworkControls](#API_CreateFramework_RequestSyntax) **   <a name="Backup-CreateFramework-request-FrameworkControls"></a>
フレームワークを構成するコントロール。リスト内の各コントロールには、名前、入力パラメータ、およびスコープがあります。  
型: [FrameworkControl](API_FrameworkControl.md) オブジェクトの配列  
必須: はい

 ** [FrameworkDescription](#API_CreateFramework_RequestSyntax) **   <a name="Backup-CreateFramework-request-FrameworkDescription"></a>
最大 1,024 文字のフレームワークの任意の記述。  
タイプ: 文字列  
長さの制約: 最小長は 0 です。最大長は 1,024 です。  
パターン: `.*\S.*`   
必須: いいえ

 ** [FrameworkName](#API_CreateFramework_RequestSyntax) **   <a name="Backup-CreateFramework-request-FrameworkName"></a>
フレームワークの一意の名前。名前は文字から始まる1～256文字で、文字 (a\$1z、A～Z)、数字 (0\$19)、およびアンダースコア (\$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\$1z、A～Z)、数字 (0\$19)、およびアンダースコア (\$1)により構成されます。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 256 です。  
パターン: `[a-zA-Z][_a-zA-Z0-9]*` 

## エラー
<a name="API_CreateFramework_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** AlreadyExistsException **   
必要なリソースは既に存在します。    
 ** Arn **   
  
 ** Context **   
  
 ** CreatorRequestId **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** LimitExceededException **   
たとえば、リクエストで許可されるアイテムの最大数などのリクエストの制限を超えました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_CreateFramework_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/CreateFramework) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/CreateFramework) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CreateFramework) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateFramework) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CreateFramework) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/CreateFramework) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/CreateFramework) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateFramework) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/CreateFramework) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CreateFramework) 

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

復旧ポイント (バックアップ) にリーガルホールドを作成します。リーガルホールドとは、権限のあるユーザーがリーガルホールドをキャンセルするまでの間の、バックアップの変更または削除の制限です。復旧ポイントに 1 つ以上の有効なリーガルホールドがある場合、復旧ポイントを削除するまたは関連付けを解除する操作はすべてエラーで失敗します。

## リクエストの構文
<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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/CreateLegalHold) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/CreateLegalHold) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CreateLegalHold) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateLegalHold) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CreateLegalHold) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/CreateLegalHold) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/CreateLegalHold) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateLegalHold) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/CreateLegalHold) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CreateLegalHold) 

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

バックアップをコピーできる論理コンテナを作成します。

このリクエストには、名前、リージョン、最大保持日数、最小保持日数が含まれます。また、オプションでタグと作成者リクエスト ID を含めることができます。

**注記**  
パスポート番号などの機密データは、バックアップボールトの名前に含めないでください。

## リクエストの構文
<a name="API_CreateLogicallyAirGappedBackupVault_RequestSyntax"></a>

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

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

## URI リクエストパラメータ
<a name="API_CreateLogicallyAirGappedBackupVault_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [backupVaultName](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **   <a name="Backup-CreateLogicallyAirGappedBackupVault-request-uri-BackupVaultName"></a>
バックアップを保存する論理コンテナの名前。論理的にエアギャップのあるバックアップボールトは、これらのボールトを作成するために使用されたアカウントと作成先のリージョンに一意の名前で識別されます。  
パターン: `^[a-zA-Z0-9\-\_]{2,50}$`   
必須: はい

## リクエストボディ
<a name="API_CreateLogicallyAirGappedBackupVault_RequestBody"></a>

リクエストは以下の JSON 形式のデータを受け入れます。

 ** [BackupVaultTags](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **   <a name="Backup-CreateLogicallyAirGappedBackupVault-request-BackupVaultTags"></a>
ボールトに割り当てるタグ。  
タイプ: 文字列間のマッピング  
必須: いいえ

 ** [CreatorRequestId](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **   <a name="Backup-CreateLogicallyAirGappedBackupVault-request-CreatorRequestId"></a>
作成リクエストの ID。  
このパラメータはオプションです。使用する場合、このパラメータには 1～50 文字の英数字または「-\$1」を含める必要があります 。  
タイプ: 文字列  
必須: いいえ

 ** [EncryptionKeyArn](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **   <a name="Backup-CreateLogicallyAirGappedBackupVault-request-EncryptionKeyArn"></a>
論理エアギャップバックアップボールトの暗号化に使用するカスタマーマネージド KMS キーの ARN。指定しない場合、ボールトは AWS Backup が管理する AWS所有キーで暗号化されます。  
タイプ: 文字列  
必須: いいえ

 ** [MaxRetentionDays](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **   <a name="Backup-CreateLogicallyAirGappedBackupVault-request-MaxRetentionDays"></a>
ボールトが復旧ポイントを保持する最大保持期間。  
タイプ: Long  
必須: はい

 ** [MinRetentionDays](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **   <a name="Backup-CreateLogicallyAirGappedBackupVault-request-MinRetentionDays"></a>
この設定は、ボールトが復旧ポイントを保持する最小保持期間を指定します。  
許容される最小値は 7 日です。  
タイプ: Long  
必須: はい

## レスポンスの構文
<a name="API_CreateLogicallyAirGappedBackupVault_ResponseSyntax"></a>

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

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

## レスポンス要素
<a name="API_CreateLogicallyAirGappedBackupVault_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [BackupVaultArn](#API_CreateLogicallyAirGappedBackupVault_ResponseSyntax) **   <a name="Backup-CreateLogicallyAirGappedBackupVault-response-BackupVaultArn"></a>
ボールトの ARN (Amazon リソースネーム)。  
タイプ: 文字列

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

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/CreateLogicallyAirGappedBackupVault) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/CreateLogicallyAirGappedBackupVault) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CreateLogicallyAirGappedBackupVault) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateLogicallyAirGappedBackupVault) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CreateLogicallyAirGappedBackupVault) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/CreateLogicallyAirGappedBackupVault) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/CreateLogicallyAirGappedBackupVault) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateLogicallyAirGappedBackupVault) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/CreateLogicallyAirGappedBackupVault) 
+  [AWS SDK for Ruby V3](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 key prefix、レポートの形式に関する情報を含む構造。  
型: [ReportDeliveryChannel](API_ReportDeliveryChannel.md) オブジェクト  
必須: はい

 ** [ReportPlanDescription](#API_CreateReportPlan_RequestSyntax) **   <a name="Backup-CreateReportPlan-request-ReportPlanDescription"></a>
最大 1,024 文字までのレポートプランの任意の記述。  
タイプ: 文字列  
長さの制約: 最小長は 0 です。最大長は 1,024 です。  
パターン: `.*\S.*`   
必須: いいえ

 ** [ReportPlanName](#API_CreateReportPlan_RequestSyntax) **   <a name="Backup-CreateReportPlan-request-ReportPlanName"></a>
レポートプランの一意の名前。名前は文字から始まる1～256文字で、文字 (a\$1z、A～Z)、数字 (0\$19)、およびアンダースコア (\$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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/CreateReportPlan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/CreateReportPlan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CreateReportPlan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateReportPlan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CreateReportPlan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/CreateReportPlan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/CreateReportPlan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateReportPlan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/CreateReportPlan) 
+  [AWS SDK for Ruby V3](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>
リクエストを識別するための一意の文字列で、失敗したリクエストを再試行する際に、オペレーションを2回実行するリスクを回避することができます。  
タイプ: 文字列  
必須: いいえ

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

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/CreateRestoreAccessBackupVault) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/CreateRestoreAccessBackupVault) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CreateRestoreAccessBackupVault) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateRestoreAccessBackupVault) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CreateRestoreAccessBackupVault) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/CreateRestoreAccessBackupVault) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/CreateRestoreAccessBackupVault) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateRestoreAccessBackupVault) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/CreateRestoreAccessBackupVault) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CreateRestoreAccessBackupVault) 

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

復元テストプランを作成します。

復元テストプランを作成する 2 つのステップのうちの最初のステップ。このリクエストが成功したら、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>
リクエストを識別するための一意の文字列で、失敗したリクエストを再試行する際に、オペレーションを 2 回実行するリスクを回避することができます。このパラメータはオプションです。使用する場合、このパラメータには 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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/CreateRestoreTestingPlan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/CreateRestoreTestingPlan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CreateRestoreTestingPlan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateRestoreTestingPlan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CreateRestoreTestingPlan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/CreateRestoreTestingPlan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/CreateRestoreTestingPlan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateRestoreTestingPlan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/CreateRestoreTestingPlan) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CreateRestoreTestingPlan) 

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

このリクエストは、CreateRestoreTestingPlan リクエストが正常に返された後に送信できます。これはリソーステスト計画の作成の 2 番目のステップで、順番に完了する必要があります。

これは、`RestoreTestingSelectionName`、`ProtectedResourceType` と、以下のいずれかで構成されます。
+  `ProtectedResourceArns` 
+  `ProtectedResourceConditions` 

保護対象リソースのタイプごとに値を 1 つ設定できます。

復元テスト選択には、`ProtectedResourceArns` のワイルドカード値 (「\$1」) を `ProtectedResourceConditions` と併せて含めることができます。または、`ProtectedResourceArns` に保護対象リソースの ARN を最大 30 個まで含めることもできます。

保護対象リソースのタイプと特定の ARN の両方で選択することはできません。両方が含まれている場合、リクエストは失敗します。

## リクエストの構文
<a name="API_CreateRestoreTestingSelection_RequestSyntax"></a>

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

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

## URI リクエストパラメータ
<a name="API_CreateRestoreTestingSelection_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [RestoreTestingPlanName](#API_CreateRestoreTestingSelection_RequestSyntax) **   <a name="Backup-CreateRestoreTestingSelection-request-uri-RestoreTestingPlanName"></a>
関連する CreateRestoreTestingPlan リクエストから返された復元テストプラン名を入力します。  
必須: はい

## リクエストボディ
<a name="API_CreateRestoreTestingSelection_RequestBody"></a>

リクエストは以下の JSON 形式のデータを受け入れます。

 ** [CreatorRequestId](#API_CreateRestoreTestingSelection_RequestSyntax) **   <a name="Backup-CreateRestoreTestingSelection-request-CreatorRequestId"></a>
リクエストを識別するための一意の文字列 (オプション) で、失敗したリクエストを再試行する際に、オペレーションを 2 回実行するリスクを回避することができます。使用する場合、このパラメータには 1～50 文字の英数字または「-\$1」を含める必要があります 。  
タイプ: 文字列  
必須: いいえ

 ** [RestoreTestingSelection](#API_CreateRestoreTestingSelection_RequestSyntax) **   <a name="Backup-CreateRestoreTestingSelection-request-RestoreTestingSelection"></a>
これは、`RestoreTestingSelectionName`、`ProtectedResourceType` と、以下のいずれかで構成されます。  
+  `ProtectedResourceArns` 
+  `ProtectedResourceConditions` 
保護対象リソースのタイプごとに値を 1 つ設定できます。  
復元テスト選択には、`ProtectedResourceArns` のワイルドカード値 (「\$1」) を `ProtectedResourceConditions` と併せて含めることができます。または、`ProtectedResourceArns` に保護対象リソースの ARN を最大 30 個まで含めることもできます。  
型: [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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/CreateRestoreTestingSelection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/CreateRestoreTestingSelection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CreateRestoreTestingSelection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateRestoreTestingSelection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CreateRestoreTestingSelection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/CreateRestoreTestingSelection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/CreateRestoreTestingSelection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateRestoreTestingSelection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/CreateRestoreTestingSelection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CreateRestoreTestingSelection) 

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

階層化設定を作成します。

階層設定を使用すると、バックアップボールト内のバックアップオブジェクトの経過時間に基づいて、バックアップデータを低コストのストレージ階層に自動的に移動できます。

各ボールトは、すべてのボールトに適用されるグローバル設定に加えて、ボールト固有の階層設定を 1 つだけ持つことができます。

## リクエストの構文
<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>
これはリクエストを識別し、失敗したリクエストを 2 回実行するリスクなしに再試行できるようにする一意の文字列です。このパラメータはオプションです。使用する場合、このパラメータには 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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/CreateTieringConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/CreateTieringConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CreateTieringConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateTieringConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CreateTieringConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/CreateTieringConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/CreateTieringConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateTieringConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/CreateTieringConfiguration) 
+  [AWS SDK for Ruby V3](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>
たとえば、`arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50`などのバックアップ計画を一意に識別する Amazon リソースネーム (ARN) です。  
タイプ: 文字列

 ** [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>
一意のランダムに生成された UTF-8 エンコード Unicode 文字列 (最大 1,024 バイト長)。バージョン ID を編集することはできません。  
タイプ: 文字列

## エラー
<a name="API_DeleteBackupPlan_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** InvalidRequestException **   
リクエストへの入力に何らかの問題が発生していることを示します。たとえば、パラメータのタイプが間違っています。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_DeleteBackupPlan_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DeleteBackupPlan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DeleteBackupPlan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DeleteBackupPlan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DeleteBackupPlan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DeleteBackupPlan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DeleteBackupPlan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DeleteBackupPlan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DeleteBackupPlan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DeleteBackupPlan) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DeleteBackupPlan) 

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

`SelectionId` で指定されたバックアッププランに関連付けられているリソース選択を削除します。

## リクエストの構文
<a name="API_DeleteBackupSelection_RequestSyntax"></a>

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

## URI リクエストパラメータ
<a name="API_DeleteBackupSelection_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [backupPlanId](#API_DeleteBackupSelection_RequestSyntax) **   <a name="Backup-DeleteBackupSelection-request-uri-BackupPlanId"></a>
バックアップ計画を一意に識別します。  
必須: はい

 ** [selectionId](#API_DeleteBackupSelection_RequestSyntax) **   <a name="Backup-DeleteBackupSelection-request-uri-SelectionId"></a>
バックアップ計画に一連のリソースを割り当てるためのリクエストの本文を一意に識別します。  
必須: はい

## リクエストボディ
<a name="API_DeleteBackupSelection_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_DeleteBackupSelection_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## レスポンス要素
<a name="API_DeleteBackupSelection_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

## エラー
<a name="API_DeleteBackupSelection_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_DeleteBackupSelection_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DeleteBackupSelection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DeleteBackupSelection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DeleteBackupSelection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DeleteBackupSelection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DeleteBackupSelection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DeleteBackupSelection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DeleteBackupSelection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DeleteBackupSelection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DeleteBackupSelection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DeleteBackupSelection) 

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

名前で識別されるバックアップボールトを削除します。ボールトは、空である場合に限り、削除できます。

## リクエストの構文
<a name="API_DeleteBackupVault_RequestSyntax"></a>

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

## URI リクエストパラメータ
<a name="API_DeleteBackupVault_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [backupVaultName](#API_DeleteBackupVault_RequestSyntax) **   <a name="Backup-DeleteBackupVault-request-uri-BackupVaultName"></a>
バックアップを保存する論理コンテナの名前。バックアップボールトは、これらのボールトを作成するために使用されたアカウントと作成先の AWS リージョンに一意の名前で識別されます。  
必須: はい

## リクエストボディ
<a name="API_DeleteBackupVault_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_DeleteBackupVault_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## レスポンス要素
<a name="API_DeleteBackupVault_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

## エラー
<a name="API_DeleteBackupVault_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** InvalidRequestException **   
リクエストへの入力に何らかの問題が発生していることを示します。たとえば、パラメータのタイプが間違っています。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_DeleteBackupVault_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DeleteBackupVault) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DeleteBackupVault) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DeleteBackupVault) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DeleteBackupVault) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DeleteBackupVault) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DeleteBackupVault) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DeleteBackupVault) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DeleteBackupVault) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DeleteBackupVault) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DeleteBackupVault) 

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

バックアップボールトの権限を管理するポリシードキュメントを削除します。

## リクエストの構文
<a name="API_DeleteBackupVaultAccessPolicy_RequestSyntax"></a>

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

## URI リクエストパラメータ
<a name="API_DeleteBackupVaultAccessPolicy_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [backupVaultName](#API_DeleteBackupVaultAccessPolicy_RequestSyntax) **   <a name="Backup-DeleteBackupVaultAccessPolicy-request-uri-BackupVaultName"></a>
バックアップを保存する論理コンテナの名前。バックアップボールトは、これらのボールトを作成するために使用されたアカウントと作成先の AWS リージョンに一意の名前で識別されます。それらは、小文字の英文字、数字、およびハイフン (-) で構成されます。  
パターン: `^[a-zA-Z0-9\-\_]{2,50}$`   
必須: はい

## リクエストボディ
<a name="API_DeleteBackupVaultAccessPolicy_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_DeleteBackupVaultAccessPolicy_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## レスポンス要素
<a name="API_DeleteBackupVaultAccessPolicy_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

## エラー
<a name="API_DeleteBackupVaultAccessPolicy_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_DeleteBackupVaultAccessPolicy_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DeleteBackupVaultAccessPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DeleteBackupVaultAccessPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DeleteBackupVaultAccessPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DeleteBackupVaultAccessPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DeleteBackupVaultAccessPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DeleteBackupVaultAccessPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DeleteBackupVaultAccessPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DeleteBackupVaultAccessPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DeleteBackupVaultAccessPolicy) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DeleteBackupVaultLockConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DeleteBackupVaultLockConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DeleteBackupVaultLockConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DeleteBackupVaultLockConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DeleteBackupVaultLockConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DeleteBackupVaultLockConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DeleteBackupVaultLockConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DeleteBackupVaultLockConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DeleteBackupVaultLockConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DeleteBackupVaultLockConfiguration) 

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

指定されたバックアップボールトのイベント通知を削除します。

## リクエストの構文
<a name="API_DeleteBackupVaultNotifications_RequestSyntax"></a>

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

## URI リクエストパラメータ
<a name="API_DeleteBackupVaultNotifications_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [backupVaultName](#API_DeleteBackupVaultNotifications_RequestSyntax) **   <a name="Backup-DeleteBackupVaultNotifications-request-uri-BackupVaultName"></a>
バックアップを保存する論理コンテナの名前。バックアップボールトは、これらのボールトを作成するために使用されたアカウントと作成先の リージョンに一意の名前で識別されます。  
パターン: `^[a-zA-Z0-9\-\_]{2,50}$`   
必須: はい

## リクエストボディ
<a name="API_DeleteBackupVaultNotifications_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_DeleteBackupVaultNotifications_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## レスポンス要素
<a name="API_DeleteBackupVaultNotifications_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

## エラー
<a name="API_DeleteBackupVaultNotifications_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_DeleteBackupVaultNotifications_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DeleteBackupVaultNotifications) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DeleteBackupVaultNotifications) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DeleteBackupVaultNotifications) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DeleteBackupVaultNotifications) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DeleteBackupVaultNotifications) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DeleteBackupVaultNotifications) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DeleteBackupVaultNotifications) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DeleteBackupVaultNotifications) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DeleteBackupVaultNotifications) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DeleteBackupVaultNotifications) 

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

フレームワーク名で指定されたフレームワークを削除します。

## リクエストの構文
<a name="API_DeleteFramework_RequestSyntax"></a>

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

## URI リクエストパラメータ
<a name="API_DeleteFramework_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [frameworkName](#API_DeleteFramework_RequestSyntax) **   <a name="Backup-DeleteFramework-request-uri-FrameworkName"></a>
フレームワークの一意の名前。  
長さの制約: 最小長は 1 です。最大長は 256 です。  
パターン: `[a-zA-Z][_a-zA-Z0-9]*`   
必須: はい

## リクエストボディ
<a name="API_DeleteFramework_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_DeleteFramework_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## レスポンス要素
<a name="API_DeleteFramework_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

## エラー
<a name="API_DeleteFramework_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** ConflictException **   
 AWS Backup は、前のアクションの実行が完了するまで、リクエストしたアクションを実行できません。後でもう一度お試しください。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_DeleteFramework_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DeleteFramework) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DeleteFramework) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DeleteFramework) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DeleteFramework) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DeleteFramework) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DeleteFramework) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DeleteFramework) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DeleteFramework) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DeleteFramework) 
+  [AWS SDK for Ruby V3](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>
`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`などのリカバリポイントを一意に識別する Amazon リソースネーム (ARN) です。  
必須: はい

## リクエストボディ
<a name="API_DeleteRecoveryPoint_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_DeleteRecoveryPoint_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## レスポンス要素
<a name="API_DeleteRecoveryPoint_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

## エラー
<a name="API_DeleteRecoveryPoint_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** InvalidRequestException **   
リクエストへの入力に何らかの問題が発生していることを示します。たとえば、パラメータのタイプが間違っています。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** InvalidResourceStateException **   
 AWS Backup は、この復旧ポイントで既にアクションを実行しています。最初のアクションが終了するまで、リクエストしたアクションを実行できません。後でもう一度お試しください。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_DeleteRecoveryPoint_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DeleteRecoveryPoint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DeleteRecoveryPoint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DeleteRecoveryPoint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DeleteRecoveryPoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DeleteRecoveryPoint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DeleteRecoveryPoint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DeleteRecoveryPoint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DeleteRecoveryPoint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DeleteRecoveryPoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DeleteRecoveryPoint) 

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

レポートプラン名で指定されたレポートプランを削除します。

## リクエストの構文
<a name="API_DeleteReportPlan_RequestSyntax"></a>

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

## URI リクエストパラメータ
<a name="API_DeleteReportPlan_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [reportPlanName](#API_DeleteReportPlan_RequestSyntax) **   <a name="Backup-DeleteReportPlan-request-uri-ReportPlanName"></a>
レポートプランの一意の名前。  
長さの制約: 最小長は 1 です。最大長は 256 です。  
パターン: `[a-zA-Z][_a-zA-Z0-9]*`   
必須: はい

## リクエストボディ
<a name="API_DeleteReportPlan_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_DeleteReportPlan_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## レスポンス要素
<a name="API_DeleteReportPlan_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

## エラー
<a name="API_DeleteReportPlan_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** ConflictException **   
 AWS Backup は、前のアクションの実行が完了するまで、リクエストしたアクションを実行できません。後でもう一度お試しください。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_DeleteReportPlan_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DeleteReportPlan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DeleteReportPlan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DeleteReportPlan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DeleteReportPlan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DeleteReportPlan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DeleteReportPlan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DeleteReportPlan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DeleteReportPlan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DeleteReportPlan) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DeleteReportPlan) 

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

このリクエストは、指定された復元テストプランを削除します。

削除は、関連するすべての復元テスト選択を最初に削除した場合にのみ正常に行われます。

## リクエストの構文
<a name="API_DeleteRestoreTestingPlan_RequestSyntax"></a>

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

## URI リクエストパラメータ
<a name="API_DeleteRestoreTestingPlan_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [RestoreTestingPlanName](#API_DeleteRestoreTestingPlan_RequestSyntax) **   <a name="Backup-DeleteRestoreTestingPlan-request-uri-RestoreTestingPlanName"></a>
削除する復元テストプランの一意の名前 (必須) です。  
必須: はい

## リクエストボディ
<a name="API_DeleteRestoreTestingPlan_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_DeleteRestoreTestingPlan_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## レスポンス要素
<a name="API_DeleteRestoreTestingPlan_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 204 レスポンスを返します。

## エラー
<a name="API_DeleteRestoreTestingPlan_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidRequestException **   
リクエストへの入力に何らかの問題が発生していることを示します。たとえば、パラメータのタイプが間違っています。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_DeleteRestoreTestingPlan_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DeleteRestoreTestingPlan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DeleteRestoreTestingPlan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DeleteRestoreTestingPlan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DeleteRestoreTestingPlan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DeleteRestoreTestingPlan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DeleteRestoreTestingPlan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DeleteRestoreTestingPlan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DeleteRestoreTestingPlan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DeleteRestoreTestingPlan) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DeleteRestoreTestingPlan) 

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

復元テストプラン名と復元テスト選択名を入力します。

復元テストプランを削除する前に、復元テストプランに関連するすべてのテスト選択を削除する必要があります。

## リクエストの構文
<a name="API_DeleteRestoreTestingSelection_RequestSyntax"></a>

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

## URI リクエストパラメータ
<a name="API_DeleteRestoreTestingSelection_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [RestoreTestingPlanName](#API_DeleteRestoreTestingSelection_RequestSyntax) **   <a name="Backup-DeleteRestoreTestingSelection-request-uri-RestoreTestingPlanName"></a>
削除する復元テスト選択を含む復元テストプランの一意の名前 (必須) です。  
必須: はい

 ** [RestoreTestingSelectionName](#API_DeleteRestoreTestingSelection_RequestSyntax) **   <a name="Backup-DeleteRestoreTestingSelection-request-uri-RestoreTestingSelectionName"></a>
削除する復元テスト選択の一意の名前 (必須) です。  
必須: はい

## リクエストボディ
<a name="API_DeleteRestoreTestingSelection_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_DeleteRestoreTestingSelection_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## レスポンス要素
<a name="API_DeleteRestoreTestingSelection_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 204 レスポンスを返します。

## エラー
<a name="API_DeleteRestoreTestingSelection_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_DeleteRestoreTestingSelection_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DeleteRestoreTestingSelection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DeleteRestoreTestingSelection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DeleteRestoreTestingSelection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DeleteRestoreTestingSelection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DeleteRestoreTestingSelection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DeleteRestoreTestingSelection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DeleteRestoreTestingSelection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DeleteRestoreTestingSelection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DeleteRestoreTestingSelection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DeleteRestoreTestingSelection) 

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

階層設定名で指定された階層設定を削除します。

## リクエストの構文
<a name="API_DeleteTieringConfiguration_RequestSyntax"></a>

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

## URI リクエストパラメータ
<a name="API_DeleteTieringConfiguration_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [tieringConfigurationName](#API_DeleteTieringConfiguration_RequestSyntax) **   <a name="Backup-DeleteTieringConfiguration-request-uri-TieringConfigurationName"></a>
階層化設定の一意の名前。  
パターン: `^[a-zA-Z0-9_]{1,200}$`   
必須: はい

## リクエストボディ
<a name="API_DeleteTieringConfiguration_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_DeleteTieringConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## レスポンス要素
<a name="API_DeleteTieringConfiguration_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

## エラー
<a name="API_DeleteTieringConfiguration_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_DeleteTieringConfiguration_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DeleteTieringConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DeleteTieringConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DeleteTieringConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DeleteTieringConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DeleteTieringConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DeleteTieringConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DeleteTieringConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DeleteTieringConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DeleteTieringConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DeleteTieringConfiguration) 

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

指定された `BackupJobId` のバックアップジョブの詳細を返します。

## リクエストの構文
<a name="API_DescribeBackupJob_RequestSyntax"></a>

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

## URI リクエストパラメータ
<a name="API_DescribeBackupJob_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [backupJobId](#API_DescribeBackupJob_RequestSyntax) **   <a name="Backup-DescribeBackupJob-request-uri-BackupJobId"></a>
リソースをバックアップ AWS Backup するための へのリクエストを一意に識別します。  
必須: はい

## リクエストボディ
<a name="API_DescribeBackupJob_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_DescribeBackupJob_ResponseSyntax"></a>

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

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

## レスポンス要素
<a name="API_DescribeBackupJob_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [AccountId](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-AccountId"></a>
バックアップジョブを所有するアカウント ID を返します。  
タイプ: 文字列  
パターン: `^[0-9]{12}$` 

 ** [BackupJobId](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-BackupJobId"></a>
リソースをバックアップ AWS Backup するための へのリクエストを一意に識別します。  
タイプ: 文字列

 ** [BackupOptions](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-BackupOptions"></a>
バックアッププランまたはオンデマンドバックアップジョブの一部として指定されたオプションを表します。  
型: 文字列から文字列へのマッピング  
キーパターン: `^[a-zA-Z0-9\-\_\.]{1,50}$`   
値パターン:`^[a-zA-Z0-9\-\_\.]{1,50}$` 

 ** [BackupSizeInBytes](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-BackupSizeInBytes"></a>
バックアップ (復旧ポイント) のサイズ (バイト単位)。  
この値は、他の AWS サービスからデータ情報を AWS Backup プルするときに、リソースタイプに応じてレンダリングが異なる場合があります。例えば、返される値は `0` を示す場合があり、これは予想される値とは異なる場合があります。  
リソースタイプ別の値の予想される動作を以下に示します。  
+ Amazon Aurora、Amazon DocumentDB、および Amazon Neptune では、この値はオペレーション `GetBackupJobStatus` から入力されません。
+ 高度な機能を備えた Amazon DynamoDB の場合、この値は復旧ポイント (バックアップ) のサイズを示します。
+ Amazon EC2 と Amazon EBS は、この値の一部として返されるボリュームサイズ (プロビジョンドストレージ) を表示します。Amazon EBS はバックアップサイズ情報を返しません。スナップショットサイズは、バックアップされた元のリソースと同じ値になります。
+ Amazon EFS の場合、この値はバックアップ中に転送されたデルタバイト数を示します。
+ Amazon EKS の場合、この値はネストされた EKS 復旧ポイントのサイズを参照します。
+ Amazon FSx は、FSx ファイルシステムの `GetBackupJobStatus` オペレーションからこの値を入力しません。
+ Amazon RDS インスタンスは `0` と表示されます。
+ VMware を実行している仮想マシンの場合、この値は非同期ワークフローを介して AWS Backup に渡されます。これは、この表示される値が実際のバックアップサイズを過小表示する可能性があることを意味します。
タイプ: Long

 ** [BackupType](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-BackupType"></a>
バックアップジョブに対して選択された実際のバックアップタイプを表します。たとえば、Windows ボリュームシャドウコピーサービス (VSS) バックアップが正常に実行された場合、`BackupType` は `"WindowsVSS"` を返します。`BackupType`が空の場合、バックアップタイプは通常のバックアップでした。  
タイプ: 文字列

 ** [BackupVaultArn](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-BackupVaultArn"></a>
`arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`などのバックアップボールトを一意に識別する Amazon リソースネーム (ARN)。  
タイプ: 文字列

 ** [BackupVaultName](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-BackupVaultName"></a>
バックアップを保存する論理コンテナの名前。バックアップボールトは、これらのボールトを作成するために使用されたアカウントと作成先の AWS リージョンに一意の名前で識別されます。  
タイプ: 文字列  
パターン: `^[a-zA-Z0-9\-\_]{2,50}$` 

 ** [BytesTransferred](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-BytesTransferred"></a>
ジョブステータスの照会時にバックアップボールトに転送されたバイト単位のサイズ。  
タイプ: Long

 ** [ChildJobsInState](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-ChildJobsInState"></a>
これにより、含まれている子 (ネストされた) バックアップジョブの統計が返されます。  
タイプ: 文字列を long にマッピング  
有効なキー: `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>
たとえば、`arn:aws:iam::123456789012:role/S3Access`などのターゲットリカバリポイントの作成に使用する IAM ロール ARN を指定します。  
タイプ: 文字列

 ** [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` があります。使用可能な MessageCategory 文字列のリストについては、「[モニタリング](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html)」を参照してください。  
タイプ: 文字列

 ** [NumberOfChildJobs](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-NumberOfChildJobs"></a>
これにより、子 (ネストされた) バックアップジョブの数が返されます。  
タイプ: Long

 ** [ParentJobId](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-ParentJobId"></a>
これにより、親 (複合) リソースのバックアップジョブ ID が返されます。  
タイプ: 文字列

 ** [PercentDone](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-PercentDone"></a>
ジョブのステータスが照会された時点でジョブが完了した推定パーセンテージが含まれます。  
タイプ: 文字列

 ** [RecoveryPointArn](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-RecoveryPointArn"></a>
たとえば、`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`などのリカバリポイントを一意に識別する ARN。  
タイプ: 文字列

 ** [RecoveryPointLifecycle](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-RecoveryPointLifecycle"></a>
復旧ポイントがコールドストレージに移行するまでの期間、または削除されるまでの期間を日数で指定します。  
コールドストレージに移行するバックアップは、最低 90 日間コールドストレージに保存する必要があります。したがって、コンソール上での保持期間の設定は、コールドへの移行 (日数) 設定から 90 日長くする必要があります。バックアップがコールドに移行された後で、コールドへの移行 (日数) の設定を変更することはできません。  
コールドストレージに移行できるリソースタイプは、[Feature availability by resource](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource) table. AWS Backup ignores this expression for other resource types にリストされています。  
既存のライフサイクルと保持期間を削除し、復旧ポイントを無期限に保持するには、`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 Elastic Block Store (Amazon EBS) ボリュームや Amazon Relational Database Service (Amazon RDS) データベースなど。  
タイプ: 文字列  
パターン: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

 ** [StartBy](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-StartBy"></a>
バックアップジョブがキャンセルされる前に開始する必要がある時刻を Unix 形式および協定世界時 (UTC) で指定します。この値は、スケジュールされた時刻に開始ウィンドウを追加して計算されます。そのため、予定時刻が午後6時でスタートウィンドウが2時間であれば、`StartBy`時刻は指定された日付の午後 8: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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeBackupJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeBackupJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeBackupJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeBackupJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeBackupJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeBackupJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeBackupJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeBackupJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeBackupJob) 
+  [AWS SDK for Ruby V3](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>
`arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`などのバックアップボールトを一意に識別する Amazon リソースネーム (ARN)。  
タイプ: 文字列

 ** [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>
リクエストを識別するための一意の文字列で、失敗したリクエストを再試行する際に、オペレーションを2回実行するリスクを回避することができます。このパラメータはオプションです。使用する場合、このパラメータには 1～50 文字の英数字または「-\$1」を含める必要があります 。  
タイプ: 文字列

 ** [EncryptionKeyArn](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-EncryptionKeyArn"></a>
たとえば、`arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab` などのバックアップを保護するために使用されるサーバー側の暗号化キーです。  
タイプ: 文字列

 ** [EncryptionKeyType](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-EncryptionKeyType"></a>
バックアップボールトに使用される暗号化キーのタイプ。有効な値は、カスタマーマネージドキーの場合は CUSTOMER\$1MANAGED\$1KMS\$1KEY、所有キーの場合は AWS\$1OWNED\$1KMS\$1KEY 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 ボールトロックが現在バックアップボールトを保護しているかどうかを示すブール値。 は、ボールトロックがボールトに保存されている復旧ポイントの削除または更新オペレーションを失敗させる`True`ことを意味します。  
タイプ: ブール値

 ** [MaxRetentionDays](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-MaxRetentionDays"></a>
 AWS Backup ボールトが復旧ポイントを保持する最大保持期間を指定するボールトロック設定。このパラメータを指定しない場合、Vault Lock はボールト内のリカバリポイントに最大保持期間を強制しません (無期限ストレージを許可)。  
指定した場合、ボールトへのバックアップジョブもしくはコピージョブには、保存期間が最大保存期間と同等もしくは以下のライフサイクル・ポリシーを持つ必要があります。ジョブの保持期間がその最大保存期間よりも長い場合、ボールトはバックアップジョブもしくはコピージョブに失敗するため、ライフサイクル設定を変更するか、別のボールトを使用する必要があります。ボールトロックの前にボールトにすでに格納されているリカバリポイントは影響を受けません。  
タイプ: Long

 ** [MinRetentionDays](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-MinRetentionDays"></a>
 AWS Backup ボールトが復旧ポイントを保持する最小保持期間を指定するボールトロック設定。このパラメータを指定しない場合、ボールトロックは最小保持期間を強制しません。  
指定した場合、ボールトへのバックアップジョブまたはコピージョブには、最小保存期間以上の保存期間を持つライフサイクルポリシーが必要です。ジョブの保持期間がその最小保存期間より短い場合、ボールトはバックアップジョブまたはコピージョブに失敗するため、ライフサイクル設定を変更するか、別のボールトを使用する必要があります。ボールトロックの前にボールトにすでに格納されているリカバリポイントは影響を受けません。  
タイプ: Long

 ** [MpaApprovalTeamArn](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-MpaApprovalTeamArn"></a>
このバックアップボールトに関連付けられた MPA 承認チームの ARN。  
タイプ: 文字列

 ** [MpaSessionArn](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-MpaSessionArn"></a>
このバックアップボールトに関連付けられた MPA セッションの ARN。  
タイプ: 文字列

 ** [NumberOfRecoveryPoints](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-NumberOfRecoveryPoints"></a>
バックアップボールトに保存されているリカバリーポイントの数です。  
コンソールに表示される復旧ポイント数の値は、概算値である場合があります。正確な数を取得するには、[https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListRecoveryPointsByBackupVault.html](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListRecoveryPointsByBackupVault.html) API を使用します。  
タイプ: Long

 ** [SourceBackupVaultArn](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-SourceBackupVaultArn"></a>
この復元アクセスバックアップボールトが作成されたソースバックアップボールトの ARN。  
タイプ: 文字列

 ** [VaultState](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-VaultState"></a>
ボールトの現在の状態。->  
型: 文字列  
有効な値：`CREATING | AVAILABLE | FAILED`

 ** [VaultType](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-VaultType"></a>
説明されているボールトのタイプ。  
型: 文字列  
有効な値：`BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT | RESTORE_ACCESS_BACKUP_VAULT`

## エラー
<a name="API_DescribeBackupVault_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_DescribeBackupVault_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeBackupVault) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeBackupVault) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeBackupVault) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeBackupVault) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeBackupVault) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeBackupVault) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeBackupVault) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeBackupVault) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeBackupVault) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeBackupVault) 

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

リソースのコピーの作成に関連するメタデータを返します。

## リクエストの構文
<a name="API_DescribeCopyJob_RequestSyntax"></a>

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

## URI リクエストパラメータ
<a name="API_DescribeCopyJob_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [copyJobId](#API_DescribeCopyJob_RequestSyntax) **   <a name="Backup-DescribeCopyJob-request-uri-CopyJobId"></a>
コピージョブを一意に識別する。  
必須: はい

## リクエストボディ
<a name="API_DescribeCopyJob_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_DescribeCopyJob_ResponseSyntax"></a>

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

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

## レスポンス要素
<a name="API_DescribeCopyJob_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [CopyJob](#API_DescribeCopyJob_ResponseSyntax) **   <a name="Backup-DescribeCopyJob-response-CopyJob"></a>
コピージョブに関する詳細情報が含まれています。  
型: [CopyJob](API_CopyJob.md) オブジェクト

## エラー
<a name="API_DescribeCopyJob_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_DescribeCopyJob_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeCopyJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeCopyJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeCopyJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeCopyJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeCopyJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeCopyJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeCopyJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeCopyJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeCopyJob) 
+  [AWS SDK for Ruby V3](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 時 (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 です。最大長は 1,024 です。  
パターン: `.*\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>
フレームワークは、1 つ以上のコントロールで構成されます。各コントロールは、バックアッププラン、バックアップ選択、バックアップボールト、復旧ポイントなどのリソースを管理します。また、各リソースの AWS Config 録音をオンまたはオフに切り替えることもできます。ステータスは次のとおりです。  
+  `ACTIVE`フレームワークによって管理されるすべてのリソースで記録が有効になっている場合。
+  `PARTIALLY_ACTIVE`フレームワークによって管理されている少なくとも 1 つのリソースについて記録がオフになっている場合。
+  `INACTIVE`フレームワークによって管理されるすべてのリソースで記録がオフになっている場合。
+  `UNAVAILABLE` この時点で AWS Backup が記録ステータスを検証できない場合。
タイプ: 文字列

 ** [IdempotencyToken](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-IdempotencyToken"></a>
別の `DescribeFrameworkOutput` への同じコール間を区別するために使用できる顧客が選択した文字列。同じ冪等性トークンで成功したリクエストを再試行すると、アクションは実行されず、成功メッセージが表示されます。  
タイプ: 文字列

## エラー
<a name="API_DescribeFramework_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_DescribeFramework_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeFramework) 

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

 AWS クロスアカウントバックアップ、マルチパーティー承認、委任管理者など、アカウントがさまざまなクロスアカウント管理オプションを有効にしているかどうかについて説明します。アカウントが組織のメンバーでない場合、エラーを返します。例: `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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeGlobalSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeGlobalSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeGlobalSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeGlobalSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeGlobalSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeGlobalSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeGlobalSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeGlobalSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeGlobalSettings) 
+  [AWS SDK for Ruby V3](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>
直近の復元ジョブが完了するまでにかかった時間 (分)。  
タイプ: Long

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

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeProtectedResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeProtectedResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeProtectedResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeProtectedResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeProtectedResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeProtectedResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeProtectedResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeProtectedResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeProtectedResource) 
+  [AWS SDK for Ruby V3](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>
`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`などのリカバリポイントを一意に識別する Amazon リソースネーム (ARN) です。  
必須: はい

## リクエストボディ
<a name="API_DescribeRecoveryPoint_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_DescribeRecoveryPoint_ResponseSyntax"></a>

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

{
   "BackupSizeInBytes": number,
   "BackupVaultArn": "string",
   "BackupVaultName": "string",
   "CalculatedLifecycle": { 
      "DeleteAt": number,
      "MoveToColdStorageAt": number
   },
   "CompletionDate": number,
   "CompositeMemberIdentifier": "string",
   "CreatedBy": { 
      "BackupPlanArn": "string",
      "BackupPlanId": "string",
      "BackupPlanName": "string",
      "BackupPlanVersion": "string",
      "BackupRuleCron": "string",
      "BackupRuleId": "string",
      "BackupRuleName": "string",
      "BackupRuleTimezone": "string"
   },
   "CreationDate": number,
   "EncryptionKeyArn": "string",
   "EncryptionKeyType": "string",
   "IamRoleArn": "string",
   "IndexStatus": "string",
   "IndexStatusMessage": "string",
   "InitiationDate": number,
   "IsEncrypted": boolean,
   "IsParent": boolean,
   "LastRestoreTime": number,
   "Lifecycle": { 
      "DeleteAfterDays": number,
      "DeleteAfterEvent": "string",
      "MoveToColdStorageAfterDays": number,
      "OptInToArchiveForSupportedResources": boolean
   },
   "ParentRecoveryPointArn": "string",
   "RecoveryPointArn": "string",
   "ResourceArn": "string",
   "ResourceName": "string",
   "ResourceType": "string",
   "ScanResults": [ 
      { 
         "Findings": [ "string" ],
         "LastScanTimestamp": number,
         "MalwareScanner": "string",
         "ScanJobState": "string"
      }
   ],
   "SourceBackupVaultArn": "string",
   "Status": "string",
   "StatusMessage": "string",
   "StorageClass": "string",
   "VaultType": "string"
}
```

## レスポンス要素
<a name="API_DescribeRecoveryPoint_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [BackupSizeInBytes](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-BackupSizeInBytes"></a>
バックアップのサイズ (バイト単位)。  
タイプ: Long

 ** [BackupVaultArn](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-BackupVaultArn"></a>
バックアップボールトを一意に識別する ARN、例えば、`arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault` です。  
タイプ: 文字列

 ** [BackupVaultName](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-BackupVaultName"></a>
バックアップを保存する論理コンテナの名前。バックアップボールトは、これらのボールトを作成するために使用されたアカウントと作成先の リージョンに一意の名前で識別されます。  
タイプ: 文字列  
パターン: `^[a-zA-Z0-9\-\_]{2,50}$` 

 ** [CalculatedLifecycle](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-CalculatedLifecycle"></a>
`DeleteAt` および `MoveToColdStorageAt` タイムスタンプを含む `CalculatedLifecycle` オブジェクト。  
型: [CalculatedLifecycle](API_CalculatedLifecycle.md) オブジェクト

 ** [CompletionDate](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-CompletionDate"></a>
Unix 形式および協定世界時 (UTC)で、リカバリポイントを作成するジョブが完了した日時。`CompletionDate`の値はミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。  
タイプ: タイムスタンプ

 ** [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、所有キーの場合は AWS\$1OWNED\$1KMS\$1KEY 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 日以上あける必要があります。バックアップがコールドに移行された後で、「コールドへの移行 (日数)」設定を変更することはできません。  
コールドストレージに移行できるリソースタイプは、「[Feature availability by resource](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource) table. AWS Backup ignores this expression for other resource types」に記載されています。  
型: [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:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`などのリカバリポイントを一意に識別する ARN。  
タイプ: 文字列

 ** [ResourceArn](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-ResourceArn"></a>
保存済みのリソースを一意に識別する ARN。ARN の形式は、リソースタイプによって異なります。  
タイプ: 文字列

 ** [ResourceName](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-ResourceName"></a>
指定されたバックアップに属するリソースの名前。  
タイプ: 文字列

 ** [ResourceType](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-ResourceType"></a>
復旧ポイントとして保存する AWS リソースのタイプ。Amazon Elastic Block Store (Amazon EBS) ボリュームや Amazon Relational Database Service (Amazon RDS) データベースなど。  
タイプ: 文字列  
パターン: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

 ** [ScanResults](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-ScanResults"></a>
復旧ポイントに対する最新のスキャン結果が含まれ、現在 `MalwareScanner`、`ScanJobState`、`Findings`、 が含まれます。 `LastScanTimestamp`  
型: [ScanResult](API_ScanResult.md) オブジェクトの配列  
配列メンバー: 最小数は 0 項目です。最大数は 5 項目です。

 ** [SourceBackupVaultArn](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-SourceBackupVaultArn"></a>
たとえば、`arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault` などのリソースが最初にバックアップされたソースボールトを一意に識別する Amazon リソースネーム (ARN)。復旧が同じ AWS アカウントまたはリージョンに復元された場合、この値は になります`null`。  
タイプ: 文字列

 ** [Status](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-Status"></a>
リカバリポイントの状態を指定するステータスコード。詳細については、「 * AWS Backup デベロッパーガイド*」の[「復旧ポイントのステータス](https://docs.aws.amazon.com/aws-backup/latest/devguide/applicationstackbackups.html#cfnrecoverypointstatus)」を参照してください。  
+  `CREATING` ステータスは、リソースに対して AWS Backup ジョブが開始されたことを示します。バックアッププロセスが開始され、関連する復旧ポイントのバックアップジョブがアクティブに処理されています。
+  `AVAILABLE` ステータスは、復旧ポイントのバックアップが正常に作成されたことを示します。バックアッププロセスは問題なく完了し、復旧ポイントを使用できるようになりました。
+  `PARTIAL` ステータスは、複合復旧ポイントに、バックアップにないネストされた復旧ポイントが 1 つ以上あることを示します。
+  `EXPIRED` status は、復旧ポイントが保持期間を超過したが、アクセス許可 AWS Backup がないか、削除できないことを示します。これらの復旧ポイントを手動で削除するには、「開始方法」の「リソースのクリーンアップ」セクションの「[ステップ 3: 復旧ポイントの削除](https://docs.aws.amazon.com/aws-backup/latest/devguide/gs-cleanup-resources.html#cleanup-backups)」を参照してください。****
+  `STOPPED` ステータスは、継続的バックアップが無効になるような操作をユーザーが行った場合の継続的バックアップ時に発生します。これは、アクセス許可の削除、バージョニングの無効化、EventBridge に送信されるイベントの無効化、または AWS Backupによって設定された EventBridge ルールの無効化によって発生する可能性があります。Amazon S3、Amazon RDS、Amazon Aurora リソースの復旧ポイントの場合、このステータスは、継続的バックアップルールの保持期間が変更されたときに発生します。

  `STOPPED` ステータスを解決するには、要求されたアクセス許可がすべて揃っていて、S3 バケットでバージョニングが有効になっていることを確認してください。これらの条件が満たされると、実行されるバックアップルールの次のインスタンスでは、新しい継続的復旧ポイントが作成されます。停止ステータスの復旧ポイントは削除する必要はありません。

  Amazon EC2 上の SAP HANA では、ユーザーアクション、アプリケーションの設定ミス、またはバックアップ障害が原因で `STOPPED` ステータスが発生します。将来の継続的バックアップを確実に成功させるには、復旧ポイントのステータスを参照し、SAP HANA で詳細を確認してください。
型: 文字列  
有効な値：`COMPLETED | PARTIAL | DELETING | EXPIRED | AVAILABLE | STOPPED | CREATING`

 ** [StatusMessage](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-StatusMessage"></a>
復旧ポイントのステータスを説明する詳細なメッセージです。  
タイプ: 文字列

 ** [StorageClass](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-StorageClass"></a>
リカバリポイントのストレージクラスを指定します。有効な値は `WARM` または `COLD` です。  
型: 文字列  
有効な値：`WARM | COLD | DELETED`

 ** [VaultType](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-VaultType"></a>
対象の復旧ポイントが保存されているボールトのタイプ。  
型: 文字列  
有効な値：`BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT | RESTORE_ACCESS_BACKUP_VAULT`

## エラー
<a name="API_DescribeRecoveryPoint_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_DescribeRecoveryPoint_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeRecoveryPoint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeRecoveryPoint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeRecoveryPoint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeRecoveryPoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeRecoveryPoint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeRecoveryPoint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeRecoveryPoint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeRecoveryPoint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeRecoveryPoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeRecoveryPoint) 

# DescribeRegionSettings
<a name="API_DescribeRegionSettings"></a>

リージョンの現在のサービスオプトイン設定を返します。サービスでサービスオプトインが有効になっている場合、 は、リソースがオンデマンドバックアップまたはスケジュールされたバックアッププランに含まれているときに、このリージョンでそのサービスのリソースを保護し AWS Backup ようとします。それ以外の場合は、 AWS Backup は、このリージョンのそのサービスのリソースを保護しようとしません。

## リクエストの構文
<a name="API_DescribeRegionSettings_RequestSyntax"></a>

```
GET /account-settings HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_DescribeRegionSettings_RequestParameters"></a>

リクエストでは URI パラメータを使用しません。

## リクエストボディ
<a name="API_DescribeRegionSettings_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_DescribeRegionSettings_ResponseSyntax"></a>

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

{
   "ResourceTypeManagementPreference": { 
      "string" : boolean 
   },
   "ResourceTypeOptInPreference": { 
      "string" : boolean 
   }
}
```

## レスポンス要素
<a name="API_DescribeRegionSettings_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [ResourceTypeManagementPreference](#API_DescribeRegionSettings_ResponseSyntax) **   <a name="Backup-DescribeRegionSettings-response-ResourceTypeManagementPreference"></a>
がリソースタイプのバックアップ AWS Backup を完全に管理するかどうかを返します。  
フル AWS Backup 管理の利点については、[「フル AWS Backup 管理](https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#full-management)」を参照してください。  
リソースタイプのリストと、それぞれが完全な AWS Backup 管理をサポートしているかどうかについては、[「リソースごとの機能の可用性](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource)」表を参照してください。  
の場合`"DynamoDB":false`、 の高度な DynamoDB バックアップ機能を有効にすることで、DynamoDB バックアップの完全な AWS Backup 管理を有効にできます。 [AWS Backup DynamoDB ](https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html#advanced-ddb-backup-enable-cli)  
タイプ:ブールマップへの文字列。  
キーパターン: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

 ** [ResourceTypeOptInPreference](#API_DescribeRegionSettings_ResponseSyntax) **   <a name="Backup-DescribeRegionSettings-response-ResourceTypeOptInPreference"></a>
サービスと、リージョンのオプトイン設定。  
タイプ:ブールマップへの文字列。  
キーパターン: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

## エラー
<a name="API_DescribeRegionSettings_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_DescribeRegionSettings_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeRegionSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeRegionSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeRegionSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeRegionSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeRegionSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeRegionSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeRegionSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeRegionSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeRegionSettings) 
+  [AWS SDK for Ruby V3](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>
レポートジョブの識別子。一意のランダムに生成された UTF-8 エンコード Unicode 文字列 (最大 1,024 バイト長)。レポートジョブ ID を編集することはできません。  
必須: はい

## リクエストボディ
<a name="API_DescribeReportJob_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_DescribeReportJob_ResponseSyntax"></a>

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

{
   "ReportJob": { 
      "CompletionTime": number,
      "CreationTime": number,
      "ReportDestination": { 
         "S3BucketName": "string",
         "S3Keys": [ "string" ]
      },
      "ReportJobId": "string",
      "ReportPlanArn": "string",
      "ReportTemplate": "string",
      "Status": "string",
      "StatusMessage": "string"
   }
}
```

## レスポンス要素
<a name="API_DescribeReportJob_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [ReportJob](#API_DescribeReportJob_ResponseSyntax) **   <a name="Backup-DescribeReportJob-response-ReportJob"></a>
レポートジョブの完了と作成時刻、レポートの送信先、一意のレポートジョブ ID、Amazon リソースネーム (ARN)、レポートテンプレート、ステータス、ステータスメッセージなど、レポートジョブに関する情報。  
型: [ReportJob](API_ReportJob.md) オブジェクト

## エラー
<a name="API_DescribeReportJob_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_DescribeReportJob_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeReportJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeReportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeReportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeReportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeReportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeReportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeReportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeReportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeReportJob) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeReportPlan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeReportPlan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeReportPlan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeReportPlan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeReportPlan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeReportPlan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeReportPlan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeReportPlan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeReportPlan) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeReportPlan) 

# DescribeRestoreJob
<a name="API_DescribeRestoreJob"></a>

ジョブ ID で指定された復元ジョブに関連付けられたメタデータを返します。

## リクエストの構文
<a name="API_DescribeRestoreJob_RequestSyntax"></a>

```
GET /restore-jobs/restoreJobId HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_DescribeRestoreJob_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [restoreJobId](#API_DescribeRestoreJob_RequestSyntax) **   <a name="Backup-DescribeRestoreJob-request-uri-RestoreJobId"></a>
リカバリポイントを復元するジョブを一意に識別します。  
必須: はい

## リクエストボディ
<a name="API_DescribeRestoreJob_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_DescribeRestoreJob_ResponseSyntax"></a>

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

{
   "AccountId": "string",
   "BackupSizeInBytes": number,
   "BackupVaultArn": "string",
   "CompletionDate": number,
   "CreatedBy": { 
      "RestoreTestingPlanArn": "string"
   },
   "CreatedResourceArn": "string",
   "CreationDate": number,
   "DeletionStatus": "string",
   "DeletionStatusMessage": "string",
   "ExpectedCompletionTimeMinutes": number,
   "IamRoleArn": "string",
   "IsParent": boolean,
   "ParentJobId": "string",
   "PercentDone": "string",
   "RecoveryPointArn": "string",
   "RecoveryPointCreationDate": number,
   "ResourceType": "string",
   "RestoreJobId": "string",
   "SourceResourceArn": "string",
   "Status": "string",
   "StatusMessage": "string",
   "ValidationStatus": "string",
   "ValidationStatusMessage": "string"
}
```

## レスポンス要素
<a name="API_DescribeRestoreJob_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [AccountId](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-AccountId"></a>
復元ジョブを所有するアカウント ID を返します。  
タイプ: 文字列  
パターン: `^[0-9]{12}$` 

 ** [BackupSizeInBytes](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-BackupSizeInBytes"></a>
復元されたリソースのサイズ (バイト単位)。  
タイプ: Long

 ** [BackupVaultArn](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-BackupVaultArn"></a>
復元される復旧ポイントを含むバックアップボールトの Amazon リソースネーム (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>
リカバリーポイントを復元するジョブに要する予想される分単位の時間です。  
タイプ: Long

 ** [IamRoleArn](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-IamRoleArn"></a>
たとえば、`arn:aws:iam::123456789012:role/S3Access`などのターゲットリカバリポイントの作成に使用する IAM ロール ARN を指定します。  
タイプ: 文字列

 ** [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:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`などのリカバリポイントを一意に識別する ARN。  
タイプ: 文字列

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

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeRestoreJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeRestoreJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeRestoreJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeRestoreJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeRestoreJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeRestoreJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeRestoreJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeRestoreJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeRestoreJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeRestoreJob) 

# DescribeScanJob
<a name="API_DescribeScanJob"></a>

指定された ScanJobID のスキャンジョブの詳細を返します。

## リクエストの構文
<a name="API_DescribeScanJob_RequestSyntax"></a>

```
GET /scan/jobs/ScanJobId HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_DescribeScanJob_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [ScanJobId](#API_DescribeScanJob_RequestSyntax) **   <a name="Backup-DescribeScanJob-request-uri-ScanJobId"></a>
リソースをスキャン AWS Backup する へのリクエストを一意に識別します。  
必須: はい

## リクエストボディ
<a name="API_DescribeScanJob_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_DescribeScanJob_ResponseSyntax"></a>

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

{
   "AccountId": "string",
   "BackupVaultArn": "string",
   "BackupVaultName": "string",
   "CompletionDate": number,
   "CreatedBy": { 
      "BackupPlanArn": "string",
      "BackupPlanId": "string",
      "BackupPlanVersion": "string",
      "BackupRuleId": "string"
   },
   "CreationDate": number,
   "IamRoleArn": "string",
   "MalwareScanner": "string",
   "RecoveryPointArn": "string",
   "ResourceArn": "string",
   "ResourceName": "string",
   "ResourceType": "string",
   "ScanBaseRecoveryPointArn": "string",
   "ScanId": "string",
   "ScanJobId": "string",
   "ScanMode": "string",
   "ScannerRoleArn": "string",
   "ScanResult": { 
      "ScanResultStatus": "string"
   },
   "State": "string",
   "StatusMessage": "string"
}
```

## レスポンス要素
<a name="API_DescribeScanJob_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [AccountId](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-AccountId"></a>
スキャンジョブを所有するアカウント ID を返します。  
パターン: `^[0-9]{12}$`   
タイプ: 文字列

 ** [BackupVaultArn](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-BackupVaultArn"></a>
バックアップボールトを一意に識別する Amazon リソースネーム (ARN)。例: `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`   
タイプ: 文字列

 ** [BackupVaultName](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-BackupVaultName"></a>
バックアップを保存する論理コンテナの名前。バックアップボールトは、作成に使用したアカウントと作成先の AWS リージョンに固有の名前で識別されます。  
パターン: `^[a-zA-Z0-9\-\_\.]{2,50}$`   
タイプ: 文字列

 ** [CompletionDate](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-CompletionDate"></a>
バックアップインデックスの作成が終了した日時 (Unix 時刻形式および協定世界時 (UTC))。`CompletionDate` の値は、ミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。  
タイプ: タイムスタンプ

 ** [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>
`arn:aws:iam::123456789012:role/S3Access`などのバックアップボールトを一意に識別する Amazon リソースネーム (ARN)。  
タイプ: 文字列

 ** [MalwareScanner](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-MalwareScanner"></a>
対応するスキャンジョブに使用されるスキャンエンジン。現在は、`GUARDUTY` のみがサポートされます。  
型: 文字列  
有効な値：`GUARDDUTY`

 ** [RecoveryPointArn](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-RecoveryPointArn"></a>
スキャンするターゲット復旧ポイントを一意に識別する ARN。例: `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`。  
タイプ: 文字列

 ** [ResourceArn](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ResourceArn"></a>
対応する復旧ポイント ARN のソースリソースを一意に識別する ARN。  
タイプ: 文字列

 ** [ResourceName](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ResourceName"></a>
指定されたバックアップに属するリソースの一意ではない名前。  
タイプ: 文字列

 ** [ResourceType](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ResourceType"></a>
バックアップする AWS リソースのタイプ。Amazon Elastic Block Store (Amazon EBS) ボリュームなど。  
パターン: `^[a-zA-Z0-9\-\_\.]{1,50}$`   
型: 文字列  
有効な値：`EBS | EC2 | S3`

 ** [ScanBaseRecoveryPointArn](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ScanBaseRecoveryPointArn"></a>
スキャンの基本復旧ポイントを一意に識別する ARN。このフィールドは、増分スキャンジョブが実行された場合にのみ入力されます。  
タイプ: 文字列

 ** [ScanId](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ScanId"></a>
対応するスキャンジョブ ID リクエストの送信元として Amazon GuardDuty によって生成されたスキャン ID AWS Backup。  
タイプ: 文字列

 ** [ScanJobId](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ScanJobId"></a>
リクエストを一意に識別したスキャンジョブ ID AWS Backup。  
タイプ: 文字列

 ** [ScanMode](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ScanMode"></a>
スキャンジョブに使用されるスキャンタイプを指定します。  
型: 文字列  
有効な値：`FULL_SCAN | INCREMENTAL_SCAN`

 ** [ScannerRoleArn](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ScannerRoleArn"></a>
スキャンジョブに使用するスキャナー IAM ロール ARN を指定します。  
タイプ: 文字列

 ** [ScanResult](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ScanResult"></a>
 スキャンジョブ`ScanResultsStatus`の が含まれ、完了したジョブ`NO_THREATS_FOUND`の `THREATS_FOUND`または を返します。  
型: [ScanResultInfo](API_ScanResultInfo.md) オブジェクト

 ** [State](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-State"></a>
スキャンジョブの現在の状態。  
型: 文字列  
有効な値：`CANCELED | COMPLETED | COMPLETED_WITH_ISSUES | CREATED | FAILED | RUNNING`

 ** [StatusMessage](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-StatusMessage"></a>
リソースをバックアップするジョブのステータスを説明する詳細なメッセージ。　  
タイプ: 文字列

## エラー
<a name="API_DescribeScanJob_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_DescribeScanJob_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeScanJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeScanJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeScanJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeScanJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeScanJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeScanJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeScanJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeScanJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeScanJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeScanJob) 

# DisassociateBackupVaultMpaApprovalTeam
<a name="API_DisassociateBackupVaultMpaApprovalTeam"></a>

MPA 承認チームとバックアップボールトの関連付けを削除し、復元オペレーションの MPA 承認ワークフローを無効にします。

## リクエストの構文
<a name="API_DisassociateBackupVaultMpaApprovalTeam_RequestSyntax"></a>

```
POST /backup-vaults/backupVaultName/mpaApprovalTeam?delete HTTP/1.1
Content-type: application/json

{
   "RequesterComment": "string"
}
```

## URI リクエストパラメータ
<a name="API_DisassociateBackupVaultMpaApprovalTeam_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [backupVaultName](#API_DisassociateBackupVaultMpaApprovalTeam_RequestSyntax) **   <a name="Backup-DisassociateBackupVaultMpaApprovalTeam-request-uri-BackupVaultName"></a>
MPA 承認チームの関連付けを解除するバックアップボールトの名前。  
パターン: `^[a-zA-Z0-9\-\_]{2,50}$`   
必須: はい

## リクエストボディ
<a name="API_DisassociateBackupVaultMpaApprovalTeam_RequestBody"></a>

リクエストは以下の JSON 形式のデータを受け入れます。

 ** [RequesterComment](#API_DisassociateBackupVaultMpaApprovalTeam_RequestSyntax) **   <a name="Backup-DisassociateBackupVaultMpaApprovalTeam-request-RequesterComment"></a>
バックアップボールトから MPA 承認チームの関連付けを解除する理由を説明するオプションのコメント。  
タイプ: 文字列  
必須: いいえ

## レスポンスの構文
<a name="API_DisassociateBackupVaultMpaApprovalTeam_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## レスポンス要素
<a name="API_DisassociateBackupVaultMpaApprovalTeam_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 204 レスポンスを返します。

## エラー
<a name="API_DisassociateBackupVaultMpaApprovalTeam_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** InvalidRequestException **   
リクエストへの入力に何らかの問題が発生していることを示します。たとえば、パラメータのタイプが間違っています。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_DisassociateBackupVaultMpaApprovalTeam_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DisassociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DisassociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DisassociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DisassociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DisassociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DisassociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DisassociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DisassociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DisassociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DisassociateBackupVaultMpaApprovalTeam) 

# DisassociateRecoveryPoint
<a name="API_DisassociateRecoveryPoint"></a>

指定された継続的バックアップ復旧ポイントを から削除 AWS Backup し、その継続的バックアップの制御を Amazon RDS などのソースサービスに解放します。ソースサービスは、元のバックアッププランで指定したライフサイクルを使用して、継続的なバックアップを作成および保持します。

スナップショットバックアップリカバリポイントはサポートされていません。

## リクエストの構文
<a name="API_DisassociateRecoveryPoint_RequestSyntax"></a>

```
POST /backup-vaults/backupVaultName/recovery-points/recoveryPointArn/disassociate HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_DisassociateRecoveryPoint_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [backupVaultName](#API_DisassociateRecoveryPoint_RequestSyntax) **   <a name="Backup-DisassociateRecoveryPoint-request-uri-BackupVaultName"></a>
 AWS Backup ボールトの一意の名前。  
パターン: `^[a-zA-Z0-9\-\_]{2,50}$`   
必須: はい

 ** [recoveryPointArn](#API_DisassociateRecoveryPoint_RequestSyntax) **   <a name="Backup-DisassociateRecoveryPoint-request-uri-RecoveryPointArn"></a>
 AWS Backup 復旧ポイントを一意に識別する Amazon リソースネーム (ARN)。  
必須: はい

## リクエストボディ
<a name="API_DisassociateRecoveryPoint_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_DisassociateRecoveryPoint_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## レスポンス要素
<a name="API_DisassociateRecoveryPoint_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

## エラー
<a name="API_DisassociateRecoveryPoint_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** InvalidRequestException **   
リクエストへの入力に何らかの問題が発生していることを示します。たとえば、パラメータのタイプが間違っています。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** InvalidResourceStateException **   
 AWS Backup は、この復旧ポイントで既にアクションを実行しています。最初のアクションが終了するまで、リクエストしたアクションを実行できません。後でもう一度お試しください。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_DisassociateRecoveryPoint_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DisassociateRecoveryPoint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DisassociateRecoveryPoint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DisassociateRecoveryPoint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DisassociateRecoveryPoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DisassociateRecoveryPoint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DisassociateRecoveryPoint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DisassociateRecoveryPoint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DisassociateRecoveryPoint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DisassociateRecoveryPoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DisassociateRecoveryPoint) 

# DisassociateRecoveryPointFromParent
<a name="API_DisassociateRecoveryPointFromParent"></a>

このアクションを特定の子 (ネストされた) 復旧ポイントに対して実行すると、指定した復旧ポイントとその親 (複合) 復旧ポイントとの関係が削除されます。

## リクエストの構文
<a name="API_DisassociateRecoveryPointFromParent_RequestSyntax"></a>

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

## URI リクエストパラメータ
<a name="API_DisassociateRecoveryPointFromParent_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [backupVaultName](#API_DisassociateRecoveryPointFromParent_RequestSyntax) **   <a name="Backup-DisassociateRecoveryPointFromParent-request-uri-BackupVaultName"></a>
子 (ネストされた) 復旧ポイントが含まれる論理コンテナの名前。バックアップボールトは、作成に使用したアカウントと作成先の AWS リージョンに固有の名前で識別されます。  
パターン: `^[a-zA-Z0-9\-\_]{2,50}$`   
必須: はい

 ** [recoveryPointArn](#API_DisassociateRecoveryPointFromParent_RequestSyntax) **   <a name="Backup-DisassociateRecoveryPointFromParent-request-uri-RecoveryPointArn"></a>
子 (ネストされた) 復旧ポイントを一意に識別する Amazon リソースネーム (ARN) (例えば、`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.`)。  
必須: はい

## リクエストボディ
<a name="API_DisassociateRecoveryPointFromParent_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_DisassociateRecoveryPointFromParent_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## レスポンス要素
<a name="API_DisassociateRecoveryPointFromParent_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 204 レスポンスを返します。

## エラー
<a name="API_DisassociateRecoveryPointFromParent_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** InvalidRequestException **   
リクエストへの入力に何らかの問題が発生していることを示します。たとえば、パラメータのタイプが間違っています。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_DisassociateRecoveryPointFromParent_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DisassociateRecoveryPointFromParent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DisassociateRecoveryPointFromParent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DisassociateRecoveryPointFromParent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DisassociateRecoveryPointFromParent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DisassociateRecoveryPointFromParent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DisassociateRecoveryPointFromParent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DisassociateRecoveryPointFromParent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DisassociateRecoveryPointFromParent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DisassociateRecoveryPointFromParent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DisassociateRecoveryPointFromParent) 

# ExportBackupPlanTemplate
<a name="API_ExportBackupPlanTemplate"></a>

プラン ID で指定されたバックアッププランをバックアップテンプレートとして返します。

## リクエストの構文
<a name="API_ExportBackupPlanTemplate_RequestSyntax"></a>

```
GET /backup/plans/backupPlanId/toTemplate/ HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_ExportBackupPlanTemplate_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [backupPlanId](#API_ExportBackupPlanTemplate_RequestSyntax) **   <a name="Backup-ExportBackupPlanTemplate-request-uri-BackupPlanId"></a>
バックアップ計画を一意に識別します。  
必須: はい

## リクエストボディ
<a name="API_ExportBackupPlanTemplate_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_ExportBackupPlanTemplate_ResponseSyntax"></a>

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

{
   "BackupPlanTemplateJson": "string"
}
```

## レスポンス要素
<a name="API_ExportBackupPlanTemplate_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [BackupPlanTemplateJson](#API_ExportBackupPlanTemplate_ResponseSyntax) **   <a name="Backup-ExportBackupPlanTemplate-response-BackupPlanTemplateJson"></a>
JSON 形式のバックアッププランテンプレートの本文。  
これは署名付き JSON ドキュメントで、`GetBackupPlanFromJSON.` に渡される前に変更することはできません。
タイプ: 文字列

## エラー
<a name="API_ExportBackupPlanTemplate_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_ExportBackupPlanTemplate_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ExportBackupPlanTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ExportBackupPlanTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ExportBackupPlanTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ExportBackupPlanTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ExportBackupPlanTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ExportBackupPlanTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ExportBackupPlanTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ExportBackupPlanTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ExportBackupPlanTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ExportBackupPlanTemplate) 

# GetBackupPlan
<a name="API_GetBackupPlan"></a>

指定された `BackupPlanId` の `BackupPlan` 詳細情報を返します。詳細は、計画メタデータに加えて、JSON 形式のバックアッププランの本文です。

## リクエストの構文
<a name="API_GetBackupPlan_RequestSyntax"></a>

```
GET /backup/plans/backupPlanId/?MaxScheduledRunsPreview=MaxScheduledRunsPreview&versionId=VersionId HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_GetBackupPlan_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [backupPlanId](#API_GetBackupPlan_RequestSyntax) **   <a name="Backup-GetBackupPlan-request-uri-BackupPlanId"></a>
バックアップ計画を一意に識別します。  
必須: はい

 ** [MaxScheduledRunsPreview](#API_GetBackupPlan_RequestSyntax) **   <a name="Backup-GetBackupPlan-request-uri-MaxScheduledRunsPreview"></a>
プレビューする今後スケジュールされているバックアップ実行の数。0 (デフォルト) に設定すると、スケジュールされた実行のプレビューはレスポンスに含まれません。有効な範囲は 1～10 です。  
有効範囲: 最小値 は 0 です。最大値は 10 です。

 ** [VersionId](#API_GetBackupPlan_RequestSyntax) **   <a name="Backup-GetBackupPlan-request-uri-VersionId"></a>
一意のランダムに生成された UTF-8 エンコード Unicode 文字列 (最大 1,024 バイト長)。バージョン ID を編集することはできません。

## リクエスト本文
<a name="API_GetBackupPlan_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_GetBackupPlan_ResponseSyntax"></a>

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

{
   "AdvancedBackupSettings": [ 
      { 
         "BackupOptions": { 
            "string" : "string" 
         },
         "ResourceType": "string"
      }
   ],
   "BackupPlan": { 
      "AdvancedBackupSettings": [ 
         { 
            "BackupOptions": { 
               "string" : "string" 
            },
            "ResourceType": "string"
         }
      ],
      "BackupPlanName": "string",
      "Rules": [ 
         { 
            "CompletionWindowMinutes": number,
            "CopyActions": [ 
               { 
                  "DestinationBackupVaultArn": "string",
                  "Lifecycle": { 
                     "DeleteAfterDays": number,
                     "DeleteAfterEvent": "string",
                     "MoveToColdStorageAfterDays": number,
                     "OptInToArchiveForSupportedResources": boolean
                  }
               }
            ],
            "EnableContinuousBackup": boolean,
            "IndexActions": [ 
               { 
                  "ResourceTypes": [ "string" ]
               }
            ],
            "Lifecycle": { 
               "DeleteAfterDays": number,
               "DeleteAfterEvent": "string",
               "MoveToColdStorageAfterDays": number,
               "OptInToArchiveForSupportedResources": boolean
            },
            "RecoveryPointTags": { 
               "string" : "string" 
            },
            "RuleId": "string",
            "RuleName": "string",
            "ScanActions": [ 
               { 
                  "MalwareScanner": "string",
                  "ScanMode": "string"
               }
            ],
            "ScheduleExpression": "string",
            "ScheduleExpressionTimezone": "string",
            "StartWindowMinutes": number,
            "TargetBackupVaultName": "string",
            "TargetLogicallyAirGappedBackupVaultArn": "string"
         }
      ],
      "ScanSettings": [ 
         { 
            "MalwareScanner": "string",
            "ResourceTypes": [ "string" ],
            "ScannerRoleArn": "string"
         }
      ]
   },
   "BackupPlanArn": "string",
   "BackupPlanId": "string",
   "CreationDate": number,
   "CreatorRequestId": "string",
   "DeletionDate": number,
   "LastExecutionDate": number,
   "ScheduledRunsPreview": [ 
      { 
         "ExecutionTime": number,
         "RuleExecutionType": "string",
         "RuleId": "string"
      }
   ],
   "VersionId": "string"
}
```

## レスポンス要素
<a name="API_GetBackupPlan_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [AdvancedBackupSettings](#API_GetBackupPlan_ResponseSyntax) **   <a name="Backup-GetBackupPlan-response-AdvancedBackupSettings"></a>
各リソースタイプごとに `BackupOptions` のリストが含まれます。このリストには、バックアッププランに詳細オプションが設定されている場合にのみ入力されます。  
型: [AdvancedBackupSetting](API_AdvancedBackupSetting.md) オブジェクトの配列

 ** [BackupPlan](#API_GetBackupPlan_ResponseSyntax) **   <a name="Backup-GetBackupPlan-response-BackupPlan"></a>
バックアッププランの本文を指定します。1 つの `BackupPlanName` と1 つ以上の `Rules` のセットを含む。  
型: [BackupPlan](API_BackupPlan.md) オブジェクト

 ** [BackupPlanArn](#API_GetBackupPlan_ResponseSyntax) **   <a name="Backup-GetBackupPlan-response-BackupPlanArn"></a>
たとえば、`arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50`などのバックアップ計画を一意に識別する Amazon リソースネーム (ARN) です。  
タイプ: 文字列

 ** [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>
オペレーションを 2 回実行するリスクなしに、失敗したリクエストを再試行でき、リクエストを識別する一意の文字列。  
タイプ: 文字列

 ** [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 件の将来のバックアップ実行を含み、それぞれにスケジュールされた時刻、実行タイプ、および関連するルール ID が含まれます。  
型: [ScheduledPlanExecutionMember](API_ScheduledPlanExecutionMember.md) オブジェクトの配列

 ** [VersionId](#API_GetBackupPlan_ResponseSyntax) **   <a name="Backup-GetBackupPlan-response-VersionId"></a>
一意のランダムに生成された UTF-8 エンコード Unicode 文字列 (最大 1,024 バイト長)。バージョン ID を編集することはできません。  
タイプ: 文字列

## エラー
<a name="API_GetBackupPlan_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_GetBackupPlan_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/GetBackupPlan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetBackupPlan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetBackupPlan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetBackupPlan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetBackupPlan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetBackupPlan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetBackupPlan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetBackupPlan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetBackupPlan) 
+  [AWS SDK for Ruby V3](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>
バックアッププランの本文を指定します。1 つの `BackupPlanName` と1 つ以上の `Rules` のセットを含む。  
型: [BackupPlan](API_BackupPlan.md) オブジェクト

## エラー
<a name="API_GetBackupPlanFromJSON_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** InvalidRequestException **   
リクエストへの入力に何らかの問題が発生していることを示します。たとえば、パラメータのタイプが間違っています。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** LimitExceededException **   
たとえば、リクエストで許可されるアイテムの最大数などのリクエストの制限を超えました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_GetBackupPlanFromJSON_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/GetBackupPlanFromJSON) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetBackupPlanFromJSON) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetBackupPlanFromJSON) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetBackupPlanFromJSON) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetBackupPlanFromJSON) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetBackupPlanFromJSON) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetBackupPlanFromJSON) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetBackupPlanFromJSON) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetBackupPlanFromJSON) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/GetBackupPlanFromJSON) 

# GetBackupPlanFromTemplate
<a name="API_GetBackupPlanFromTemplate"></a>

バックアッププランとして `templateId` で指定したテンプレートを返します。

## リクエストの構文
<a name="API_GetBackupPlanFromTemplate_RequestSyntax"></a>

```
GET /backup/template/plans/templateId/toPlan HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_GetBackupPlanFromTemplate_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [templateId](#API_GetBackupPlanFromTemplate_RequestSyntax) **   <a name="Backup-GetBackupPlanFromTemplate-request-uri-BackupPlanTemplateId"></a>
保存されているバックアッププランテンプレートを一意に識別します。  
必須: はい

## リクエストボディ
<a name="API_GetBackupPlanFromTemplate_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_GetBackupPlanFromTemplate_ResponseSyntax"></a>

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

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

## レスポンス要素
<a name="API_GetBackupPlanFromTemplate_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [BackupPlanDocument](#API_GetBackupPlanFromTemplate_ResponseSyntax) **   <a name="Backup-GetBackupPlanFromTemplate-response-BackupPlanDocument"></a>
プランの名前、ルール、バックアップボールトなど、ターゲットテンプレートに基づくバックアッププランの本文を返します。  
型: [BackupPlan](API_BackupPlan.md) オブジェクト

## エラー
<a name="API_GetBackupPlanFromTemplate_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_GetBackupPlanFromTemplate_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/GetBackupPlanFromTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetBackupPlanFromTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetBackupPlanFromTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetBackupPlanFromTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetBackupPlanFromTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetBackupPlanFromTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetBackupPlanFromTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetBackupPlanFromTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetBackupPlanFromTemplate) 
+  [AWS SDK for Ruby V3](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>
オペレーションを 2 回実行するリスクなしに、失敗したリクエストを再試行でき、リクエストを識別する一意の文字列。  
タイプ: 文字列

 ** [SelectionId](#API_GetBackupSelection_ResponseSyntax) **   <a name="Backup-GetBackupSelection-response-SelectionId"></a>
バックアップ計画に一連のリソースを割り当てるためのリクエストの本文を一意に識別します。  
タイプ: 文字列

## エラー
<a name="API_GetBackupSelection_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_GetBackupSelection_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/GetBackupSelection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetBackupSelection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetBackupSelection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetBackupSelection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetBackupSelection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetBackupSelection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetBackupSelection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetBackupSelection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetBackupSelection) 
+  [AWS SDK for Ruby V3](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>
`arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`などのバックアップボールトを一意に識別する Amazon リソースネーム (ARN)。  
タイプ: 文字列

 ** [BackupVaultName](#API_GetBackupVaultAccessPolicy_ResponseSyntax) **   <a name="Backup-GetBackupVaultAccessPolicy-response-BackupVaultName"></a>
バックアップを保存する論理コンテナの名前。バックアップボールトは、これらのボールトを作成するために使用されたアカウントと作成先の リージョンに一意の名前で識別されます。  
タイプ: 文字列  
パターン: `^[a-zA-Z0-9\-\_]{2,50}$` 

 ** [Policy](#API_GetBackupVaultAccessPolicy_ResponseSyntax) **   <a name="Backup-GetBackupVaultAccessPolicy-response-Policy"></a>
JSON 形式のバックアップボールトのアクセスポリシードキュメントです。  
タイプ: 文字列

## エラー
<a name="API_GetBackupVaultAccessPolicy_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_GetBackupVaultAccessPolicy_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/GetBackupVaultAccessPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetBackupVaultAccessPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetBackupVaultAccessPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetBackupVaultAccessPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetBackupVaultAccessPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetBackupVaultAccessPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetBackupVaultAccessPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetBackupVaultAccessPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetBackupVaultAccessPolicy) 
+  [AWS SDK for Ruby V3](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>
`arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`などのバックアップボールトを一意に識別する Amazon リソースネーム (ARN)。  
タイプ: 文字列

 ** [BackupVaultEvents](#API_GetBackupVaultNotifications_ResponseSyntax) **   <a name="Backup-GetBackupVaultNotifications-response-BackupVaultEvents"></a>
リソースをバックアップボールトにバックアップするジョブのステータスを示すイベントの配列。  
型: 文字列の配列  
有効な値: `BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED | BACKUP_JOB_SUCCESSFUL | BACKUP_JOB_FAILED | BACKUP_JOB_EXPIRED | RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RESTORE_JOB_SUCCESSFUL | RESTORE_JOB_FAILED | COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED | RECOVERY_POINT_MODIFIED | BACKUP_PLAN_CREATED | BACKUP_PLAN_MODIFIED | S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED | CONTINUOUS_BACKUP_INTERRUPTED | RECOVERY_POINT_INDEX_COMPLETED | RECOVERY_POINT_INDEX_DELETED | RECOVERY_POINT_INDEXING_FAILED` 

 ** [BackupVaultName](#API_GetBackupVaultNotifications_ResponseSyntax) **   <a name="Backup-GetBackupVaultNotifications-response-BackupVaultName"></a>
バックアップを保存する論理コンテナの名前。バックアップボールトは、これらのボールトを作成するために使用されたアカウントと作成先の リージョンに一意の名前で識別されます。  
タイプ: 文字列  
パターン: `^[a-zA-Z0-9\-\_]{2,50}$` 

 ** [SNSTopicArn](#API_GetBackupVaultNotifications_ResponseSyntax) **   <a name="Backup-GetBackupVaultNotifications-response-SNSTopicArn"></a>
Amazon Simple Notification Service (Amazon SNS) のトピックを一意に識別する ARN (例: `arn:aws:sns:us-west-2:111122223333:MyTopic`)。  
タイプ: 文字列

## エラー
<a name="API_GetBackupVaultNotifications_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_GetBackupVaultNotifications_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/GetBackupVaultNotifications) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetBackupVaultNotifications) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetBackupVaultNotifications) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetBackupVaultNotifications) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetBackupVaultNotifications) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetBackupVaultNotifications) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetBackupVaultNotifications) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetBackupVaultNotifications) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetBackupVaultNotifications) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/GetLegalHold) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetLegalHold) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetLegalHold) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetLegalHold) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetLegalHold) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetLegalHold) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetLegalHold) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetLegalHold) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetLegalHold) 
+  [AWS SDK for Ruby V3](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:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`などのリカバリポイントを一意に識別する ARN。  
必須: はい

## リクエストボディ
<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:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`などのリカバリポイントを一意に識別する ARN。  
タイプ: 文字列

 ** [SourceResourceArn](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **   <a name="Backup-GetRecoveryPointIndexDetails-response-SourceResourceArn"></a>
ソースのリソースを一意に識別する Amazon リソースネーム (ARN) の文字列。  
タイプ: 文字列

 ** [TotalItemsIndexed](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **   <a name="Backup-GetRecoveryPointIndexDetails-response-TotalItemsIndexed"></a>
復旧ポイントに関連付けられたバックアップインデックス内の項目の数。  
タイプ: Long

## エラー
<a name="API_GetRecoveryPointIndexDetails_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_GetRecoveryPointIndexDetails_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/GetRecoveryPointIndexDetails) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetRecoveryPointIndexDetails) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetRecoveryPointIndexDetails) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetRecoveryPointIndexDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetRecoveryPointIndexDetails) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetRecoveryPointIndexDetails) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetRecoveryPointIndexDetails) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetRecoveryPointIndexDetails) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetRecoveryPointIndexDetails) 
+  [AWS SDK for Ruby V3](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>
`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`などのリカバリポイントを一意に識別する Amazon リソースネーム (ARN) です。  
必須: はい

## リクエストボディ
<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:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault` などのバックアップボールトを一意に識別する ARN。  
タイプ: 文字列

 ** [RecoveryPointArn](#API_GetRecoveryPointRestoreMetadata_ResponseSyntax) **   <a name="Backup-GetRecoveryPointRestoreMetadata-response-RecoveryPointArn"></a>
たとえば、`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`などのリカバリポイントを一意に識別する ARN。  
タイプ: 文字列

 ** [ResourceType](#API_GetRecoveryPointRestoreMetadata_ResponseSyntax) **   <a name="Backup-GetRecoveryPointRestoreMetadata-response-ResourceType"></a>
復旧ポイントのリソースタイプ。  
タイプ: 文字列  
パターン: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

 ** [RestoreMetadata](#API_GetRecoveryPointRestoreMetadata_ResponseSyntax) **   <a name="Backup-GetRecoveryPointRestoreMetadata-response-RestoreMetadata"></a>
バックアップされたリソースの元の構成を記述するメタデータのキーと値のペアのセット。これらの値は、復元されるサービスによって異なります。  
タイプ: 文字列間のマッピング

## エラー
<a name="API_GetRecoveryPointRestoreMetadata_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_GetRecoveryPointRestoreMetadata_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/GetRecoveryPointRestoreMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetRecoveryPointRestoreMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetRecoveryPointRestoreMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetRecoveryPointRestoreMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetRecoveryPointRestoreMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetRecoveryPointRestoreMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetRecoveryPointRestoreMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetRecoveryPointRestoreMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetRecoveryPointRestoreMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/GetRecoveryPointRestoreMetadata) 

# GetRestoreJobMetadata
<a name="API_GetRestoreJobMetadata"></a>

このリクエストは、指定された復元ジョブのメタデータを返します。

## リクエストの構文
<a name="API_GetRestoreJobMetadata_RequestSyntax"></a>

```
GET /restore-jobs/restoreJobId/metadata HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_GetRestoreJobMetadata_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [restoreJobId](#API_GetRestoreJobMetadata_RequestSyntax) **   <a name="Backup-GetRestoreJobMetadata-request-uri-RestoreJobId"></a>
これは、復元ジョブの一意の識別子です AWS Backup。  
必須: はい

## リクエストボディ
<a name="API_GetRestoreJobMetadata_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_GetRestoreJobMetadata_ResponseSyntax"></a>

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

{
   "Metadata": { 
      "string" : "string" 
   },
   "RestoreJobId": "string"
}
```

## レスポンス要素
<a name="API_GetRestoreJobMetadata_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [Metadata](#API_GetRestoreJobMetadata_ResponseSyntax) **   <a name="Backup-GetRestoreJobMetadata-response-Metadata"></a>
指定されたバックアップジョブのメタデータが含まれます。  
タイプ: 文字列間のマッピング

 ** [RestoreJobId](#API_GetRestoreJobMetadata_ResponseSyntax) **   <a name="Backup-GetRestoreJobMetadata-response-RestoreJobId"></a>
これは、復元ジョブの一意の識別子です AWS Backup。  
タイプ: 文字列

## エラー
<a name="API_GetRestoreJobMetadata_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_GetRestoreJobMetadata_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/GetRestoreJobMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetRestoreJobMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetRestoreJobMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetRestoreJobMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetRestoreJobMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetRestoreJobMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetRestoreJobMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetRestoreJobMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetRestoreJobMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/GetRestoreJobMetadata) 

# GetRestoreTestingInferredMetadata
<a name="API_GetRestoreTestingInferredMetadata"></a>

このリクエストは、安全なデフォルト設定で復元ジョブを開始するために必要な最小限のメタデータセットを返します。`BackupVaultName` と `RecoveryPointArn` は必須パラメータで、`BackupVaultAccountId` はオプションのパラメータです。

## リクエストの構文
<a name="API_GetRestoreTestingInferredMetadata_RequestSyntax"></a>

```
GET /restore-testing/inferred-metadata?BackupVaultAccountId=BackupVaultAccountId&BackupVaultName=BackupVaultName&RecoveryPointArn=RecoveryPointArn HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_GetRestoreTestingInferredMetadata_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [BackupVaultAccountId](#API_GetRestoreTestingInferredMetadata_RequestSyntax) **   <a name="Backup-GetRestoreTestingInferredMetadata-request-uri-BackupVaultAccountId"></a>
指定されたバックアップボールトのアカウント ID。

 ** [BackupVaultName](#API_GetRestoreTestingInferredMetadata_RequestSyntax) **   <a name="Backup-GetRestoreTestingInferredMetadata-request-uri-BackupVaultName"></a>
バックアップを保存する論理コンテナの名前。バックアップボールトは、作成に使用したアカウントと作成先の AWSリージョンに固有の名前で識別されます。名前は、英文字、数字、およびハイフン (-) で構成されます。  
必須: はい

 ** [RecoveryPointArn](#API_GetRestoreTestingInferredMetadata_RequestSyntax) **   <a name="Backup-GetRestoreTestingInferredMetadata-request-uri-RecoveryPointArn"></a>
`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`などのリカバリポイントを一意に識別する Amazon リソースネーム (ARN) です。  
必須: はい

## リクエストボディ
<a name="API_GetRestoreTestingInferredMetadata_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_GetRestoreTestingInferredMetadata_ResponseSyntax"></a>

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

{
   "InferredMetadata": { 
      "string" : "string" 
   }
}
```

## レスポンス要素
<a name="API_GetRestoreTestingInferredMetadata_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [InferredMetadata](#API_GetRestoreTestingInferredMetadata_ResponseSyntax) **   <a name="Backup-GetRestoreTestingInferredMetadata-response-InferredMetadata"></a>
リクエストから推定されるメタデータの文字列マッピングです。  
タイプ: 文字列間のマッピング

## エラー
<a name="API_GetRestoreTestingInferredMetadata_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_GetRestoreTestingInferredMetadata_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/GetRestoreTestingInferredMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetRestoreTestingInferredMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetRestoreTestingInferredMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetRestoreTestingInferredMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetRestoreTestingInferredMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetRestoreTestingInferredMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetRestoreTestingInferredMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetRestoreTestingInferredMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetRestoreTestingInferredMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/GetRestoreTestingInferredMetadata) 

# GetRestoreTestingPlan
<a name="API_GetRestoreTestingPlan"></a>

指定された `RestoreTestingPlanName` の `RestoreTestingPlan` 詳細情報を返します。この詳細情報には、復元テストプランのメタデータに加え、プランの JSON 形式の本文が含まれます。

## リクエストの構文
<a name="API_GetRestoreTestingPlan_RequestSyntax"></a>

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

## URI リクエストパラメータ
<a name="API_GetRestoreTestingPlan_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [RestoreTestingPlanName](#API_GetRestoreTestingPlan_RequestSyntax) **   <a name="Backup-GetRestoreTestingPlan-request-uri-RestoreTestingPlanName"></a>
復元テストプランの一意の名前 (必須) です。  
必須: はい

## リクエストボディ
<a name="API_GetRestoreTestingPlan_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_GetRestoreTestingPlan_ResponseSyntax"></a>

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

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

## レスポンス要素
<a name="API_GetRestoreTestingPlan_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [RestoreTestingPlan](#API_GetRestoreTestingPlan_ResponseSyntax) **   <a name="Backup-GetRestoreTestingPlan-response-RestoreTestingPlan"></a>
復元テストプランの本文を示します。`RestoreTestingPlanName` が含まれます。  
型: [RestoreTestingPlanForGet](API_RestoreTestingPlanForGet.md) オブジェクト

## エラー
<a name="API_GetRestoreTestingPlan_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_GetRestoreTestingPlan_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/GetRestoreTestingPlan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetRestoreTestingPlan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetRestoreTestingPlan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetRestoreTestingPlan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetRestoreTestingPlan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetRestoreTestingPlan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetRestoreTestingPlan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetRestoreTestingPlan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetRestoreTestingPlan) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/GetRestoreTestingPlan) 

# GetRestoreTestingSelection
<a name="API_GetRestoreTestingSelection"></a>

RestoreTestingSelection を返し、復元テストプランのリソースと要素が表示されます。

## リクエストの構文
<a name="API_GetRestoreTestingSelection_RequestSyntax"></a>

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

## URI リクエストパラメータ
<a name="API_GetRestoreTestingSelection_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [RestoreTestingPlanName](#API_GetRestoreTestingSelection_RequestSyntax) **   <a name="Backup-GetRestoreTestingSelection-request-uri-RestoreTestingPlanName"></a>
復元テストプランの一意の名前 (必須) です。  
必須: はい

 ** [RestoreTestingSelectionName](#API_GetRestoreTestingSelection_RequestSyntax) **   <a name="Backup-GetRestoreTestingSelection-request-uri-RestoreTestingSelectionName"></a>
復元テスト選択の一意の名前 (必須) です。  
必須: はい

## リクエストボディ
<a name="API_GetRestoreTestingSelection_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_GetRestoreTestingSelection_ResponseSyntax"></a>

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

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

## レスポンス要素
<a name="API_GetRestoreTestingSelection_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [RestoreTestingSelection](#API_GetRestoreTestingSelection_ResponseSyntax) **   <a name="Backup-GetRestoreTestingSelection-response-RestoreTestingSelection"></a>
復元テスト選択の一意の名前。  
型: [RestoreTestingSelectionForGet](API_RestoreTestingSelectionForGet.md) オブジェクト

## エラー
<a name="API_GetRestoreTestingSelection_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_GetRestoreTestingSelection_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS SDK for Ruby V3](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`
+  Amazon DynamoDB 用の `DynamoDB`
+  Amazon Elastic Block Store 用の `EBS`
+  Amazon Elastic Compute Cloud 用の `EC2`
+  Amazon Elastic File System 用の `EFS`
+  `EKS` for Amazon Elastic Kubernetes Service
+  Amazon FSx の場合 用の `FSx`
+  Amazon Neptune の場合 用の `Neptune`
+  Amazon Relational Database Service 用の `RDS`
+  Amazon Redshift 用の `Redshift`
+  Amazon Simple Storage Service (Amazon S3) 用の `S3`
+  Amazon Elastic Compute Cloud インスタンスでの SAP HANA データベース用の `SAP HANA on Amazon EC2`
+  `Storage Gateway` の AWS Storage Gateway 
+  Amazon Timestream 用の `Timestream`
+  VMware 仮想マシン用の `VirtualMachine`
型: 文字列の配列  
パターン: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

## エラー
<a name="API_GetSupportedResourceTypes_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_GetSupportedResourceTypes_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/GetSupportedResourceTypes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetSupportedResourceTypes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetSupportedResourceTypes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetSupportedResourceTypes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetSupportedResourceTypes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetSupportedResourceTypes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetSupportedResourceTypes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetSupportedResourceTypes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetSupportedResourceTypes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/GetSupportedResourceTypes) 

# GetTieringConfiguration
<a name="API_GetTieringConfiguration"></a>

指定された `TieringConfigurationName` の `TieringConfiguration` 詳細情報を返します。詳細は、設定メタデータに加えて、JSON 形式の階層化設定の本文です。

## リクエストの構文
<a name="API_GetTieringConfiguration_RequestSyntax"></a>

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

## URI リクエストパラメータ
<a name="API_GetTieringConfiguration_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [tieringConfigurationName](#API_GetTieringConfiguration_RequestSyntax) **   <a name="Backup-GetTieringConfiguration-request-uri-TieringConfigurationName"></a>
階層化設定の一意の名前。  
パターン: `^[a-zA-Z0-9_]{1,200}$`   
必須: はい

## リクエストボディ
<a name="API_GetTieringConfiguration_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_GetTieringConfiguration_ResponseSyntax"></a>

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

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

## レスポンス要素
<a name="API_GetTieringConfiguration_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [TieringConfiguration](#API_GetTieringConfiguration_ResponseSyntax) **   <a name="Backup-GetTieringConfiguration-response-TieringConfiguration"></a>
階層化設定の本文を指定します。`TieringConfigurationName` が含まれます。  
型: [TieringConfiguration](API_TieringConfiguration.md) オブジェクト

## エラー
<a name="API_GetTieringConfiguration_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_GetTieringConfiguration_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS SDK for Ruby V3](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`
+  Amazon DynamoDB 用の `DynamoDB`
+  Amazon Elastic Block Store 用の `EBS`
+  Amazon Elastic Compute Cloud 用の `EC2`
+  Amazon Elastic File System 用の `EFS`
+  `EKS` for Amazon Elastic Kubernetes Service
+  Amazon FSx の場合 用の `FSx`
+  Amazon Neptune の場合 用の `Neptune`
+  Amazon Relational Database Service 用の `RDS`
+  Amazon Redshift 用の `Redshift`
+  Amazon Simple Storage Service (Amazon S3) 用の `S3`
+  Amazon Elastic Compute Cloud インスタンスでの SAP HANA データベース用の `SAP HANA on Amazon EC2`
+  `Storage Gateway` の AWS Storage Gateway 
+  Amazon Timestream 用の `Timestream`
+  VMware 仮想マシン用の `VirtualMachine`
パターン: `^[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 リクエストを 2 回実行し、2 つ目の小さい方の数字を引きます。  
GET /backup-jobs/?state=COMPLETED  
GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED  
有効な値：`CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL`

 ** [MaxResults](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-MaxResults"></a>
返されるアイテムの最大数。  
有効な範囲: 最小値 は 1 です。最大値は 1000 です。

 ** [NextToken](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-NextToken"></a>
返された項目の一部リストに続く次の項目。たとえば、`MaxResults` アイテム数のリクエストが行われるようにされた場合、`NextToken` では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。

## リクエスト本文
<a name="API_ListBackupJobs_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_ListBackupJobs_ResponseSyntax"></a>

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

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

## レスポンス要素
<a name="API_ListBackupJobs_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [BackupJobs](#API_ListBackupJobs_ResponseSyntax) **   <a name="Backup-ListBackupJobs-response-BackupJobs"></a>
JSON 形式で返されたバックアップジョブに関するメタデータを含む構造体の配列。  
型: [BackupJob](API_BackupJob.md) オブジェクトの配列

 ** [NextToken](#API_ListBackupJobs_ResponseSyntax) **   <a name="Backup-ListBackupJobs-response-NextToken"></a>
返された項目の一部リストに続く次の項目。たとえば、`MaxResults` アイテム数のリクエストが行われるようにされた場合、`NextToken` では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。  
タイプ: 文字列

## エラー
<a name="API_ListBackupJobs_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_ListBackupJobs_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListBackupJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListBackupJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListBackupJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListBackupJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListBackupJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListBackupJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListBackupJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListBackupJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListBackupJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListBackupJobs) 

# ListBackupJobSummaries
<a name="API_ListBackupJobSummaries"></a>

過去 30 日以内に作成または実行されたバックアップジョブの概要を求めるリクエストです。AccountID、State、ResourceType、MessageCategory、AggregationPeriod、MaxResults、または NextToken パラメータを使用して、結果をフィルタリングできます。

このリクエストは、該当するジョブの Region、Account、State、ResourceType、MessageCategory、StartTime、EndTime、および Count を含む概要を返します。

## リクエストの構文
<a name="API_ListBackupJobSummaries_RequestSyntax"></a>

```
GET /audit/backup-job-summaries?AccountId=AccountId&AggregationPeriod=AggregationPeriod&MaxResults=MaxResults&MessageCategory=MessageCategory&NextToken=NextToken&ResourceType=ResourceType&State=State HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_ListBackupJobSummaries_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [AccountId](#API_ListBackupJobSummaries_RequestSyntax) **   <a name="Backup-ListBackupJobSummaries-request-uri-AccountId"></a>
指定されたアカウントのジョブ数を返します。  
リクエストがメンバーアカウントまたは AWS Organizations の一部ではないアカウントから送信されると、リクエスタのアカウント内のジョブが返されます。  
ルート、管理者、および委任された管理者アカウントでは、ANY の値を使用して、組織内のすべてのアカウントのジョブ数を返すことができます。  
 `AGGREGATE_ALL` は、認証された組織内のすべてのアカウントのジョブ数を集計し、その合計を返します。  
パターン: `^[0-9]{12}$` 

 ** [AggregationPeriod](#API_ListBackupJobSummaries_RequestSyntax) **   <a name="Backup-ListBackupJobSummaries-request-uri-AggregationPeriod"></a>
返された結果の期間。  
+  `ONE_DAY` – 過去 14 日間の 1 日ごとのジョブ数。
+  `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 Elastic Block Store (Amazon EBS) ボリュームや Amazon Relational Database Service (Amazon RDS) データベースなど。  
パターン: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

 ** [State](#API_ListBackupJobSummaries_RequestSyntax) **   <a name="Backup-ListBackupJobSummaries-request-uri-State"></a>
このパラメータは、指定された状態のジョブの数を返します。  
値 ANY は、すべての状態の数を返します。  
 `AGGREGATE_ALL` は、すべての状態のジョブ数を集計し、その合計を返します。  
 `Completed with issues` は AWS Backup コンソールでのみ表示されるステータスです。API の場合このステータスは、状態が `COMPLETED` で `MessageCategory` の値が `SUCCESS` 以外のジョブ、つまり完了はしているがステータスメッセージがあるジョブを指します。`Completed with issues` のジョブ数を取得するには、以下のように GET リクエストを 2 回実行し、2 つ目の小さい方の数字を引きます。  
GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN\$1DAYS&State=COMPLETED  
GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN\$1DAYS&MessageCategory=SUCCESS&State=COMPLETED  
有効な値：`CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL | AGGREGATE_ALL | ANY`

## リクエスト本文
<a name="API_ListBackupJobSummaries_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_ListBackupJobSummaries_ResponseSyntax"></a>

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

{
   "AggregationPeriod": "string",
   "BackupJobSummaries": [ 
      { 
         "AccountId": "string",
         "Count": number,
         "EndTime": number,
         "MessageCategory": "string",
         "Region": "string",
         "ResourceType": "string",
         "StartTime": number,
         "State": "string"
      }
   ],
   "NextToken": "string"
}
```

## レスポンス要素
<a name="API_ListBackupJobSummaries_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [AggregationPeriod](#API_ListBackupJobSummaries_ResponseSyntax) **   <a name="Backup-ListBackupJobSummaries-response-AggregationPeriod"></a>
返された結果の期間。  
+  `ONE_DAY` – 過去 14 日間の 1 日ごとのジョブ数。
+  `SEVEN_DAYS` – 過去 7 日間の合計のジョブ数。
+  `FOURTEEN_DAYS` – 過去 14 日間の合計のジョブ数。
タイプ: 文字列

 ** [BackupJobSummaries](#API_ListBackupJobSummaries_ResponseSyntax) **   <a name="Backup-ListBackupJobSummaries-response-BackupJobSummaries"></a>
概要情報。  
型: [BackupJobSummary](API_BackupJobSummary.md) オブジェクトの配列

 ** [NextToken](#API_ListBackupJobSummaries_ResponseSyntax) **   <a name="Backup-ListBackupJobSummaries-response-NextToken"></a>
返されるリソースの部分的リストに続く次の項目です。例えば、`MaxResults` の数のリソースを返すようにリクエストが行われた場合、`NextToken` を使用すると、このトークンが指す場所から開始してさらにリストの項目を返すことができます。  
タイプ: 文字列

## エラー
<a name="API_ListBackupJobSummaries_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_ListBackupJobSummaries_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListBackupJobSummaries) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListBackupJobSummaries) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListBackupJobSummaries) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListBackupJobSummaries) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListBackupJobSummaries) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListBackupJobSummaries) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListBackupJobSummaries) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListBackupJobSummaries) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListBackupJobSummaries) 
+  [AWS SDK for Ruby V3](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>
`TRUE` に設定されているときに削除されたバックアッププランを返す `FALSE` のデフォルト値を持つブール値。

 ** [MaxResults](#API_ListBackupPlans_RequestSyntax) **   <a name="Backup-ListBackupPlans-request-uri-MaxResults"></a>
返されるアイテムの最大数。  
有効な範囲: 最小値 は 1 です。最大値は 1000 です。

 ** [NextToken](#API_ListBackupPlans_RequestSyntax) **   <a name="Backup-ListBackupPlans-request-uri-NextToken"></a>
返された項目の一部リストに続く次の項目。たとえば、`MaxResults` アイテム数のリクエストが行われるようにされた場合、`NextToken` では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。

## リクエスト本文
<a name="API_ListBackupPlans_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_ListBackupPlans_ResponseSyntax"></a>

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

{
   "BackupPlansList": [ 
      { 
         "AdvancedBackupSettings": [ 
            { 
               "BackupOptions": { 
                  "string" : "string" 
               },
               "ResourceType": "string"
            }
         ],
         "BackupPlanArn": "string",
         "BackupPlanId": "string",
         "BackupPlanName": "string",
         "CreationDate": number,
         "CreatorRequestId": "string",
         "DeletionDate": number,
         "LastExecutionDate": number,
         "VersionId": "string"
      }
   ],
   "NextToken": "string"
}
```

## レスポンス要素
<a name="API_ListBackupPlans_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [BackupPlansList](#API_ListBackupPlans_ResponseSyntax) **   <a name="Backup-ListBackupPlans-response-BackupPlansList"></a>
バックアッププランに関する情報。  
型: [BackupPlansListMember](API_BackupPlansListMember.md) オブジェクトの配列

 ** [NextToken](#API_ListBackupPlans_ResponseSyntax) **   <a name="Backup-ListBackupPlans-response-NextToken"></a>
返された項目の一部リストに続く次の項目。たとえば、`MaxResults` アイテム数のリクエストが行われるようにされた場合、`NextToken` では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。  
タイプ: 文字列

## エラー
<a name="API_ListBackupPlans_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_ListBackupPlans_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListBackupPlans) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListBackupPlans) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListBackupPlans) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListBackupPlans) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListBackupPlans) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListBackupPlans) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListBackupPlans) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListBackupPlans) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListBackupPlans) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListBackupPlans) 

# ListBackupPlanTemplates
<a name="API_ListBackupPlanTemplates"></a>

バックアッププランテンプレートを一覧表示します。

## リクエストの構文
<a name="API_ListBackupPlanTemplates_RequestSyntax"></a>

```
GET /backup/template/plans?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_ListBackupPlanTemplates_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [MaxResults](#API_ListBackupPlanTemplates_RequestSyntax) **   <a name="Backup-ListBackupPlanTemplates-request-uri-MaxResults"></a>
返すアイテムの最大数。  
有効な範囲: 最小値 は 1 です。最大値は 1000 です。

 ** [NextToken](#API_ListBackupPlanTemplates_RequestSyntax) **   <a name="Backup-ListBackupPlanTemplates-request-uri-NextToken"></a>
返された項目の一部リストに続く次の項目。たとえば、`MaxResults` アイテム数のリクエストが行われるようにされた場合、`NextToken` では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。

## リクエスト本文
<a name="API_ListBackupPlanTemplates_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_ListBackupPlanTemplates_ResponseSyntax"></a>

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

{
   "BackupPlanTemplatesList": [ 
      { 
         "BackupPlanTemplateId": "string",
         "BackupPlanTemplateName": "string"
      }
   ],
   "NextToken": "string"
}
```

## レスポンス要素
<a name="API_ListBackupPlanTemplates_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [BackupPlanTemplatesList](#API_ListBackupPlanTemplates_ResponseSyntax) **   <a name="Backup-ListBackupPlanTemplates-response-BackupPlanTemplatesList"></a>
保存したテンプレートに関するメタデータを含むテンプレートリスト項目の配列。  
型: [BackupPlanTemplatesListMember](API_BackupPlanTemplatesListMember.md) オブジェクトの配列

 ** [NextToken](#API_ListBackupPlanTemplates_ResponseSyntax) **   <a name="Backup-ListBackupPlanTemplates-response-NextToken"></a>
返された項目の一部リストに続く次の項目。たとえば、`MaxResults` アイテム数のリクエストが行われるようにされた場合、`NextToken` では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。  
タイプ: 文字列

## エラー
<a name="API_ListBackupPlanTemplates_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_ListBackupPlanTemplates_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListBackupPlanTemplates) 

# ListBackupPlanVersions
<a name="API_ListBackupPlanVersions"></a>

Amazon リソースネーム (ARN)、バックアッププラン ID、作成と削除日、プラン名、バージョン ID など、バックアッププランのバージョンメタデータを返します。

## リクエストの構文
<a name="API_ListBackupPlanVersions_RequestSyntax"></a>

```
GET /backup/plans/backupPlanId/versions/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_ListBackupPlanVersions_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [backupPlanId](#API_ListBackupPlanVersions_RequestSyntax) **   <a name="Backup-ListBackupPlanVersions-request-uri-BackupPlanId"></a>
バックアップ計画を一意に識別します。  
必須: はい

 ** [MaxResults](#API_ListBackupPlanVersions_RequestSyntax) **   <a name="Backup-ListBackupPlanVersions-request-uri-MaxResults"></a>
返されるアイテムの最大数。  
有効な範囲: 最小値 は 1 です。最大値は 1000 です。

 ** [NextToken](#API_ListBackupPlanVersions_RequestSyntax) **   <a name="Backup-ListBackupPlanVersions-request-uri-NextToken"></a>
返された項目の一部リストに続く次の項目。たとえば、`MaxResults` アイテム数のリクエストが行われるようにされた場合、`NextToken` では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。

## リクエスト本文
<a name="API_ListBackupPlanVersions_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_ListBackupPlanVersions_ResponseSyntax"></a>

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

{
   "BackupPlanVersionsList": [ 
      { 
         "AdvancedBackupSettings": [ 
            { 
               "BackupOptions": { 
                  "string" : "string" 
               },
               "ResourceType": "string"
            }
         ],
         "BackupPlanArn": "string",
         "BackupPlanId": "string",
         "BackupPlanName": "string",
         "CreationDate": number,
         "CreatorRequestId": "string",
         "DeletionDate": number,
         "LastExecutionDate": number,
         "VersionId": "string"
      }
   ],
   "NextToken": "string"
}
```

## レスポンス要素
<a name="API_ListBackupPlanVersions_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [BackupPlanVersionsList](#API_ListBackupPlanVersions_ResponseSyntax) **   <a name="Backup-ListBackupPlanVersions-response-BackupPlanVersionsList"></a>
バックアッププランに関するメタデータを含むバージョンリスト項目の配列。  
型: [BackupPlansListMember](API_BackupPlansListMember.md) オブジェクトの配列

 ** [NextToken](#API_ListBackupPlanVersions_ResponseSyntax) **   <a name="Backup-ListBackupPlanVersions-response-NextToken"></a>
返された項目の一部リストに続く次の項目。たとえば、`MaxResults` アイテム数のリクエストが行われるようにされた場合、`NextToken` では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。  
タイプ: 文字列

## エラー
<a name="API_ListBackupPlanVersions_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_ListBackupPlanVersions_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListBackupPlanVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListBackupPlanVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListBackupPlanVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListBackupPlanVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListBackupPlanVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListBackupPlanVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListBackupPlanVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListBackupPlanVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListBackupPlanVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListBackupPlanVersions) 

# ListBackupSelections
<a name="API_ListBackupSelections"></a>

ターゲットバックアッププランに関連付けられたリソースのメタデータを含む配列を返します。

## リクエストの構文
<a name="API_ListBackupSelections_RequestSyntax"></a>

```
GET /backup/plans/backupPlanId/selections/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_ListBackupSelections_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [backupPlanId](#API_ListBackupSelections_RequestSyntax) **   <a name="Backup-ListBackupSelections-request-uri-BackupPlanId"></a>
バックアップ計画を一意に識別します。  
必須: はい

 ** [MaxResults](#API_ListBackupSelections_RequestSyntax) **   <a name="Backup-ListBackupSelections-request-uri-MaxResults"></a>
返されるアイテムの最大数。  
有効な範囲: 最小値 は 1 です。最大値は 1000 です。

 ** [NextToken](#API_ListBackupSelections_RequestSyntax) **   <a name="Backup-ListBackupSelections-request-uri-NextToken"></a>
返された項目の一部リストに続く次の項目。たとえば、`MaxResults` アイテム数のリクエストが行われるようにされた場合、`NextToken` では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。

## リクエスト本文
<a name="API_ListBackupSelections_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_ListBackupSelections_ResponseSyntax"></a>

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

{
   "BackupSelectionsList": [ 
      { 
         "BackupPlanId": "string",
         "CreationDate": number,
         "CreatorRequestId": "string",
         "IamRoleArn": "string",
         "SelectionId": "string",
         "SelectionName": "string"
      }
   ],
   "NextToken": "string"
}
```

## レスポンス要素
<a name="API_ListBackupSelections_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [BackupSelectionsList](#API_ListBackupSelections_ResponseSyntax) **   <a name="Backup-ListBackupSelections-response-BackupSelectionsList"></a>
リスト内の各リソースに関するメタデータを含むバックアップ選択リスト項目の配列。  
型: [BackupSelectionsListMember](API_BackupSelectionsListMember.md) オブジェクトの配列

 ** [NextToken](#API_ListBackupSelections_ResponseSyntax) **   <a name="Backup-ListBackupSelections-response-NextToken"></a>
返された項目の一部リストに続く次の項目。たとえば、`MaxResults` アイテム数のリクエストが行われるようにされた場合、`NextToken` では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。  
タイプ: 文字列

## エラー
<a name="API_ListBackupSelections_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_ListBackupSelections_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListBackupSelections) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListBackupSelections) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListBackupSelections) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListBackupSelections) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListBackupSelections) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListBackupSelections) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListBackupSelections) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListBackupSelections) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListBackupSelections) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListBackupVaults) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListBackupVaults) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListBackupVaults) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListBackupVaults) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListBackupVaults) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListBackupVaults) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListBackupVaults) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListBackupVaults) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListBackupVaults) 
+  [AWS SDK for Ruby V3](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>
たとえば、`arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault` などのバックアップボールトを一意に識別する Amazon リソースネーム (ARN) です。

 ** [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`
+  Amazon DynamoDB 用の `DynamoDB`
+  Amazon Elastic Block Store 用の `EBS`
+  Amazon Elastic Compute Cloud 用の `EC2`
+  Amazon Elastic File System 用の `EFS`
+  `EKS` for Amazon Elastic Kubernetes Service
+  Amazon FSx の場合 用の `FSx`
+  Amazon Neptune の場合 用の `Neptune`
+  Amazon Relational Database Service 用の `RDS`
+  Amazon Redshift 用の `Redshift`
+  Amazon Simple Storage Service (Amazon S3) 用の `S3`
+  Amazon Elastic Compute Cloud インスタンスでの SAP HANA データベース用の `SAP HANA on Amazon EC2`
+  `Storage Gateway` の AWS Storage Gateway 
+  Amazon Timestream 用の `Timestream`
+  VMware 仮想マシン用の `VirtualMachine`
パターン: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

 ** [BySourceRecoveryPointArn](#API_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-request-uri-BySourceRecoveryPointArn"></a>
指定されたソース復旧ポイント ARN でコピージョブをフィルタリングします。

 ** [ByState](#API_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-request-uri-ByState"></a>
指定された状態のコピージョブのみを返します。  
有効な値：`CREATED | RUNNING | COMPLETED | FAILED | PARTIAL`

 ** [MaxResults](#API_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-request-uri-MaxResults"></a>
返されるアイテムの最大数。  
有効な範囲: 最小値 は 1 です。最大値は 1000 です。

 ** [NextToken](#API_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-request-uri-NextToken"></a>
返された項目の一部リストに続く次の項目。例えば、MaxResults の数の項目を返すようにリクエストが行われた場合、NextToken を使用すると、このトークンが指す場所から開始してさらにリストの項目を返すことができます。

## リクエスト本文
<a name="API_ListCopyJobs_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_ListCopyJobs_ResponseSyntax"></a>

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

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

## レスポンス要素
<a name="API_ListCopyJobs_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [CopyJobs](#API_ListCopyJobs_ResponseSyntax) **   <a name="Backup-ListCopyJobs-response-CopyJobs"></a>
JSON 形式で返されたコピージョブに関するメタデータを含む構造体の配列。  
型: [CopyJob](API_CopyJob.md) オブジェクトの配列

 ** [NextToken](#API_ListCopyJobs_ResponseSyntax) **   <a name="Backup-ListCopyJobs-response-NextToken"></a>
返された項目の一部リストに続く次の項目。例えば、MaxResults の数の項目を返すようにリクエストが行われた場合、NextToken を使用すると、このトークンが指す場所から開始してさらにリストの項目を返すことができます。  
タイプ: 文字列

## エラー
<a name="API_ListCopyJobs_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_ListCopyJobs_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListCopyJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListCopyJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListCopyJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListCopyJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListCopyJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListCopyJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListCopyJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListCopyJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListCopyJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListCopyJobs) 

# ListCopyJobSummaries
<a name="API_ListCopyJobSummaries"></a>

このリクエストは、過去 30 日以内に作成または実行されたコピージョブのリストを取得します。AccountID、State、ResourceType、MessageCategory、AggregationPeriod、MaxResults、または NextToken パラメータを使用して、結果をフィルタリングできます。

このリクエストは、該当するジョブの Region、Account、State、ResourceType、MessageCategory、StartTime、EndTime、および Count を含む概要を返します。

## リクエストの構文
<a name="API_ListCopyJobSummaries_RequestSyntax"></a>

```
GET /audit/copy-job-summaries?AccountId=AccountId&AggregationPeriod=AggregationPeriod&MaxResults=MaxResults&MessageCategory=MessageCategory&NextToken=NextToken&ResourceType=ResourceType&State=State HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_ListCopyJobSummaries_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [AccountId](#API_ListCopyJobSummaries_RequestSyntax) **   <a name="Backup-ListCopyJobSummaries-request-uri-AccountId"></a>
指定されたアカウントのジョブ数を返します。  
リクエストがメンバーアカウントまたは AWS Organizations の一部ではないアカウントから送信されると、リクエスタのアカウント内のジョブが返されます。  
ルート、管理者、および委任された管理者アカウントでは、ANY の値を使用して、組織内のすべてのアカウントのジョブ数を返すことができます。  
 `AGGREGATE_ALL` は、認証された組織内のすべてのアカウントのジョブ数を集計し、その合計を返します。  
パターン: `^[0-9]{12}$` 

 ** [AggregationPeriod](#API_ListCopyJobSummaries_RequestSyntax) **   <a name="Backup-ListCopyJobSummaries-request-uri-AggregationPeriod"></a>
返された結果の期間。  
+  `ONE_DAY` – 過去 14 日間の 1 日ごとのジョブ数。
+  `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 Elastic Block Store (Amazon EBS) ボリュームや Amazon Relational Database Service (Amazon RDS) データベースなど。  
パターン: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

 ** [State](#API_ListCopyJobSummaries_RequestSyntax) **   <a name="Backup-ListCopyJobSummaries-request-uri-State"></a>
このパラメータは、指定された状態のジョブの数を返します。  
値 ANY は、すべての状態の数を返します。  
 `AGGREGATE_ALL` は、すべての状態のジョブ数を集計し、その合計を返します。  
有効な値：`CREATED | RUNNING | ABORTING | ABORTED | COMPLETING | COMPLETED | FAILING | FAILED | PARTIAL | AGGREGATE_ALL | ANY`

## リクエスト本文
<a name="API_ListCopyJobSummaries_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_ListCopyJobSummaries_ResponseSyntax"></a>

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

{
   "AggregationPeriod": "string",
   "CopyJobSummaries": [ 
      { 
         "AccountId": "string",
         "Count": number,
         "EndTime": number,
         "MessageCategory": "string",
         "Region": "string",
         "ResourceType": "string",
         "StartTime": number,
         "State": "string"
      }
   ],
   "NextToken": "string"
}
```

## レスポンス要素
<a name="API_ListCopyJobSummaries_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [AggregationPeriod](#API_ListCopyJobSummaries_ResponseSyntax) **   <a name="Backup-ListCopyJobSummaries-response-AggregationPeriod"></a>
返された結果の期間。  
+  `ONE_DAY` – 過去 14 日間の 1 日ごとのジョブ数。
+  `SEVEN_DAYS` – 過去 7 日間の合計のジョブ数。
+  `FOURTEEN_DAYS` – 過去 14 日間の合計のジョブ数。
タイプ: 文字列

 ** [CopyJobSummaries](#API_ListCopyJobSummaries_ResponseSyntax) **   <a name="Backup-ListCopyJobSummaries-response-CopyJobSummaries"></a>
ここには、該当するジョブの Region、Account、State、ResourceType、MessageCategory、StartTime、EndTime、および Count を含む概要が表示されます。  
型: [CopyJobSummary](API_CopyJobSummary.md) オブジェクトの配列

 ** [NextToken](#API_ListCopyJobSummaries_ResponseSyntax) **   <a name="Backup-ListCopyJobSummaries-response-NextToken"></a>
返されるリソースの部分的リストに続く次の項目です。例えば、`MaxResults` の数のリソースを返すようにリクエストが行われた場合、`NextToken` を使用すると、このトークンが指す場所から開始してさらにリストの項目を返すことができます。  
タイプ: 文字列

## エラー
<a name="API_ListCopyJobSummaries_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_ListCopyJobSummaries_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListCopyJobSummaries) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListCopyJobSummaries) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListCopyJobSummaries) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListCopyJobSummaries) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListCopyJobSummaries) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListCopyJobSummaries) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListCopyJobSummaries) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListCopyJobSummaries) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListCopyJobSummaries) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListFrameworks) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListFrameworks) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListFrameworks) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListFrameworks) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListFrameworks) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListFrameworks) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListFrameworks) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListFrameworks) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListFrameworks) 
+  [AWS SDK for Ruby V3](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>
指定されたリソースタイプのインデックス付き復旧ポイントのリストを返します。  
以下のような値を設定できます。  
+  Amazon Elastic Block Store 用の `EBS`
+  Amazon Simple Storage Service (Amazon S3) 用の `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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListIndexedRecoveryPoints) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListIndexedRecoveryPoints) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListIndexedRecoveryPoints) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListIndexedRecoveryPoints) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListIndexedRecoveryPoints) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListIndexedRecoveryPoints) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListIndexedRecoveryPoints) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListIndexedRecoveryPoints) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListIndexedRecoveryPoints) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListIndexedRecoveryPoints) 

# ListLegalHolds
<a name="API_ListLegalHolds"></a>

このアクションは、アクティブなリーガルホールドと以前のリーガルホールドに関するメタデータを返します。

## リクエストの構文
<a name="API_ListLegalHolds_RequestSyntax"></a>

```
GET /legal-holds/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_ListLegalHolds_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [MaxResults](#API_ListLegalHolds_RequestSyntax) **   <a name="Backup-ListLegalHolds-request-uri-MaxResults"></a>
返されるリソースリストアイテムの最大数。  
有効な範囲: 最小値 は 1 です。最大値は 1000 です。

 ** [NextToken](#API_ListLegalHolds_RequestSyntax) **   <a name="Backup-ListLegalHolds-request-uri-NextToken"></a>
返されるリソースの部分的リストに続く次の項目です。例えば、`MaxResults` の数のリソースを返すようにリクエストが行われた場合、`NextToken` を使用すると、このトークンが指す場所から開始してさらにリストの項目を返すことができます。

## リクエスト本文
<a name="API_ListLegalHolds_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_ListLegalHolds_ResponseSyntax"></a>

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

{
   "LegalHolds": [ 
      { 
         "CancellationDate": number,
         "CreationDate": number,
         "Description": "string",
         "LegalHoldArn": "string",
         "LegalHoldId": "string",
         "Status": "string",
         "Title": "string"
      }
   ],
   "NextToken": "string"
}
```

## レスポンス要素
<a name="API_ListLegalHolds_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [LegalHolds](#API_ListLegalHolds_ResponseSyntax) **   <a name="Backup-ListLegalHolds-response-LegalHolds"></a>
これは、返されたリーガルホールド (アクティブなリーガルホールドと以前のリーガルホールドの両方) の配列です。  
型: [LegalHold](API_LegalHold.md) オブジェクトの配列

 ** [NextToken](#API_ListLegalHolds_ResponseSyntax) **   <a name="Backup-ListLegalHolds-response-NextToken"></a>
返されるリソースの部分的リストに続く次の項目です。例えば、`MaxResults` の数のリソースを返すようにリクエストが行われた場合、`NextToken` を使用すると、このトークンが指す場所から開始してさらにリストの項目を返すことができます。  
タイプ: 文字列

## エラー
<a name="API_ListLegalHolds_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_ListLegalHolds_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListLegalHolds) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListLegalHolds) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListLegalHolds) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListLegalHolds) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListLegalHolds) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListLegalHolds) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListLegalHolds) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListLegalHolds) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListLegalHolds) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListLegalHolds) 

# ListProtectedResources
<a name="API_ListProtectedResources"></a>

(復旧ポイント[のステータス](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_DescribeRecoveryPoint.html#Backup-DescribeRecoveryPoint-response-Status)に関係なく) によって AWS Backup 作成された復旧ポイントを持つリソースの配列を返します。これには、リソースが保存された時間、リソースの 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>
リソースの保存時間、リソースの Amazon リソースネーム (ARN)、リソースタイプ AWS Backup を含めて正常にバックアップされたリソースの配列。  
型: [ProtectedResource](API_ProtectedResource.md) オブジェクトの配列

## エラー
<a name="API_ListProtectedResources_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_ListProtectedResources_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListProtectedResources) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListProtectedResources) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListProtectedResources) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListProtectedResources) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListProtectedResources) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListProtectedResources) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListProtectedResources) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListProtectedResources) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListProtectedResources) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListProtectedResources) 

# ListProtectedResourcesByBackupVault
<a name="API_ListProtectedResourcesByBackupVault"></a>

このリクエストには、各バックアップボールトに対応する、保護されたリソースが一覧表示されます。

## リクエストの構文
<a name="API_ListProtectedResourcesByBackupVault_RequestSyntax"></a>

```
GET /backup-vaults/backupVaultName/resources/?backupVaultAccountId=BackupVaultAccountId&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_ListProtectedResourcesByBackupVault_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [BackupVaultAccountId](#API_ListProtectedResourcesByBackupVault_RequestSyntax) **   <a name="Backup-ListProtectedResourcesByBackupVault-request-uri-BackupVaultAccountId"></a>
アカウント ID で指定したボールト内のバックアップボールトによって保護されたリソースのリスト。  
パターン: `^[0-9]{12}$` 

 ** [backupVaultName](#API_ListProtectedResourcesByBackupVault_RequestSyntax) **   <a name="Backup-ListProtectedResourcesByBackupVault-request-uri-BackupVaultName"></a>
名前で指定したボールト内のバックアップボールトによって保護されたリソースのリスト。  
パターン: `^[a-zA-Z0-9\-\_]{2,50}$`   
必須: はい

 ** [MaxResults](#API_ListProtectedResourcesByBackupVault_RequestSyntax) **   <a name="Backup-ListProtectedResourcesByBackupVault-request-uri-MaxResults"></a>
返されるアイテムの最大数。  
有効な範囲: 最小値 は 1 です。最大値は 1000 です。

 ** [NextToken](#API_ListProtectedResourcesByBackupVault_RequestSyntax) **   <a name="Backup-ListProtectedResourcesByBackupVault-request-uri-NextToken"></a>
返された項目の一部リストに続く次の項目。たとえば、`MaxResults` アイテム数のリクエストが行われるようにされた場合、`NextToken` では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。

## リクエスト本文
<a name="API_ListProtectedResourcesByBackupVault_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_ListProtectedResourcesByBackupVault_ResponseSyntax"></a>

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

{
   "NextToken": "string",
   "Results": [ 
      { 
         "LastBackupTime": number,
         "LastBackupVaultArn": "string",
         "LastRecoveryPointArn": "string",
         "ResourceArn": "string",
         "ResourceName": "string",
         "ResourceType": "string"
      }
   ]
}
```

## レスポンス要素
<a name="API_ListProtectedResourcesByBackupVault_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [NextToken](#API_ListProtectedResourcesByBackupVault_ResponseSyntax) **   <a name="Backup-ListProtectedResourcesByBackupVault-response-NextToken"></a>
返された項目の一部リストに続く次の項目。たとえば、`MaxResults` アイテム数のリクエストが行われるようにされた場合、`NextToken` では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。  
タイプ: 文字列

 ** [Results](#API_ListProtectedResourcesByBackupVault_ResponseSyntax) **   <a name="Backup-ListProtectedResourcesByBackupVault-response-Results"></a>
これらは「ListProtectedResourcesByBackupVault」というリクエストに対して返された結果です。  
型: [ProtectedResource](API_ProtectedResource.md) オブジェクトの配列

## エラー
<a name="API_ListProtectedResourcesByBackupVault_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_ListProtectedResourcesByBackupVault_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS SDK for Ruby V3](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 リージョンに一意の名前で識別されます。  
サポートされているサービスが Backup を作成するときに、バックアップボールト名を使用できないことがあります。
パターン: `^[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`
+  Amazon DynamoDB 用の `DynamoDB`
+  Amazon Elastic Block Store 用の `EBS`
+  Amazon Elastic Compute Cloud 用の `EC2`
+  Amazon Elastic File System 用の `EFS`
+  `EKS` for Amazon Elastic Kubernetes Service
+  Amazon FSx の場合 用の `FSx`
+  Amazon Neptune の場合 用の `Neptune`
+  Amazon Relational Database Service 用の `RDS`
+  Amazon Redshift 用の `Redshift`
+  Amazon Simple Storage Service (Amazon S3) 用の `S3`
+  Amazon Elastic Compute Cloud インスタンスでの SAP HANA データベース用の `SAP HANA on Amazon EC2`
+  `Storage Gateway` の AWS Storage Gateway 
+  Amazon Timestream 用の `Timestream`
+  VMware 仮想マシン用の `VirtualMachine`
パターン: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

 ** [MaxResults](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-request-uri-MaxResults"></a>
返されるアイテムの最大数。  
有効な範囲: 最小値 は 1 です。最大値は 1000 です。

 ** [NextToken](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-request-uri-NextToken"></a>
返された項目の一部リストに続く次の項目。たとえば、`MaxResults` アイテム数のリクエストが行われるようにされた場合、`NextToken` では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。

## リクエスト本文
<a name="API_ListRecoveryPointsByBackupVault_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_ListRecoveryPointsByBackupVault_ResponseSyntax"></a>

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

{
   "NextToken": "string",
   "RecoveryPoints": [ 
      { 
         "AggregatedScanResult": { 
            "FailedScan": boolean,
            "Findings": [ "string" ],
            "LastComputed": number
         },
         "BackupSizeInBytes": number,
         "BackupVaultArn": "string",
         "BackupVaultName": "string",
         "CalculatedLifecycle": { 
            "DeleteAt": number,
            "MoveToColdStorageAt": number
         },
         "CompletionDate": number,
         "CompositeMemberIdentifier": "string",
         "CreatedBy": { 
            "BackupPlanArn": "string",
            "BackupPlanId": "string",
            "BackupPlanName": "string",
            "BackupPlanVersion": "string",
            "BackupRuleCron": "string",
            "BackupRuleId": "string",
            "BackupRuleName": "string",
            "BackupRuleTimezone": "string"
         },
         "CreationDate": number,
         "EncryptionKeyArn": "string",
         "EncryptionKeyType": "string",
         "IamRoleArn": "string",
         "IndexStatus": "string",
         "IndexStatusMessage": "string",
         "InitiationDate": number,
         "IsEncrypted": boolean,
         "IsParent": boolean,
         "LastRestoreTime": number,
         "Lifecycle": { 
            "DeleteAfterDays": number,
            "DeleteAfterEvent": "string",
            "MoveToColdStorageAfterDays": number,
            "OptInToArchiveForSupportedResources": boolean
         },
         "ParentRecoveryPointArn": "string",
         "RecoveryPointArn": "string",
         "ResourceArn": "string",
         "ResourceName": "string",
         "ResourceType": "string",
         "SourceBackupVaultArn": "string",
         "Status": "string",
         "StatusMessage": "string",
         "VaultType": "string"
      }
   ]
}
```

## レスポンス要素
<a name="API_ListRecoveryPointsByBackupVault_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [NextToken](#API_ListRecoveryPointsByBackupVault_ResponseSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-response-NextToken"></a>
返された項目の一部リストに続く次の項目。たとえば、`MaxResults` アイテム数のリクエストが行われるようにされた場合、`NextToken` では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。  
タイプ: 文字列

 ** [RecoveryPoints](#API_ListRecoveryPointsByBackupVault_ResponseSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-response-RecoveryPoints"></a>
バックアップボールトに保存された復旧ポイントに関する詳細情報を含むオブジェクトの配列。  
型: [RecoveryPointByBackupVault](API_RecoveryPointByBackupVault.md) オブジェクトの配列

## エラー
<a name="API_ListRecoveryPointsByBackupVault_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_ListRecoveryPointsByBackupVault_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListRecoveryPointsByBackupVault) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListRecoveryPointsByBackupVault) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListRecoveryPointsByBackupVault) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRecoveryPointsByBackupVault) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListRecoveryPointsByBackupVault) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListRecoveryPointsByBackupVault) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListRecoveryPointsByBackupVault) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRecoveryPointsByBackupVault) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListRecoveryPointsByBackupVault) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListRecoveryPointsByBackupVault) 

# ListRecoveryPointsByLegalHold
<a name="API_ListRecoveryPointsByLegalHold"></a>

このアクションは、指定されたリーガルホールドの復旧ポイントの ARN (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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListRecoveryPointsByLegalHold) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListRecoveryPointsByLegalHold) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListRecoveryPointsByLegalHold) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRecoveryPointsByLegalHold) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListRecoveryPointsByLegalHold) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListRecoveryPointsByLegalHold) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListRecoveryPointsByLegalHold) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRecoveryPointsByLegalHold) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListRecoveryPointsByLegalHold) 
+  [AWS SDK for Ruby V3](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 と Amazon EC2 リカバリポイントのみが backupVaultName を返します。
型: [RecoveryPointByResource](API_RecoveryPointByResource.md) オブジェクトの配列

## エラー
<a name="API_ListRecoveryPointsByResource_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_ListRecoveryPointsByResource_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListRecoveryPointsByResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListRecoveryPointsByResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListRecoveryPointsByResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRecoveryPointsByResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListRecoveryPointsByResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListRecoveryPointsByResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListRecoveryPointsByResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRecoveryPointsByResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListRecoveryPointsByResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListRecoveryPointsByResource) 

# ListReportJobs
<a name="API_ListReportJobs"></a>

レポートジョブの詳細を返します。

## リクエストの構文
<a name="API_ListReportJobs_RequestSyntax"></a>

```
GET /audit/report-jobs?CreationAfter=ByCreationAfter&CreationBefore=ByCreationBefore&MaxResults=MaxResults&NextToken=NextToken&ReportPlanName=ByReportPlanName&Status=ByStatus HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_ListReportJobs_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [ByCreationAfter](#API_ListReportJobs_RequestSyntax) **   <a name="Backup-ListReportJobs-request-uri-ByCreationAfter"></a>
Unix 形式および協定世界時 (UTC) で指定された日付と時刻の後に作成されたレポートジョブのみを返します。たとえば、1516925490 の値は、2018年 1月 26日 (金) 午前 12:11:30 を表します。

 ** [ByCreationBefore](#API_ListReportJobs_RequestSyntax) **   <a name="Backup-ListReportJobs-request-uri-ByCreationBefore"></a>
Unix 形式および協定世界時 (UTC) で指定された日付と時刻より前に作成されたレポートジョブのみを返します。たとえば、1516925490 の値は、2018年 1月 26日 (金) 午前 12:11:30 を表します。

 ** [ByReportPlanName](#API_ListReportJobs_RequestSyntax) **   <a name="Backup-ListReportJobs-request-uri-ByReportPlanName"></a>
指定したレポートプラン名を持つレポートジョブのみを返します。  
長さの制約: 最小長は 1 です。最大長は 256 です。  
パターン: `[a-zA-Z][_a-zA-Z0-9]*` 

 ** [ByStatus](#API_ListReportJobs_RequestSyntax) **   <a name="Backup-ListReportJobs-request-uri-ByStatus"></a>
指定されたステータスのレポートジョブのみを返します。ステータスは次のとおりです。  
 `CREATED | RUNNING | COMPLETED | FAILED | COMPLETED_WITH_ISSUES`   
 スキャンジョブのみが問題のある状態で終了することに注意してください。バックアップジョブの場合、これは完了状態で終了し、ステータスメッセージがあるジョブのコンソール解釈です。

 ** [MaxResults](#API_ListReportJobs_RequestSyntax) **   <a name="Backup-ListReportJobs-request-uri-MaxResults"></a>
1 から 1000 の範囲の望ましい結果の数。（オプション）。指定しない場合、クエリは 1 MB のデータを返します。  
有効な範囲: 最小値 は 1 です。最大値は 1000 です。

 ** [NextToken](#API_ListReportJobs_RequestSyntax) **   <a name="Backup-ListReportJobs-request-uri-NextToken"></a>
リスト内の次の項目のセットを返すために使用できる、この操作に対する前回の呼び出しから返された識別子。

## リクエスト本文
<a name="API_ListReportJobs_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_ListReportJobs_ResponseSyntax"></a>

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

{
   "NextToken": "string",
   "ReportJobs": [ 
      { 
         "CompletionTime": number,
         "CreationTime": number,
         "ReportDestination": { 
            "S3BucketName": "string",
            "S3Keys": [ "string" ]
         },
         "ReportJobId": "string",
         "ReportPlanArn": "string",
         "ReportTemplate": "string",
         "Status": "string",
         "StatusMessage": "string"
      }
   ]
}
```

## レスポンス要素
<a name="API_ListReportJobs_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [NextToken](#API_ListReportJobs_ResponseSyntax) **   <a name="Backup-ListReportJobs-response-NextToken"></a>
リスト内の次の項目のセットを返すために使用できる、この操作に対する前回の呼び出しから返された識別子。  
タイプ: 文字列

 ** [ReportJobs](#API_ListReportJobs_ResponseSyntax) **   <a name="Backup-ListReportJobs-response-ReportJobs"></a>
JSON 形式のレポートジョブに関する詳細。  
型: [ReportJob](API_ReportJob.md) オブジェクトの配列

## エラー
<a name="API_ListReportJobs_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_ListReportJobs_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListReportJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListReportJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListReportJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListReportJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListReportJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListReportJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListReportJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListReportJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListReportJobs) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListReportPlans) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListReportPlans) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListReportPlans) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListReportPlans) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListReportPlans) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListReportPlans) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListReportPlans) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListReportPlans) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListReportPlans) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListReportPlans) 

# ListRestoreAccessBackupVaults
<a name="API_ListRestoreAccessBackupVaults"></a>

指定されたバックアップボールトに関連付けられた復元アクセスバックアップボールトのリストを返します。

## リクエストの構文
<a name="API_ListRestoreAccessBackupVaults_RequestSyntax"></a>

```
GET /logically-air-gapped-backup-vaults/backupVaultName/restore-access-backup-vaults/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_ListRestoreAccessBackupVaults_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [backupVaultName](#API_ListRestoreAccessBackupVaults_RequestSyntax) **   <a name="Backup-ListRestoreAccessBackupVaults-request-uri-BackupVaultName"></a>
関連する復元アクセスバックアップボールトを一覧表示する対象のバックアップボールトの名前。  
パターン: `^[a-zA-Z0-9\-\_]{2,50}$`   
必須: はい

 ** [MaxResults](#API_ListRestoreAccessBackupVaults_RequestSyntax) **   <a name="Backup-ListRestoreAccessBackupVaults-request-uri-MaxResults"></a>
レスポンスで返される項目の最大数。  
有効な範囲: 最小値 は 1 です。最大値は 1000 です。

 ** [NextToken](#API_ListRestoreAccessBackupVaults_RequestSyntax) **   <a name="Backup-ListRestoreAccessBackupVaults-request-uri-NextToken"></a>
次の結果セットを取得するために前のリクエストから渡されたページ分割トークン。

## リクエスト本文
<a name="API_ListRestoreAccessBackupVaults_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_ListRestoreAccessBackupVaults_ResponseSyntax"></a>

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

{
   "NextToken": "string",
   "RestoreAccessBackupVaults": [ 
      { 
         "ApprovalDate": number,
         "CreationDate": number,
         "LatestRevokeRequest": { 
            "ExpiryDate": number,
            "InitiationDate": number,
            "MpaSessionArn": "string",
            "Status": "string",
            "StatusMessage": "string"
         },
         "RestoreAccessBackupVaultArn": "string",
         "VaultState": "string"
      }
   ]
}
```

## レスポンス要素
<a name="API_ListRestoreAccessBackupVaults_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [NextToken](#API_ListRestoreAccessBackupVaults_ResponseSyntax) **   <a name="Backup-ListRestoreAccessBackupVaults-response-NextToken"></a>
次の結果セットを取得するために後続のリクエストで使用するページ分割トークン。  
タイプ: 文字列

 ** [RestoreAccessBackupVaults](#API_ListRestoreAccessBackupVaults_ResponseSyntax) **   <a name="Backup-ListRestoreAccessBackupVaults-response-RestoreAccessBackupVaults"></a>
指定されたバックアップボールトに関連付けられた復元アクセスバックアップボールトのリスト。  
型: [RestoreAccessBackupVaultListMember](API_RestoreAccessBackupVaultListMember.md) オブジェクトの配列

## エラー
<a name="API_ListRestoreAccessBackupVaults_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_ListRestoreAccessBackupVaults_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS SDK for Ruby V3](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`
+  Amazon DynamoDB 用の `DynamoDB`
+  Amazon Elastic Block Store 用の `EBS`
+  Amazon Elastic Compute Cloud 用の `EC2`
+  Amazon Elastic File System 用の `EFS`
+  `EKS` for Amazon Elastic Kubernetes Service
+  Amazon FSx の場合 用の `FSx`
+  Amazon Neptune の場合 用の `Neptune`
+  Amazon Relational Database Service 用の `RDS`
+  Amazon Redshift 用の `Redshift`
+  Amazon Simple Storage Service (Amazon S3) 用の `S3`
+  Amazon Elastic Compute Cloud インスタンスでの SAP HANA データベース用の `SAP HANA on Amazon EC2`
+  `Storage Gateway` の AWS Storage Gateway 
+  Amazon Timestream 用の `Timestream`
+  VMware 仮想マシン用の `VirtualMachine`
パターン: `^[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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListRestoreJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListRestoreJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListRestoreJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRestoreJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListRestoreJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListRestoreJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListRestoreJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRestoreJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListRestoreJobs) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListRestoreJobsByProtectedResource) 

# ListRestoreJobSummaries
<a name="API_ListRestoreJobSummaries"></a>

このリクエストは、過去 30 日以内に作成または実行された復元ジョブの概要を取得します。AccountID、State、ResourceType、AggregationPeriod、MaxResults、または NextToken パラメータを使用して、結果をフィルタリングできます。

このリクエストは、該当するジョブの Region、Account、State、ResourceType、MessageCategory、StartTime、EndTime、および Count を含む概要を返します。

## リクエストの構文
<a name="API_ListRestoreJobSummaries_RequestSyntax"></a>

```
GET /audit/restore-job-summaries?AccountId=AccountId&AggregationPeriod=AggregationPeriod&MaxResults=MaxResults&NextToken=NextToken&ResourceType=ResourceType&State=State HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_ListRestoreJobSummaries_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [AccountId](#API_ListRestoreJobSummaries_RequestSyntax) **   <a name="Backup-ListRestoreJobSummaries-request-uri-AccountId"></a>
指定されたアカウントのジョブ数を返します。  
リクエストがメンバーアカウントまたは AWS Organizations の一部ではないアカウントから送信されると、リクエスタのアカウント内のジョブが返されます。  
ルート、管理者、および委任された管理者アカウントでは、ANY の値を使用して、組織内のすべてのアカウントのジョブ数を返すことができます。  
 `AGGREGATE_ALL` は、認証された組織内のすべてのアカウントのジョブ数を集計し、その合計を返します。  
パターン: `^[0-9]{12}$` 

 ** [AggregationPeriod](#API_ListRestoreJobSummaries_RequestSyntax) **   <a name="Backup-ListRestoreJobSummaries-request-uri-AggregationPeriod"></a>
返された結果の期間。  
+  `ONE_DAY` – 過去 14 日間の 1 日ごとのジョブ数。
+  `SEVEN_DAYS` – 過去 7 日間の合計のジョブ数。
+  `FOURTEEN_DAYS` – 過去 14 日間の合計のジョブ数。
有効な値：`ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS`

 ** [MaxResults](#API_ListRestoreJobSummaries_RequestSyntax) **   <a name="Backup-ListRestoreJobSummaries-request-uri-MaxResults"></a>
このパラメータは返されるアイテムの最大数を指定します。  
値は整数です。指定できる値の範囲は 1～500 です。  
有効な範囲: 最小値 は 1 です。最大値は 1000 です。

 ** [NextToken](#API_ListRestoreJobSummaries_RequestSyntax) **   <a name="Backup-ListRestoreJobSummaries-request-uri-NextToken"></a>
返されるリソースの部分的リストに続く次の項目です。例えば、`MaxResults` の数のリソースを返すようにリクエストが行われた場合、`NextToken` を使用すると、このトークンが指す場所から開始してさらにリストの項目を返すことができます。

 ** [ResourceType](#API_ListRestoreJobSummaries_RequestSyntax) **   <a name="Backup-ListRestoreJobSummaries-request-uri-ResourceType"></a>
指定されたリソースタイプのジョブ数を返します。リクエスト `GetSupportedResourceTypes` を使用して、サポートされているリソースタイプの文字列を取得します。  
値 ANY は、すべてのリソースタイプの数を返します。  
 `AGGREGATE_ALL` は、すべてのリソースタイプのジョブ数を集計し、その合計を返します。  
バックアップする AWS リソースのタイプ。Amazon Elastic Block Store (Amazon EBS) ボリュームや Amazon Relational Database Service (Amazon RDS) データベースなど。  
パターン: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

 ** [State](#API_ListRestoreJobSummaries_RequestSyntax) **   <a name="Backup-ListRestoreJobSummaries-request-uri-State"></a>
このパラメータは、指定された状態のジョブの数を返します。  
値 ANY は、すべての状態の数を返します。  
 `AGGREGATE_ALL` は、すべての状態のジョブ数を集計し、その合計を返します。  
有効な値：`CREATED | PENDING | RUNNING | ABORTED | COMPLETED | FAILED | AGGREGATE_ALL | ANY`

## リクエスト本文
<a name="API_ListRestoreJobSummaries_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_ListRestoreJobSummaries_ResponseSyntax"></a>

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

{
   "AggregationPeriod": "string",
   "NextToken": "string",
   "RestoreJobSummaries": [ 
      { 
         "AccountId": "string",
         "Count": number,
         "EndTime": number,
         "Region": "string",
         "ResourceType": "string",
         "StartTime": number,
         "State": "string"
      }
   ]
}
```

## レスポンス要素
<a name="API_ListRestoreJobSummaries_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [AggregationPeriod](#API_ListRestoreJobSummaries_ResponseSyntax) **   <a name="Backup-ListRestoreJobSummaries-response-AggregationPeriod"></a>
返された結果の期間。  
+  `ONE_DAY` – 過去 14 日間の 1 日ごとのジョブ数。
+  `SEVEN_DAYS` – 過去 7 日間の合計のジョブ数。
+  `FOURTEEN_DAYS` – 過去 14 日間の合計のジョブ数。
タイプ: 文字列

 ** [NextToken](#API_ListRestoreJobSummaries_ResponseSyntax) **   <a name="Backup-ListRestoreJobSummaries-response-NextToken"></a>
返されるリソースの部分的リストに続く次の項目です。例えば、`MaxResults` の数のリソースを返すようにリクエストが行われた場合、`NextToken` を使用すると、このトークンが指す場所から開始してさらにリストの項目を返すことができます。  
タイプ: 文字列

 ** [RestoreJobSummaries](#API_ListRestoreJobSummaries_ResponseSyntax) **   <a name="Backup-ListRestoreJobSummaries-response-RestoreJobSummaries"></a>
ここには、該当するジョブの Region、Account、State、ResourceType、MessageCategory、StartTime、EndTime、および Count を含む概要が表示されます。  
型: [RestoreJobSummary](API_RestoreJobSummary.md) オブジェクトの配列

## エラー
<a name="API_ListRestoreJobSummaries_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_ListRestoreJobSummaries_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListRestoreJobSummaries) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListRestoreJobSummaries) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListRestoreJobSummaries) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRestoreJobSummaries) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListRestoreJobSummaries) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListRestoreJobSummaries) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListRestoreJobSummaries) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRestoreJobSummaries) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListRestoreJobSummaries) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListRestoreJobSummaries) 

# ListRestoreTestingPlans
<a name="API_ListRestoreTestingPlans"></a>

復元テストプランのリストを返します。

## リクエストの構文
<a name="API_ListRestoreTestingPlans_RequestSyntax"></a>

```
GET /restore-testing/plans?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_ListRestoreTestingPlans_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [MaxResults](#API_ListRestoreTestingPlans_RequestSyntax) **   <a name="Backup-ListRestoreTestingPlans-request-uri-MaxResults"></a>
返されるアイテムの最大数。  
有効な範囲: 最小値 は 1 です。最大値は 1000 です。

 ** [NextToken](#API_ListRestoreTestingPlans_RequestSyntax) **   <a name="Backup-ListRestoreTestingPlans-request-uri-NextToken"></a>
返された項目の一部リストに続く次の項目。例えば、`MaxResults` の数の項目を返すようにリクエストが行われた場合、`NextToken` を使用すると、このトークンが指す場所から開始してさらにリストの項目を返すことができます。

## リクエスト本文
<a name="API_ListRestoreTestingPlans_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_ListRestoreTestingPlans_ResponseSyntax"></a>

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

{
   "NextToken": "string",
   "RestoreTestingPlans": [ 
      { 
         "CreationTime": number,
         "LastExecutionTime": number,
         "LastUpdateTime": number,
         "RestoreTestingPlanArn": "string",
         "RestoreTestingPlanName": "string",
         "ScheduleExpression": "string",
         "ScheduleExpressionTimezone": "string",
         "StartWindowHours": number
      }
   ]
}
```

## レスポンス要素
<a name="API_ListRestoreTestingPlans_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [NextToken](#API_ListRestoreTestingPlans_ResponseSyntax) **   <a name="Backup-ListRestoreTestingPlans-response-NextToken"></a>
返された項目の一部リストに続く次の項目。例えば、`MaxResults` の数の項目を返すようにリクエストが行われた場合、`NextToken` を使用すると、このトークンが指す場所から開始してさらにリストの項目を返すことができます。  
タイプ: 文字列

 ** [RestoreTestingPlans](#API_ListRestoreTestingPlans_ResponseSyntax) **   <a name="Backup-ListRestoreTestingPlans-response-RestoreTestingPlans"></a>
返される復元テストプランのリストです。  
型: [RestoreTestingPlanForList](API_RestoreTestingPlanForList.md) オブジェクトの配列

## エラー
<a name="API_ListRestoreTestingPlans_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_ListRestoreTestingPlans_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListRestoreTestingPlans) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListRestoreTestingPlans) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListRestoreTestingPlans) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRestoreTestingPlans) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListRestoreTestingPlans) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListRestoreTestingPlans) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListRestoreTestingPlans) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRestoreTestingPlans) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListRestoreTestingPlans) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListRestoreTestingPlans) 

# ListRestoreTestingSelections
<a name="API_ListRestoreTestingSelections"></a>

復元テスト選択のリストを返します。`MaxResults` と `RestoreTestingPlanName` でフィルタリングできます。

## リクエストの構文
<a name="API_ListRestoreTestingSelections_RequestSyntax"></a>

```
GET /restore-testing/plans/RestoreTestingPlanName/selections?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_ListRestoreTestingSelections_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [MaxResults](#API_ListRestoreTestingSelections_RequestSyntax) **   <a name="Backup-ListRestoreTestingSelections-request-uri-MaxResults"></a>
返されるアイテムの最大数。  
有効な範囲: 最小値 は 1 です。最大値は 1000 です。

 ** [NextToken](#API_ListRestoreTestingSelections_RequestSyntax) **   <a name="Backup-ListRestoreTestingSelections-request-uri-NextToken"></a>
返された項目の一部リストに続く次の項目。例えば、`MaxResults` の数の項目を返すようにリクエストが行われた場合、`NextToken` を使用すると、このトークンが指す場所から開始してさらにリストの項目を返すことができます。

 ** [RestoreTestingPlanName](#API_ListRestoreTestingSelections_RequestSyntax) **   <a name="Backup-ListRestoreTestingSelections-request-uri-RestoreTestingPlanName"></a>
指定された復元テストプラン名で復元テスト選択を返します。  
必須: はい

## リクエストボディ
<a name="API_ListRestoreTestingSelections_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_ListRestoreTestingSelections_ResponseSyntax"></a>

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

{
   "NextToken": "string",
   "RestoreTestingSelections": [ 
      { 
         "CreationTime": number,
         "IamRoleArn": "string",
         "ProtectedResourceType": "string",
         "RestoreTestingPlanName": "string",
         "RestoreTestingSelectionName": "string",
         "ValidationWindowHours": number
      }
   ]
}
```

## レスポンス要素
<a name="API_ListRestoreTestingSelections_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [NextToken](#API_ListRestoreTestingSelections_ResponseSyntax) **   <a name="Backup-ListRestoreTestingSelections-response-NextToken"></a>
返された項目の一部リストに続く次の項目。例えば、`MaxResults` の数の項目を返すようにリクエストが行われた場合、`NextToken` を使用すると、このトークンが指す場所から開始してさらにリストの項目を返すことができます。  
タイプ: 文字列

 ** [RestoreTestingSelections](#API_ListRestoreTestingSelections_ResponseSyntax) **   <a name="Backup-ListRestoreTestingSelections-response-RestoreTestingSelections"></a>
復元テストプランに関連付けられた復元テスト選択を返します。  
型: [RestoreTestingSelectionForList](API_RestoreTestingSelectionForList.md) オブジェクトの配列

## エラー
<a name="API_ListRestoreTestingSelections_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_ListRestoreTestingSelections_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListRestoreTestingSelections) 

# ListScanJobs
<a name="API_ListScanJobs"></a>

過去 30 日間の認証済みアカウントの既存のスキャンジョブのリストを返します。

## リクエストの構文
<a name="API_ListScanJobs_RequestSyntax"></a>

```
GET /scan/jobs?ByAccountId=ByAccountId&ByBackupVaultName=ByBackupVaultName&ByCompleteAfter=ByCompleteAfter&ByCompleteBefore=ByCompleteBefore&ByMalwareScanner=ByMalwareScanner&ByRecoveryPointArn=ByRecoveryPointArn&ByResourceArn=ByResourceArn&ByResourceType=ByResourceType&ByScanResultStatus=ByScanResultStatus&ByState=ByState&MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_ListScanJobs_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [ByAccountId](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByAccountId"></a>
ジョブを一覧表示するアカウント ID。指定されたアカウント ID に関連付けられたバックアップジョブのみを返します。  
 AWS Organizations 管理アカウントから使用する場合、 を渡すと、組織全体のすべてのジョブ`*`が返されます。  
パターン: `^[0-9]{12}$` 

 ** [ByBackupVaultName](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByBackupVaultName"></a>
指定されたバックアップボールトに保存されるスキャンジョブのみを返します。バックアップボールトは、作成に使用したアカウントと作成先の AWS リージョンに固有の名前で識別されます。  
パターン: `^[a-zA-Z0-9\-\_\.]{2,50}$` 

 ** [ByCompleteAfter](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByCompleteAfter"></a>
Unix 形式と協定世界時 (UTC) で表された日付より後に完了したスキャンジョブのみを返します。

 ** [ByCompleteBefore](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByCompleteBefore"></a>
Unix 形式および協定世界時 (UTC) で表される日付より前に完了したバックアップジョブのみを返します。

 ** [ByMalwareScanner](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByMalwareScanner"></a>
指定されたマルウェアスキャナーのスキャンジョブのみを返します。現在のところ、`GUARDDUTY` のみサポートされます。  
有効な値：`GUARDDUTY`

 ** [ByRecoveryPointArn](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByRecoveryPointArn"></a>
指定された復旧ポイントに対して実行されたスキャンジョブのみを返します。

 ** [ByResourceArn](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByResourceArn"></a>
指定されたリソース Amazon リソースネーム (ARN) に一致するスキャンジョブのみを返します。

 ** [ByResourceType](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByResourceType"></a>
指定された復元テストプラン名で復元テスト選択を返します。  
+  `EBS`for Amazon Elastic Block Store
+  `EC2`for Amazon Elastic Compute Cloud
+  `S3`for Amazon Simple Storage Service (Amazon S3)
パターン: `^[a-zA-Z0-9\-\_\.]{1,50}$`   
有効な値：`EBS | EC2 | S3`

 ** [ByScanResultStatus](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByScanResultStatus"></a>
指定されたスキャン結果のスキャンジョブのみを返します。  
+  `THREATS_FOUND` 
+  `NO_THREATS_FOUND` 
有効な値：`NO_THREATS_FOUND | THREATS_FOUND`

 ** [ByState](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByState"></a>
指定されたスキャンジョブ状態のスキャンジョブのみを返します。  
有効な値：`CANCELED | COMPLETED | COMPLETED_WITH_ISSUES | CREATED | FAILED | RUNNING`

 ** [MaxResults](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-MaxResults"></a>
返されるアイテムの最大数。  
有効な範囲: 最小値 は 1 です。最大値は 1000 です。  
有効な範囲: 最小値 は 1 です。最大値は 1000 です。

 ** [NextToken](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-NextToken"></a>
返された項目の一部リストに続く次の項目。たとえば、`MaxResults` アイテム数のリクエストが行われるようにされた場合、`NextToken` では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。

## リクエスト本文
<a name="API_ListScanJobs_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_ListScanJobs_ResponseSyntax"></a>

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

{
   "NextToken": "string",
   "ScanJobs": [ 
      { 
         "AccountId": "string",
         "BackupVaultArn": "string",
         "BackupVaultName": "string",
         "CompletionDate": number,
         "CreatedBy": { 
            "BackupPlanArn": "string",
            "BackupPlanId": "string",
            "BackupPlanVersion": "string",
            "BackupRuleId": "string"
         },
         "CreationDate": number,
         "IamRoleArn": "string",
         "MalwareScanner": "string",
         "RecoveryPointArn": "string",
         "ResourceArn": "string",
         "ResourceName": "string",
         "ResourceType": "string",
         "ScanBaseRecoveryPointArn": "string",
         "ScanId": "string",
         "ScanJobId": "string",
         "ScanMode": "string",
         "ScannerRoleArn": "string",
         "ScanResult": { 
            "ScanResultStatus": "string"
         },
         "State": "string",
         "StatusMessage": "string"
      }
   ]
}
```

## レスポンス要素
<a name="API_ListScanJobs_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [NextToken](#API_ListScanJobs_ResponseSyntax) **   <a name="Backup-ListScanJobs-response-NextToken"></a>
返された項目の一部リストに続く次の項目。たとえば、`MaxResults` アイテム数のリクエストが行われるようにされた場合、`NextToken` では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。  
タイプ: 文字列

 ** [ScanJobs](#API_ListScanJobs_ResponseSyntax) **   <a name="Backup-ListScanJobs-response-ScanJobs"></a>
JSON 形式で返されるスキャンジョブに関するメタデータを含む構造体の配列。  
型: [ScanJob](API_ScanJob.md) オブジェクトの配列

## エラー
<a name="API_ListScanJobs_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_ListScanJobs_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListScanJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListScanJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListScanJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListScanJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListScanJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListScanJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListScanJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListScanJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListScanJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListScanJobs) 

# ListScanJobSummaries
<a name="API_ListScanJobSummaries"></a>

これは、過去 30 日以内に作成または実行されたスキャンジョブの概要のリクエストです。

## リクエストの構文
<a name="API_ListScanJobSummaries_RequestSyntax"></a>

```
GET /audit/scan-job-summaries?AccountId=AccountId&AggregationPeriod=AggregationPeriod&MalwareScanner=MalwareScanner&MaxResults=MaxResults&NextToken=NextToken&ResourceType=ResourceType&ScanResultStatus=ScanResultStatus&State=State HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_ListScanJobSummaries_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [AccountId](#API_ListScanJobSummaries_RequestSyntax) **   <a name="Backup-ListScanJobSummaries-request-uri-AccountId"></a>
指定されたアカウントのジョブ数を返します。  
リクエストがメンバーアカウントまたは AWS Organizations の一部ではないアカウントから送信されると、リクエスタのアカウント内のジョブが返されます。  
ルート、管理者、委任された管理者アカウントは、 値を使用して`ANY`、組織内のすべてのアカウントからジョブ数を返すことができます。  
 `AGGREGATE_ALL` は、認証された組織内のすべてのアカウントのジョブ数を集計し、その合計を返します。  
パターン: `^[0-9]{12}$` 

 ** [AggregationPeriod](#API_ListScanJobSummaries_RequestSyntax) **   <a name="Backup-ListScanJobSummaries-request-uri-AggregationPeriod"></a>
返された結果の期間。  
+  `ONE_DAY`過去 1 日間の毎日のジョブ数。
+  `SEVEN_DAYS`過去 7 日間の毎日のジョブ数。
+  `FOURTEEN_DAYS`過去 14 日間の毎日のジョブ数。
有効な値：`ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS`

 ** [MalwareScanner](#API_ListScanJobSummaries_RequestSyntax) **   <a name="Backup-ListScanJobSummaries-request-uri-MalwareScanner"></a>
指定されたマルウェアスキャナーのスキャンジョブのみを返します。現在、MalwareScanner は のみです`GUARDDUTY`。ただし、 フィールドは `ANY`、、および もサポートしています`AGGREGATE_ALL`。  
有効な値：`GUARDDUTY`

 ** [MaxResults](#API_ListScanJobSummaries_RequestSyntax) **   <a name="Backup-ListScanJobSummaries-request-uri-MaxResults"></a>
返されるアイテムの最大数。  
値は整数です。指定できる値の範囲は 1～500 です。  
有効な範囲: 最小値 は 1 です。最大値は 1000 です。

 ** [NextToken](#API_ListScanJobSummaries_RequestSyntax) **   <a name="Backup-ListScanJobSummaries-request-uri-NextToken"></a>
返された項目の一部リストに続く次の項目。たとえば、`MaxResults` アイテム数のリクエストが行われるようにされた場合、`NextToken` では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。

 ** [ResourceType](#API_ListScanJobSummaries_RequestSyntax) **   <a name="Backup-ListScanJobSummaries-request-uri-ResourceType"></a>
指定されたリソースタイプのジョブ数を返します。リクエスト `GetSupportedResourceTypes` を使用して、サポートされているリソースタイプの文字列を取得します。  
この値は、すべてのリソースタイプのカウント`ANY`を返します。  
 `AGGREGATE_ALL` は、すべてのリソースタイプのジョブ数を集計し、その合計を返します。  
パターン: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

 ** [ScanResultStatus](#API_ListScanJobSummaries_RequestSyntax) **   <a name="Backup-ListScanJobSummaries-request-uri-ScanResultStatus"></a>
指定されたスキャン結果のスキャンジョブのみを返します。  
有効な値：`NO_THREATS_FOUND | THREATS_FOUND`

 ** [State](#API_ListScanJobSummaries_RequestSyntax) **   <a name="Backup-ListScanJobSummaries-request-uri-State"></a>
指定されたスキャンジョブ状態のスキャンジョブのみを返します。  
有効な値：`CREATED | COMPLETED | COMPLETED_WITH_ISSUES | RUNNING | FAILED | CANCELED | AGGREGATE_ALL | ANY`

## リクエスト本文
<a name="API_ListScanJobSummaries_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_ListScanJobSummaries_ResponseSyntax"></a>

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

{
   "AggregationPeriod": "string",
   "NextToken": "string",
   "ScanJobSummaries": [ 
      { 
         "AccountId": "string",
         "Count": number,
         "EndTime": number,
         "MalwareScanner": "string",
         "Region": "string",
         "ResourceType": "string",
         "ScanResultStatus": "string",
         "StartTime": number,
         "State": "string"
      }
   ]
}
```

## レスポンス要素
<a name="API_ListScanJobSummaries_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [AggregationPeriod](#API_ListScanJobSummaries_ResponseSyntax) **   <a name="Backup-ListScanJobSummaries-response-AggregationPeriod"></a>
返された結果の期間。  
+  `ONE_DAY`過去 1 日間の毎日のジョブ数。
+  `SEVEN_DAYS`過去 7 日間の毎日のジョブ数。
+  `FOURTEEN_DAYS`過去 14 日間の毎日のジョブ数。
有効な値: `'ONE_DAY'` \$1 `'SEVEN_DAYS'` \$1 `'FOURTEEN_DAYS'`   
タイプ: 文字列

 ** [NextToken](#API_ListScanJobSummaries_ResponseSyntax) **   <a name="Backup-ListScanJobSummaries-response-NextToken"></a>
返された項目の一部リストに続く次の項目。たとえば、`MaxResults` アイテム数のリクエストが行われるようにされた場合、`NextToken` では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。  
タイプ: 文字列

 ** [ScanJobSummaries](#API_ListScanJobSummaries_ResponseSyntax) **   <a name="Backup-ListScanJobSummaries-response-ScanJobSummaries"></a>
概要情報。  
型: [ScanJobSummary](API_ScanJobSummary.md) オブジェクトの配列

## エラー
<a name="API_ListScanJobSummaries_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_ListScanJobSummaries_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListScanJobSummaries) 

# ListTags
<a name="API_ListTags"></a>

ターゲット復旧ポイント、バックアッププラン、バックアップボールトなど、リソースに割り当てられたタグを返します。

このオペレーションは、`resourceArn` の値で使用されるリソースタイプに応じて結果を返します。例えば、詳細設定を含む Amazon DynamoDB の復旧ポイントには、`arn:aws:backup` で始まる ARN (Amazon リソースネーム) があります。詳細設定を有効にしていない DynamoDB の復旧ポイント (バックアップ) には、`arn:aws:dynamodb` で始まる ARN があります。

このオペレーションが呼び出され、`arn:aws:backup` 以外の ARN を持つ `resourceArn` の値を含めると、以下に示す例外のいずれかが返される可能性があります。この例外を回避するには、 AWS Backupによって完全に管理されているリソースタイプを表す値のみを含めます。これらには `arn:aws:backup` で始まる ARN があり、[リソース別の機能の可用性](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListTags) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListTags) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListTags) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListTags) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListTags) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListTags) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListTags) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListTags) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListTags) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListTags) 

# ListTieringConfigurations
<a name="API_ListTieringConfigurations"></a>

階層化設定のリストを返します。

## リクエストの構文
<a name="API_ListTieringConfigurations_RequestSyntax"></a>

```
GET /tiering-configurations/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_ListTieringConfigurations_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [MaxResults](#API_ListTieringConfigurations_RequestSyntax) **   <a name="Backup-ListTieringConfigurations-request-uri-MaxResults"></a>
返されるアイテムの最大数。  
有効な範囲: 最小値 は 1 です。最大値は 1000 です。

 ** [NextToken](#API_ListTieringConfigurations_RequestSyntax) **   <a name="Backup-ListTieringConfigurations-request-uri-NextToken"></a>
返された項目の一部リストに続く次の項目。たとえば、`MaxResults` アイテム数のリクエストが行われるようにされた場合、`NextToken` では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。

## リクエスト本文
<a name="API_ListTieringConfigurations_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_ListTieringConfigurations_ResponseSyntax"></a>

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

{
   "NextToken": "string",
   "TieringConfigurations": [ 
      { 
         "BackupVaultName": "string",
         "CreationTime": number,
         "LastUpdatedTime": number,
         "TieringConfigurationArn": "string",
         "TieringConfigurationName": "string"
      }
   ]
}
```

## レスポンス要素
<a name="API_ListTieringConfigurations_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [NextToken](#API_ListTieringConfigurations_ResponseSyntax) **   <a name="Backup-ListTieringConfigurations-response-NextToken"></a>
返された項目の一部リストに続く次の項目。たとえば、`MaxResults` アイテム数のリクエストが行われるようにされた場合、`NextToken` では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。  
タイプ: 文字列

 ** [TieringConfigurations](#API_ListTieringConfigurations_ResponseSyntax) **   <a name="Backup-ListTieringConfigurations-response-TieringConfigurations"></a>
`ListTieringConfigurations` 呼び出しによって返される階層化設定の配列。  
型: [TieringConfigurationsListMember](API_TieringConfigurationsListMember.md) オブジェクトの配列

## エラー
<a name="API_ListTieringConfigurations_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_ListTieringConfigurations_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/ListTieringConfigurations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListTieringConfigurations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListTieringConfigurations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListTieringConfigurations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListTieringConfigurations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListTieringConfigurations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListTieringConfigurations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListTieringConfigurations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListTieringConfigurations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListTieringConfigurations) 

# PutBackupVaultAccessPolicy
<a name="API_PutBackupVaultAccessPolicy"></a>

ターゲットのバックアップボールトのアクセス許可を管理するために使用されるリソースベースのポリシーを設定します。バックアップボールト名と JSON 形式のアクセスポリシードキュメントが必要です。

## リクエストの構文
<a name="API_PutBackupVaultAccessPolicy_RequestSyntax"></a>

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

{
   "Policy": "string"
}
```

## URI リクエストパラメータ
<a name="API_PutBackupVaultAccessPolicy_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [backupVaultName](#API_PutBackupVaultAccessPolicy_RequestSyntax) **   <a name="Backup-PutBackupVaultAccessPolicy-request-uri-BackupVaultName"></a>
バックアップを保存する論理コンテナの名前。バックアップボールトは、これらのボールトを作成するために使用されたアカウントと作成先の AWS リージョンに一意の名前で識別されます。  
パターン: `^[a-zA-Z0-9\-\_]{2,50}$`   
必須: はい

## リクエストボディ
<a name="API_PutBackupVaultAccessPolicy_RequestBody"></a>

リクエストは以下の JSON 形式のデータを受け入れます。

 ** [Policy](#API_PutBackupVaultAccessPolicy_RequestSyntax) **   <a name="Backup-PutBackupVaultAccessPolicy-request-Policy"></a>
JSON 形式のバックアップボールトのアクセスポリシードキュメント。  
タイプ: 文字列  
必須: いいえ

## レスポンスの構文
<a name="API_PutBackupVaultAccessPolicy_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## レスポンス要素
<a name="API_PutBackupVaultAccessPolicy_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

## エラー
<a name="API_PutBackupVaultAccessPolicy_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_PutBackupVaultAccessPolicy_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/PutBackupVaultAccessPolicy) 

# PutBackupVaultLockConfiguration
<a name="API_PutBackupVaultLockConfiguration"></a>

 AWS Backup ボールトロックをバックアップボールトに適用し、 に保存されている、またはバックアップボールトに作成された復旧ポイントの削除を試みないようにします。また、Vault Lock では、バックアップボールトに現在保存されているリカバリポイントの保持期間を制御するライフサイクルポリシーの更新も防止されます。指定した場合、Vault Lock は、バックアップボールトを対象とする将来のバックアップジョブおよびコピージョブに対して、最小および最大保持期間を適用します。

**注記**  
 AWS Backup ボールトロックは、SEC 17a-4、CFTC、および FINRA の規制の対象となる環境での使用について Cohasset Associates によって評価されています。 AWS Backup ボールトロックがこれらの規制にどのように関連しているかの詳細については、[「Cohasset Associates Compliance Assessment」を参照してください。](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 時 UTC に `ChangeableForDays` を 30 に設定した場合、2022 年 1 月 31 日午後 8 時 UTC にロック日が設定されます。  
 AWS Backup は、ボールトロックが有効になり、イミュータブルになる前に 72 時間のクーリングオフ期間を適用します。したがって、`ChangeableForDays` を 3 以上に設定する必要があります。  
指定できる最大値は 36,500 日 (約 100 年) です。  
ロック日より前には、`DeleteBackupVaultLockConfiguration` を使用して ボールトロックをボールトから削除でき、また、`PutBackupVaultLockConfiguration` を使用してボールトロックの構成を変更します。ロック日以降では、ボールトロックは不変になり、変更や削除はできません。  
このパラメータを指定しない場合は、`DeleteBackupVaultLockConfiguration` を使用してボールトからボールトロックを削除でき、または、`PutBackupVaultLockConfiguration` を使用して、いつでもボールトロックの設定を変更できます。  
タイプ: Long  
必須: いいえ

 ** [MaxRetentionDays](#API_PutBackupVaultLockConfiguration_RequestSyntax) **   <a name="Backup-PutBackupVaultLockConfiguration-request-MaxRetentionDays"></a>
 AWS Backup ボールトが復旧ポイントを保持する最大保持期間を指定するボールトロック設定。この設定は、たとえば、組織のポリシーで 4 年間（1460 日）保持した後に特定のデータを破棄する必要がある場合などに便利です。  
このパラメータを指定しない場合、ボールトロックはボールト内のリカバリポイントに最大保持期間を強制しません。このパラメータが値なしで含まれている場合、ボールトロックは最大保持期間を適用しません。  
このパラメータを指定した場合、ボールトへのバックアップジョブまたはコピージョブには、保存期間が最大保存期間以下のライフサイクル・ポリシーを持つ必要があります。ジョブの保持期間がその最大保存期間よりも長い場合、ボールトはバックアップジョブまたはコピージョブに失敗するため、ライフサイクル設定を変更するか、別のボールトを使用する必要があります。指定できる最長の最大保持期間は 36500 日 (約 100 年) です。ボールトロックの前にボールトにすでに保存されている復旧ポイントは影響を受けません。  
タイプ: Long  
必須: いいえ

 ** [MinRetentionDays](#API_PutBackupVaultLockConfiguration_RequestSyntax) **   <a name="Backup-PutBackupVaultLockConfiguration-request-MinRetentionDays"></a>
 AWS Backup ボールトが復旧ポイントを保持する最小保持期間を指定するボールトロック設定。この設定は、たとえば、組織のポリシーで特定のデータを少なくとも 7 年間（2555 日）保持する必要がある場合に便利です。  
このパラメータは、 を使用してボールトロックを作成するときに必要です AWS CloudFormation。それ以外の場合は、このパラメータはオプションです。このパラメータを指定しない場合、ボールトロックは最小保持期間を強制しません。  
このパラメータを指定した場合、ボールトへのバックアップジョブまたはコピージョブには、最小保存期間以上の保存期間を持つライフサイクルポリシーが必要です。ジョブの保持期間がその最小保存期間よりも短い場合、ボールトはそのバックアップジョブまたはコピージョブに失敗するため、ライフサイクル設定を変更するか、別のボールトを使用する必要があります。指定できる最小保持期間は 1 日です。ボールトロックの前にボールトにすでに保存されている復旧ポイントは影響を受けません。  
タイプ: Long  
必須: いいえ

## レスポンスの構文
<a name="API_PutBackupVaultLockConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## レスポンス要素
<a name="API_PutBackupVaultLockConfiguration_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

## エラー
<a name="API_PutBackupVaultLockConfiguration_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** InvalidRequestException **   
リクエストへの入力に何らかの問題が発生していることを示します。たとえば、パラメータのタイプが間違っています。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_PutBackupVaultLockConfiguration_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/PutBackupVaultLockConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/PutBackupVaultLockConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/PutBackupVaultLockConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/PutBackupVaultLockConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/PutBackupVaultLockConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/PutBackupVaultLockConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/PutBackupVaultLockConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/PutBackupVaultLockConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/PutBackupVaultLockConfiguration) 
+  [AWS SDK for Ruby V3](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>
たとえば、`arn:aws:sns:us-west-2:111122223333:MyVaultTopic` などのバックアップボールトのイベントのトピックを指定する Amazon リソースネーム (ARN)。  
タイプ: 文字列  
必須: はい

## レスポンスの構文
<a name="API_PutBackupVaultNotifications_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## レスポンス要素
<a name="API_PutBackupVaultNotifications_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

## エラー
<a name="API_PutBackupVaultNotifications_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_PutBackupVaultNotifications_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/PutBackupVaultNotifications) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/PutBackupVaultNotifications) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/PutBackupVaultNotifications) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/PutBackupVaultNotifications) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/PutBackupVaultNotifications) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/PutBackupVaultNotifications) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/PutBackupVaultNotifications) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/PutBackupVaultNotifications) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/PutBackupVaultNotifications) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/PutBackupVaultNotifications) 

# PutRestoreValidationResult
<a name="API_PutRestoreValidationResult"></a>

このリクエストにより、独立した自己実行による復元テストの検証結果を送信できます。`RestoreJobId` および `ValidationStatus` は必須です。オプションで `ValidationStatusMessage` を入力できます。

## リクエストの構文
<a name="API_PutRestoreValidationResult_RequestSyntax"></a>

```
PUT /restore-jobs/restoreJobId/validations HTTP/1.1
Content-type: application/json

{
   "ValidationStatus": "string",
   "ValidationStatusMessage": "string"
}
```

## URI リクエストパラメータ
<a name="API_PutRestoreValidationResult_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [restoreJobId](#API_PutRestoreValidationResult_RequestSyntax) **   <a name="Backup-PutRestoreValidationResult-request-uri-RestoreJobId"></a>
これは、復元ジョブの一意の識別子です AWS Backup。  
必須: はい

## リクエストボディ
<a name="API_PutRestoreValidationResult_RequestBody"></a>

リクエストは以下の JSON 形式のデータを受け入れます。

 ** [ValidationStatus](#API_PutRestoreValidationResult_RequestSyntax) **   <a name="Backup-PutRestoreValidationResult-request-ValidationStatus"></a>
復元の検証ステータス。  
型: 文字列  
有効な値：`FAILED | SUCCESSFUL | TIMED_OUT | VALIDATING`  
必須: はい

 ** [ValidationStatusMessage](#API_PutRestoreValidationResult_RequestSyntax) **   <a name="Backup-PutRestoreValidationResult-request-ValidationStatusMessage"></a>
オプションのメッセージ文字列で、復元テストの検証のステータスを説明するために入力できます。  
タイプ: 文字列  
必須: いいえ

## レスポンスの構文
<a name="API_PutRestoreValidationResult_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## レスポンス要素
<a name="API_PutRestoreValidationResult_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 204 レスポンスを返します。

## エラー
<a name="API_PutRestoreValidationResult_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** InvalidRequestException **   
リクエストへの入力に何らかの問題が発生していることを示します。たとえば、パラメータのタイプが間違っています。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_PutRestoreValidationResult_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/PutRestoreValidationResult) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/PutRestoreValidationResult) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/PutRestoreValidationResult) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/PutRestoreValidationResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/PutRestoreValidationResult) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/PutRestoreValidationResult) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/PutRestoreValidationResult) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/PutRestoreValidationResult) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/PutRestoreValidationResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/PutRestoreValidationResult) 

# RevokeRestoreAccessBackupVault
<a name="API_RevokeRestoreAccessBackupVault"></a>

復元アクセスバックアップボールトへのアクセスを取り消し、復旧ポイントから復元する機能を削除して、ボールトを完全に削除します。

## リクエストの構文
<a name="API_RevokeRestoreAccessBackupVault_RequestSyntax"></a>

```
DELETE /logically-air-gapped-backup-vaults/backupVaultName/restore-access-backup-vaults/restoreAccessBackupVaultArn?requesterComment=RequesterComment HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_RevokeRestoreAccessBackupVault_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [backupVaultName](#API_RevokeRestoreAccessBackupVault_RequestSyntax) **   <a name="Backup-RevokeRestoreAccessBackupVault-request-uri-BackupVaultName"></a>
取り消す復元アクセスバックアップボールトに関連付けられたソースバックアップボールトの名前。  
パターン: `^[a-zA-Z0-9\-\_]{2,50}$`   
必須: はい

 ** [RequesterComment](#API_RevokeRestoreAccessBackupVault_RequestSyntax) **   <a name="Backup-RevokeRestoreAccessBackupVault-request-uri-RequesterComment"></a>
復元アクセスバックアップボールトへのアクセスを取り消す理由を説明するコメント。

 ** [restoreAccessBackupVaultArn](#API_RevokeRestoreAccessBackupVault_RequestSyntax) **   <a name="Backup-RevokeRestoreAccessBackupVault-request-uri-RestoreAccessBackupVaultArn"></a>
取り消す復元アクセスバックアップボールトの ARN。  
必須: はい

## リクエストボディ
<a name="API_RevokeRestoreAccessBackupVault_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_RevokeRestoreAccessBackupVault_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## レスポンス要素
<a name="API_RevokeRestoreAccessBackupVault_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

## エラー
<a name="API_RevokeRestoreAccessBackupVault_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** InvalidRequestException **   
リクエストへの入力に何らかの問題が発生していることを示します。たとえば、パラメータのタイプが間違っています。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_RevokeRestoreAccessBackupVault_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS SDK for Ruby V3](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 リージョンに一意の名前で識別されます。  
タイプ: 文字列  
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`   
必須: はい

 ** [CompleteWindowMinutes](#API_StartBackupJob_RequestSyntax) **   <a name="Backup-StartBackupJob-request-CompleteWindowMinutes"></a>
正常に開始されたバックアップを完了する必要がある時間（分単位）、または AWS Backup がジョブをキャンセルします。この値はオプションです。この値は、バックアップがスケジュールされた時点からカウントダウンを開始します。`StartWindowMinutes` またはバックアップがスケジュールより遅れて開始された場合、追加時間は追加されません。  
`StartWindowMinutes` と同様に、このパラメータの最大値は 100 年 (52,560,000 分) です。  
タイプ: Long  
必須: いいえ

 ** [IamRoleArn](#API_StartBackupJob_RequestSyntax) **   <a name="Backup-StartBackupJob-request-IamRoleArn"></a>
ターゲット復旧ポイントの作成に使用する IAM ロール ARN を指定します。例えば、`arn:aws:iam::123456789012:role/S3Access`です。  
タイプ: 文字列  
必須: はい

 ** [IdempotencyToken](#API_StartBackupJob_RequestSyntax) **   <a name="Backup-StartBackupJob-request-IdempotencyToken"></a>
別の `StartBackupJob` への同じコール間を区別するために使用できる顧客が選択した文字列。同じ冪等性トークンで成功したリクエストを再試行すると、アクションは実行されず、成功メッセージが表示されます。  
タイプ: 文字列  
必須: いいえ

 ** [Index](#API_StartBackupJob_RequestSyntax) **   <a name="Backup-StartBackupJob-request-Index"></a>
バックアップジョブにバックアップインデックスをサポートするリソースタイプがある場合は、このパラメータを含めてインデックスの作成を有効にします。  
バックアップインデックスをサポートするリソースタイプは次のとおりです。  
+  Amazon Elastic Block Store 用の `EBS`
+  Amazon Simple Storage Service (Amazon S3) 用の `S3`
インデックスには、`ENABLED` または `DISABLED` の 2 つの値のいずれかを指定できます。  
バックアップインデックスがまだ作成されていない、対象となる `ACTIVE` 復旧ポイントのバックアップインデックスを作成するには、値を `ENABLED` に設定します。  
バックアップインデックスを削除するには、値を `DISABLED` に設定します。  
型: 文字列  
有効な値：`ENABLED | DISABLED`  
必須：いいえ

 ** [Lifecycle](#API_StartBackupJob_RequestSyntax) **   <a name="Backup-StartBackupJob-request-Lifecycle"></a>
ライフサイクルは、保護されたリソースがコールドストレージに移行するタイミングと期限切れになるタイミングを定義します。 AWS Backup は、定義したライフサイクルに従ってバックアップを自動的に移行して期限切れにします。  
コールドストレージに移行するバックアップは、最低 90 日間コールドストレージに保存する必要があります。したがって、「保持期間」の設定は、「コールドへの移行 (日数)」設定から 90 日以上あける必要があります。バックアップがコールドに移行された後で、「コールドへの移行 (日数)」設定を変更することはできません。  
コールドストレージに移行できるリソースタイプは、「[Feature availability by resource](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource) table. AWS Backup ignores this expression for other resource types」に記載されています。  
このパラメータの最大値は 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 は、バックアップが正常に開始されるまで (ジョブステータスが に変わる）、またはジョブステータスが に変わるまで `EXPIRED` (開始ウィンドウ時間が終了すると予想される`RUNNING`)、少なくとも 10 分ごとにジョブの開始を自動的に再試行します。  
タイプ: Long  
必須: いいえ

## レスポンスの構文
<a name="API_StartBackupJob_ResponseSyntax"></a>

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

{
   "BackupJobId": "string",
   "CreationDate": number,
   "IsParent": boolean,
   "RecoveryPointArn": "string"
}
```

## レスポンス要素
<a name="API_StartBackupJob_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [BackupJobId](#API_StartBackupJob_ResponseSyntax) **   <a name="Backup-StartBackupJob-response-BackupJobId"></a>
リソースをバックアップ AWS Backup するための へのリクエストを一意に識別します。  
タイプ: 文字列

 ** [CreationDate](#API_StartBackupJob_ResponseSyntax) **   <a name="Backup-StartBackupJob-response-CreationDate"></a>
バックアップジョブが作成された日時 (Unix 時刻形式および協定世界時 (UTC))。`CreationDate`の値はミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。  
タイプ: タイムスタンプ

 ** [IsParent](#API_StartBackupJob_ResponseSyntax) **   <a name="Backup-StartBackupJob-response-IsParent"></a>
これは親 (複合) バックアップジョブであることを示す、返されたブール値です。  
タイプ: ブール値

 ** [RecoveryPointArn](#API_StartBackupJob_ResponseSyntax) **   <a name="Backup-StartBackupJob-response-RecoveryPointArn"></a>
 *注: このフィールドは Amazon EFS リソースと高度な DynamoDB リソースのみで返されます。*  
リカバリーポイントを一意に識別する ARN、たとえば、`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45` です。  
タイプ: 文字列

## エラー
<a name="API_StartBackupJob_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** InvalidRequestException **   
リクエストへの入力に何らかの問題が発生していることを示します。たとえば、パラメータのタイプが間違っています。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** LimitExceededException **   
たとえば、リクエストで許可されるアイテムの最大数などのリクエストの制限を超えました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_StartBackupJob_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/StartBackupJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/StartBackupJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/StartBackupJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/StartBackupJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/StartBackupJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/StartBackupJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/StartBackupJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/StartBackupJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/StartBackupJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/StartBackupJob) 

# StartCopyJob
<a name="API_StartCopyJob"></a>

ジョブを開始し、指定したリソースの 1 回限りのコピーを作成します。

連続バックアップをサポートしません。

が[ジョブオペレーションのコピーを再試行](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>
たとえば、`arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault` などのコピーするバックアップボールトを一意に識別する Amazon リソースネーム (ARN) です。  
タイプ: 文字列  
必須: はい

 ** [IamRoleArn](#API_StartCopyJob_RequestSyntax) **   <a name="Backup-StartCopyJob-request-IamRoleArn"></a>
たとえば、`arn:aws:iam::123456789012:role/S3Access` などのターゲットリカバリポイントのコピーに使用する IAM ロール ARN を指定します。  
タイプ: 文字列  
必須: はい

 ** [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 日長くする必要があります。バックアップがコールドに移行された後で、コールドへの移行 (日数) の設定を変更することはできません。  
コールドストレージに移行できるリソースタイプは、「[Feature availability by resource](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource) table. AWS Backup ignores this expression for other resource types」に記載されています。  
既存のライフサイクルと保持期間を削除し、復旧ポイントを無期限に保持するには、`MoveToColdStorageAfterDays` と `DeleteAfterDays` に -1 を指定します。  
型: [Lifecycle](API_Lifecycle.md) オブジェクト  
必須: いいえ

 ** [RecoveryPointArn](#API_StartCopyJob_RequestSyntax) **   <a name="Backup-StartCopyJob-request-RecoveryPointArn"></a>
たとえば、arn:aws:backup:us-east-1:123456789012:recovery-point:1eb3456789012:recovery-point:1eb3456789012:recovery-point: 1eb3456789012 などのコピージョブに使用するリカバリポイントを一意に識別する ARN。  
タイプ: 文字列  
必須: はい

 ** [SourceBackupVaultName](#API_StartCopyJob_RequestSyntax) **   <a name="Backup-StartCopyJob-request-SourceBackupVaultName"></a>
バックアップを保存する論理ソースコンテナの名前。バックアップボールトは、作成に使用したアカウントと作成先の AWS リージョンに固有の名前で識別されます。  
タイプ: 文字列  
Pattern: `^[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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/StartCopyJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/StartCopyJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/StartCopyJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/StartCopyJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/StartCopyJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/StartCopyJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/StartCopyJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/StartCopyJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/StartCopyJob) 
+  [AWS SDK for Ruby V3](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>
レポートジョブの識別子。一意のランダムに生成された UTF-8 エンコード Unicode 文字列 (最大 1,024 バイト長)。レポートジョブ ID を編集することはできません。  
タイプ: 文字列

## エラー
<a name="API_StartReportJob_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_StartReportJob_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/StartReportJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/StartReportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/StartReportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/StartReportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/StartReportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/StartReportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/StartReportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/StartReportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/StartReportJob) 
+  [AWS SDK for Ruby V3](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 ロールの Amazon リソースネーム (ARN)。例: `arn:aws:iam::123456789012:role/S3Access`。  
タイプ: 文字列  
必須: いいえ

 ** [IdempotencyToken](#API_StartRestoreJob_RequestSyntax) **   <a name="Backup-StartRestoreJob-request-IdempotencyToken"></a>
別の `StartRestoreJob` への同じコール間を区別するために使用できる顧客が選択した文字列。同じ冪等性トークンで成功したリクエストを再試行すると、アクションは実行されず、成功メッセージが表示されます。  
タイプ: 文字列  
必須: いいえ

 ** [Metadata](#API_StartRestoreJob_RequestSyntax) **   <a name="Backup-StartRestoreJob-request-Metadata"></a>
メタデータのキーと値のペアのセット。  
`GetRecoveryPointRestoreMetadata` を呼び出して、バックアップ時にリソースに関する構成メタデータを取得できます。ただし、`GetRecoveryPointRestoreMetadata` によって提供される値に加えて値リソースの復元が必要になる場合があります。たとえば、元のリソースがすでに存在する場合は、新しいリソース名を指定する必要があります。  
各リソースのメタデータの詳細については、以下を参照してください。  
+  [Amazon Aurora のメタデータ](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-aur.html#aur-restore-cli) 
+  [Amazon DocumentDB のメタデータ](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-docdb.html#docdb-restore-cli) 
+  [のメタデータ AWS CloudFormation](https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-application-stacks.html#restoring-cfn-cli) 
+  [Amazon DynamoDB のメタデータ](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-dynamodb.html#ddb-restore-cli) 
+  [Amazon EBS のメタデータ](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-ebs.html#ebs-restore-cli) 
+  [Amazon EC2 のメタデータ](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-ec2.html#restoring-ec2-cli) 
+  [Amazon EFS のメタデータ](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-efs.html#efs-restore-cli) 
+  [Amazon EKS のメタデータ](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-eks.html#eks-restore-backup-section) 
+  [Amazon FSx のメタデータ](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-fsx.html#fsx-restore-cli) 
+  [Amazon Neptune のメタデータ](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-nep.html#nep-restore-cli) 
+  [Amazon RDS のメタデータ](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-rds.html#rds-restore-cli) 
+  [Amazon Redshift のメタデータ](https://docs.aws.amazon.com/aws-backup/latest/devguide/redshift-restores.html#redshift-restore-api) 
+  [のメタデータ AWS Storage Gateway](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-storage-gateway.html#restoring-sgw-cli) 
+  [Amazon S3 のメタデータ](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-s3.html#s3-restore-cli) 
+  [Amazon Timestream のメタデータ](https://docs.aws.amazon.com/aws-backup/latest/devguide/timestream-restore.html#timestream-restore-api) 
+  [仮想マシンのメタデータ](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-vm.html#vm-restore-cli) 
タイプ: 文字列間のマッピング  
必須: はい

 ** [RecoveryPointArn](#API_StartRestoreJob_RequestSyntax) **   <a name="Backup-StartRestoreJob-request-RecoveryPointArn"></a>
たとえば、`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`などのリカバリポイントを一意に識別する ARN。  
タイプ: 文字列  
必須: はい

 ** [ResourceType](#API_StartRestoreJob_RequestSyntax) **   <a name="Backup-StartRestoreJob-request-ResourceType"></a>
次のいずれかのリソースのリカバリポイントを復元するジョブを開始します。  
+  `Aurora` – Amazon Aurora
+  `DocumentDB` – Amazon DocumentDB
+  `CloudFormation` - AWS CloudFormation 
+  `DynamoDB` – Amazon DynamoDB
+  `EBS` – Amazon Elastic Block Store
+  `EC2` – Amazon Elastic Compute Cloud
+  `EFS` – Amazon Elastic File System
+  `EKS` - Amazon Elastic Kubernetes サービス
+  `FSx` – Amazon FSx
+  `Neptune` – Amazon Neptune
+  `RDS` – Amazon Relational Database Service
+  `Redshift` – Amazon Redshift
+  `Storage Gateway` - AWS Storage Gateway 
+  `S3` – Amazon Simple Storage Service
+  `Timestream` – Amazon Timestream
+  `VirtualMachine` – 仮想マシン
タイプ: 文字列  
パターン: `^[a-zA-Z0-9\-\_\.]{1,50}$`   
必須: いいえ

## レスポンスの構文
<a name="API_StartRestoreJob_ResponseSyntax"></a>

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

{
   "RestoreJobId": "string"
}
```

## レスポンス要素
<a name="API_StartRestoreJob_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [RestoreJobId](#API_StartRestoreJob_ResponseSyntax) **   <a name="Backup-StartRestoreJob-response-RestoreJobId"></a>
リカバリポイントをリストアするジョブを一意に識別します。  
タイプ: 文字列

## エラー
<a name="API_StartRestoreJob_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** InvalidRequestException **   
リクエストへの入力に何らかの問題が発生していることを示します。たとえば、パラメータのタイプが間違っています。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_StartRestoreJob_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/StartRestoreJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/StartRestoreJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/StartRestoreJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/StartRestoreJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/StartRestoreJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/StartRestoreJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/StartRestoreJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/StartRestoreJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/StartRestoreJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/StartRestoreJob) 

# StartScanJob
<a name="API_StartScanJob"></a>

特定のリソースのスキャンジョブを開始します。

## リクエストの構文
<a name="API_StartScanJob_RequestSyntax"></a>

```
PUT /scan/job HTTP/1.1
Content-type: application/json

{
   "BackupVaultName": "string",
   "IamRoleArn": "string",
   "IdempotencyToken": "string",
   "MalwareScanner": "string",
   "RecoveryPointArn": "string",
   "ScanBaseRecoveryPointArn": "string",
   "ScanMode": "string",
   "ScannerRoleArn": "string"
}
```

## URI リクエストパラメータ
<a name="API_StartScanJob_RequestParameters"></a>

リクエストでは URI パラメータを使用しません。

## リクエストボディ
<a name="API_StartScanJob_RequestBody"></a>

リクエストは以下の JSON 形式のデータを受け入れます。

 ** [BackupVaultName](#API_StartScanJob_RequestSyntax) **   <a name="Backup-StartScanJob-request-BackupVaultName"></a>
バックアップを保存する論理コンテナの名前。バックアップボールトは、作成に使用したアカウントと作成先の AWS リージョンに固有の名前で識別されます。  
パターン: `^[a-zA-Z0-9\-\_]{2,50}$`   
タイプ: 文字列  
必須: はい

 ** [IamRoleArn](#API_StartScanJob_RequestSyntax) **   <a name="Backup-StartScanJob-request-IamRoleArn"></a>
ターゲット復旧ポイントの作成に使用する IAM ロール ARN を指定します。例えば、`arn:aws:iam::123456789012:role/S3Access`です。  
タイプ: 文字列  
必須: はい

 ** [IdempotencyToken](#API_StartScanJob_RequestSyntax) **   <a name="Backup-StartScanJob-request-IdempotencyToken"></a>
別の `StartScanJob` への同じコール間を区別するために使用できる顧客が選択した文字列。同じ冪等性トークンで成功したリクエストを再試行すると、アクションは実行されず、成功メッセージが表示されます。  
タイプ: 文字列  
必須: いいえ

 ** [MalwareScanner](#API_StartScanJob_RequestSyntax) **   <a name="Backup-StartScanJob-request-MalwareScanner"></a>
スキャンジョブ中に使用されるマルウェアスキャナーを指定します。現在のところ、`GUARDDUTY` のみサポートされます。  
型: 文字列  
有効な値：`GUARDDUTY`  
必須: はい

 ** [RecoveryPointArn](#API_StartScanJob_RequestSyntax) **   <a name="Backup-StartScanJob-request-RecoveryPointArn"></a>
復旧ポイントを一意に識別する Amazon リソースネーム (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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/StartScanJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/StartScanJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/StartScanJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/StartScanJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/StartScanJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/StartScanJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/StartScanJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/StartScanJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/StartScanJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/StartScanJob) 

# StopBackupJob
<a name="API_StopBackupJob"></a>

ジョブをキャンセルして、リソースの 1 回限りのバックアップを作成しようとします。

このアクションは、以下のサービスではサポートされていません。
+ Amazon Aurora
+ Amazon DocumentDB (MongoDB 互換性)
+ Amazon FSx for Lustre
+ Amazon FSx for NetApp ONTAP
+ Amazon FSx for OpenZFS
+ Amazon FSx for Windows File Server
+ Amazon Neptune
+ Amazon EC2 インスタンスでの SAP HANA データベース
+ Amazon RDS

## リクエストの構文
<a name="API_StopBackupJob_RequestSyntax"></a>

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

## URI リクエストパラメータ
<a name="API_StopBackupJob_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [backupJobId](#API_StopBackupJob_RequestSyntax) **   <a name="Backup-StopBackupJob-request-uri-BackupJobId"></a>
リソースをバックアップ AWS Backup するための へのリクエストを一意に識別します。  
必須: はい

## リクエストボディ
<a name="API_StopBackupJob_RequestBody"></a>

リクエストにリクエスト本文がありません。

## レスポンスの構文
<a name="API_StopBackupJob_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## レスポンス要素
<a name="API_StopBackupJob_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

## エラー
<a name="API_StopBackupJob_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** InvalidRequestException **   
リクエストへの入力に何らかの問題が発生していることを示します。たとえば、パラメータのタイプが間違っています。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_StopBackupJob_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/StopBackupJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/StopBackupJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/StopBackupJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/StopBackupJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/StopBackupJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/StopBackupJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/StopBackupJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/StopBackupJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/StopBackupJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/StopBackupJob) 

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

キーと値のペアのセットをリソースに割り当てます。

## リクエストの構文
<a name="API_TagResource_RequestSyntax"></a>

```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json

{
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI リクエストパラメータ
<a name="API_TagResource_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [resourceArn](#API_TagResource_RequestSyntax) **   <a name="Backup-TagResource-request-uri-ResourceArn"></a>
リソースを一意に識別するための ARN。  
必須: はい

## リクエストボディ
<a name="API_TagResource_RequestBody"></a>

リクエストは以下の JSON 形式のデータを受け入れます。

 ** [Tags](#API_TagResource_RequestSyntax) **   <a name="Backup-TagResource-request-Tags"></a>
リソースの整理に役立つキーと値のペア。作成したリソースに独自のメタデータを割り当てることができます。わかりやすくするために、`[{"Key":"string","Value":"string"}]` のタグを割り当てる構造は次のとおりです。  
タイプ: 文字列間のマッピング  
必須: はい

## レスポンスの構文
<a name="API_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## レスポンス要素
<a name="API_TagResource_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

## エラー
<a name="API_TagResource_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** LimitExceededException **   
たとえば、リクエストで許可されるアイテムの最大数などのリクエストの制限を超えました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_TagResource_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/TagResource) 

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

Amazon リソースネーム (ARN) で識別されるリカバリポイント、バックアッププラン、またはバックアップボールトから、キーと値のペアのセットを削除します。

この API は、Aurora、Amazon DocumentDB などのリソースタイプの復旧ポイントではサポートされていません。Amazon EBS、Amazon FSx、Neptune、および Amazon RDS。

## リクエストの構文
<a name="API_UntagResource_RequestSyntax"></a>

```
POST /untag/resourceArn HTTP/1.1
Content-type: application/json

{
   "TagKeyList": [ "string" ]
}
```

## URI リクエストパラメータ
<a name="API_UntagResource_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [resourceArn](#API_UntagResource_RequestSyntax) **   <a name="Backup-UntagResource-request-uri-ResourceArn"></a>
リソースを一意に識別する ARN。ARN の形式は、タグ付きリソースのタイプによって異なります。  
`backup` を含まない ARN はタグ付けと互換性がありません。無効な ARN を持つ `TagResource` と `UntagResource` を使用するとエラーが発生します。許容される ARN コンテンツには、`arn:aws:backup:us-east` を含めることができます。無効な ARN コンテンツの例として `arn:aws:ec2:us-east` があります。  
必須: はい

## リクエストボディ
<a name="API_UntagResource_RequestBody"></a>

リクエストは以下の JSON 形式のデータを受け入れます。

 ** [TagKeyList](#API_UntagResource_RequestSyntax) **   <a name="Backup-UntagResource-request-TagKeyList"></a>
リソースから削除するキーと値のタグを識別するためのキー。  
型: 文字列の配列  
必須: はい

## レスポンスの構文
<a name="API_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## レスポンス要素
<a name="API_UntagResource_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

## エラー
<a name="API_UntagResource_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_UntagResource_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UntagResource) 
+  [AWS SDK for Ruby V3](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>
バックアッププランの本文。1 つの `BackupPlanName` と1 つ以上の `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>
たとえば、`arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50`などのバックアップ計画を一意に識別する Amazon リソースネーム (ARN) です。  
タイプ: 文字列

 ** [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>
バックアッププランのスキャン設定が含まれ、Malware スキャナー、選択したリソース、スキャナーロールが含まれます。  
型: [ScanSetting](API_ScanSetting.md) オブジェクトの配列

 ** [VersionId](#API_UpdateBackupPlan_ResponseSyntax) **   <a name="Backup-UpdateBackupPlan-response-VersionId"></a>
一意のランダムに生成された UTF-8 エンコード Unicode 文字列 (最大 1,024 バイト長)。バージョン ID を編集することはできません。  
タイプ: 文字列

## エラー
<a name="API_UpdateBackupPlan_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_UpdateBackupPlan_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS SDK for Ruby V3](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>
フレームワークの一意の名前。この名前は、文字で始まり、文字 (a\$1z、A\$1Z)、数字 (0\$19)、およびアンダースコア (\$1) を含む 1 から 256 文字で構成されます。  
長さの制約: 最小長は 1 です。最大長は 256 です。  
パターン: `[a-zA-Z][_a-zA-Z0-9]*`   
必須: はい

## リクエストボディ
<a name="API_UpdateFramework_RequestBody"></a>

リクエストは以下の JSON 形式のデータを受け入れます。

 ** [FrameworkControls](#API_UpdateFramework_RequestSyntax) **   <a name="Backup-UpdateFramework-request-FrameworkControls"></a>
フレームワークを構成するコントロール。リスト内の各コントロールには、名前、入力パラメータ、およびスコープがあります。  
タイプ: [FrameworkControl](API_FrameworkControl.md) オブジェクトの配列  
必須: いいえ

 ** [FrameworkDescription](#API_UpdateFramework_RequestSyntax) **   <a name="Backup-UpdateFramework-request-FrameworkDescription"></a>
最大 1,024 文字のフレームワークの説明 (オプション)。  
タイプ: 文字列  
長さの制約: 最小長は 0 です。最大長は 1,024 です。  
パターン: `.*\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 時 (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>
フレームワークの一意の名前。この名前は、文字で始まり、文字 (a\$1z、A\$1Z)、数字 (0\$19)、およびアンダースコア (\$1) を含む 1 から 256 文字で構成されます。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 256 です。  
パターン: `[a-zA-Z][_a-zA-Z0-9]*` 

## エラー
<a name="API_UpdateFramework_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** AlreadyExistsException **   
必要なリソースは既に存在します。    
 ** Arn **   
  
 ** Context **   
  
 ** CreatorRequestId **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ConflictException **   
 AWS Backup は、前のアクションの実行が完了するまで、リクエストしたアクションを実行できません。後でもう一度お試しください。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** LimitExceededException **   
たとえば、リクエストで許可されるアイテムの最大数などのリクエストの制限を超えました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_UpdateFramework_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UpdateFramework) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateFramework) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateFramework) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateFramework) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateFramework) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateFramework) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateFramework) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateFramework) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateFramework) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UpdateGlobalSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateGlobalSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateGlobalSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateGlobalSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateGlobalSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateGlobalSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateGlobalSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateGlobalSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateGlobalSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/UpdateGlobalSettings) 

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

このオペレーションは、復旧ポイントインデックスの設定を更新します。

必須: BackupVaultName、RecoveryPointArn、IAMRoleArn

## リクエストの構文
<a name="API_UpdateRecoveryPointIndexSettings_RequestSyntax"></a>

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

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

## URI リクエストパラメータ
<a name="API_UpdateRecoveryPointIndexSettings_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [backupVaultName](#API_UpdateRecoveryPointIndexSettings_RequestSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-request-uri-BackupVaultName"></a>
バックアップを保存する論理コンテナの名前。バックアップボールトは、これらのボールトを作成するために使用されたアカウントと作成先の リージョンに一意の名前で識別されます。  
使用できる文字は、小文字の英文字、数字、ハイフンです。  
パターン: `^[a-zA-Z0-9\-\_]{2,50}$`   
必須: はい

 ** [recoveryPointArn](#API_UpdateRecoveryPointIndexSettings_RequestSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-request-uri-RecoveryPointArn"></a>
たとえば、`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`などのリカバリポイントを一意に識別する ARN。  
必須: はい

## リクエストボディ
<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` の 2 つの値のいずれかを指定できます。  
バックアップインデックスがまだ作成されていない、対象となる `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` の 2 つの値のいずれかを指定できます。  
値 `ENABLED` は、対象となる `ACTIVE` 復旧ポイントのバックアップインデックスが作成されたことを意味します。  
値 `DISABLED` は、バックアップインデックスが削除されたことを意味します。  
型: 文字列  
有効な値：`ENABLED | DISABLED`

 ** [IndexStatus](#API_UpdateRecoveryPointIndexSettings_ResponseSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-response-IndexStatus"></a>
これは、指定された復旧ポイントに関連付けられたバックアップインデックスの現在のステータスです。  
ステータス: `PENDING` \$1 `ACTIVE` \$1 `FAILED` \$1 `DELETING`   
ステータスが `ACTIVE` のインデックスを持つ復旧ポイントは、検索に含めることができます。  
型: 文字列  
有効な値：`PENDING | ACTIVE | FAILED | DELETING`

 ** [RecoveryPointArn](#API_UpdateRecoveryPointIndexSettings_ResponseSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-response-RecoveryPointArn"></a>
リカバリーポイントを一意に識別する ARN、たとえば、`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45` です。  
タイプ: 文字列

## エラー
<a name="API_UpdateRecoveryPointIndexSettings_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** InvalidRequestException **   
リクエストへの入力に何らかの問題が発生していることを示します。たとえば、パラメータのタイプが間違っています。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_UpdateRecoveryPointIndexSettings_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 

# UpdateRecoveryPointLifecycle
<a name="API_UpdateRecoveryPointLifecycle"></a>

復旧ポイントの移行ライフサイクルを設定します。

ライフサイクルは、保護されたリソースがコールドストレージに移行するタイミングと期限切れになるタイミングを定義します。 は、定義したライフサイクルに従ってバックアップを自動的に AWS Backup 移行および期限切れにします。

コールドストレージに移行できるリソースタイプは、「[Feature availability by resource](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource) table. AWS Backup ignores this expression for other resource types」に記載されています。

コールドストレージに移行するバックアップは、最低 90 日間コールドストレージに保存する必要があります。したがって、「保持期間」の設定は、「コールドへの移行 (日数)」設定から 90 日以上あける必要があります。バックアップがコールドに移行された後で、「コールドへの移行 (日数)」設定を変更することはできません。

**重要**  
ライフサイクルで現在パラメータ `DeleteAfterDays` と `MoveToColdStorageAfterDays` を使用している場合、このオペレーションを呼び出すときに、これらのパラメータとその値を含めます。これらを含めない場合、プランが null 値で更新される可能性があります。

この操作では、連続バックアップはサポートされません。

## リクエストの構文
<a name="API_UpdateRecoveryPointLifecycle_RequestSyntax"></a>

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

{
   "Lifecycle": { 
      "DeleteAfterDays": number,
      "DeleteAfterEvent": "string",
      "MoveToColdStorageAfterDays": number,
      "OptInToArchiveForSupportedResources": boolean
   }
}
```

## URI リクエストパラメータ
<a name="API_UpdateRecoveryPointLifecycle_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [backupVaultName](#API_UpdateRecoveryPointLifecycle_RequestSyntax) **   <a name="Backup-UpdateRecoveryPointLifecycle-request-uri-BackupVaultName"></a>
バックアップを保存する論理コンテナの名前。バックアップボールトは、これらのボールトを作成するために使用されたアカウントと作成先の AWS リージョンに一意の名前で識別されます。  
パターン: `^[a-zA-Z0-9\-\_]{2,50}$`   
必須: はい

 ** [recoveryPointArn](#API_UpdateRecoveryPointLifecycle_RequestSyntax) **   <a name="Backup-UpdateRecoveryPointLifecycle-request-uri-RecoveryPointArn"></a>
`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`などのリカバリポイントを一意に識別する Amazon リソースネーム (ARN) です。  
必須: はい

## リクエストボディ
<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:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault` などのバックアップボールトを一意に識別する ARN。  
タイプ: 文字列

 ** [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 日以上あける必要があります。バックアップがコールドに移行された後で、「コールドへの移行 (日数)」設定を変更することはできません。  
コールドストレージに移行できるリソースタイプは、「[Feature availability by resource](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource) table. AWS Backup ignores this expression for other resource types」に記載されています。  
型: [Lifecycle](API_Lifecycle.md) オブジェクト

 ** [RecoveryPointArn](#API_UpdateRecoveryPointLifecycle_ResponseSyntax) **   <a name="Backup-UpdateRecoveryPointLifecycle-response-RecoveryPointArn"></a>
`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`などのリカバリポイントを一意に識別する Amazon リソースネーム (ARN) です。  
タイプ: 文字列

## エラー
<a name="API_UpdateRecoveryPointLifecycle_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** InvalidRequestException **   
リクエストへの入力に何らかの問題が発生していることを示します。たとえば、パラメータのタイプが間違っています。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
アクションに必要なリソースは存在しません。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_UpdateRecoveryPointLifecycle_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/UpdateRecoveryPointLifecycle) 

# UpdateRegionSettings
<a name="API_UpdateRegionSettings"></a>

リージョンの現在のサービスオプトイン設定を更新します。

`DescribeRegionSettings` API を使用してサポートされているリソースタイプを決定します。

## リクエストの構文
<a name="API_UpdateRegionSettings_RequestSyntax"></a>

```
PUT /account-settings HTTP/1.1
Content-type: application/json

{
   "ResourceTypeManagementPreference": { 
      "string" : boolean 
   },
   "ResourceTypeOptInPreference": { 
      "string" : boolean 
   }
}
```

## URI リクエストパラメータ
<a name="API_UpdateRegionSettings_RequestParameters"></a>

リクエストでは URI パラメータを使用しません。

## リクエストボディ
<a name="API_UpdateRegionSettings_RequestBody"></a>

リクエストは以下の JSON 形式のデータを受け入れます。

 ** [ResourceTypeManagementPreference](#API_UpdateRegionSettings_RequestSyntax) **   <a name="Backup-UpdateRegionSettings-request-ResourceTypeManagementPreference"></a>
リソースタイプのバックアップの完全な AWS Backup 管理を有効または無効にします。DynamoDB の完全な AWS Backup 管理と [AWS Backupの高度な DynamoDB バックアップ機能](https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html)を有効にするには、手順に従って[高度な DynamoDB バックアップをプログラムで有効に](https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html#advanced-ddb-backup-enable-cli)します。  
タイプ:ブールマップへの文字列。  
キーパターン: `^[a-zA-Z0-9\-\_\.]{1,50}$`   
必須: いいえ

 ** [ResourceTypeOptInPreference](#API_UpdateRegionSettings_RequestSyntax) **   <a name="Backup-UpdateRegionSettings-request-ResourceTypeOptInPreference"></a>
リージョンのオプトイン設定とともに、サービスのリストを更新します。  
リソースの割り当てがタグのみに基づいている場合は、サービスオプトイン設定が適用されます。リソースタイプが、Amazon S3、Amazon EC2、Amazon RDS などのバックアッププランに明示的に割り当てられている場合は、その特定のサービスでオプトインが有効になっていなくてもバックアップに含まれます。リソース割り当てでリソースタイプとタグの両方が指定されている場合、バックアッププランで指定されたリソースタイプがタグ条件よりも優先されます。この場合、サービスオプトイン設定は無視されます。  
タイプ:ブールマップへの文字列。  
キーパターン: `^[a-zA-Z0-9\-\_\.]{1,50}$`   
必須: いいえ

## レスポンスの構文
<a name="API_UpdateRegionSettings_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## レスポンス要素
<a name="API_UpdateRegionSettings_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

## エラー
<a name="API_UpdateRegionSettings_Errors"></a>

すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。

 ** InvalidParameterValueException **   
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** MissingParameterValueException **   
必須パラメータがないことを示します。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 400

 ** ServiceUnavailableException **   
サーバーの一時的障害のため、リクエストは失敗しました。    
 ** Context **   
  
 ** Type **   

HTTP ステータスコード: 500

## その他の参照資料
<a name="API_UpdateRegionSettings_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS SDK for Ruby V3](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>
レポートプランの一意の名前。この名前は、文字で始まり、文字 (a\$1z、A\$1Z)、数字 (0\$19)、およびアンダースコア (\$1) を含む 1 から 256 文字で構成されます。  
長さの制約: 最小長は 1 です。最大長は 256 です。  
パターン: `[a-zA-Z][_a-zA-Z0-9]*`   
必須: はい

## リクエストボディ
<a name="API_UpdateReportPlan_RequestBody"></a>

リクエストは以下の JSON 形式のデータを受け入れます。

 ** [IdempotencyToken](#API_UpdateReportPlan_RequestSyntax) **   <a name="Backup-UpdateReportPlan-request-IdempotencyToken"></a>
別の `UpdateReportPlanInput` への同じコール間を区別するために使用できる顧客が選択した文字列。同じ冪等性トークンで成功したリクエストを再試行すると、アクションは実行されず、成功メッセージが表示されます。  
タイプ: 文字列  
必須: いいえ

 ** [ReportDeliveryChannel](#API_UpdateReportPlan_RequestSyntax) **   <a name="Backup-UpdateReportPlan-request-ReportDeliveryChannel"></a>
レポートを配信する場所に関する情報。具体的には、Amazon S3バケット名、S3 キーのプレフィックス、レポートの形式です。  
型: [ReportDeliveryChannel](API_ReportDeliveryChannel.md) オブジェクト  
必須: いいえ

 ** [ReportPlanDescription](#API_UpdateReportPlan_RequestSyntax) **   <a name="Backup-UpdateReportPlan-request-ReportPlanDescription"></a>
最大 1,024 文字のレポートプランの説明（オプション）。  
タイプ: 文字列  
長さの制約: 最小長は 0 です。最大長は 1,024 です。  
パターン: `.*\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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UpdateReportPlan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateReportPlan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateReportPlan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateReportPlan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateReportPlan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateReportPlan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateReportPlan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateReportPlan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateReportPlan) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/UpdateRestoreTestingPlan) 

# UpdateRestoreTestingSelection
<a name="API_UpdateRestoreTestingSelection"></a>

指定された復元テストの選択を更新します。

このリクエストで `RestoreTestingSelectionName` を除くほとんどの要素を更新できます。

保護対象リソースの ARN または条件を使用できますが、両方を使用することはできません。

## リクエストの構文
<a name="API_UpdateRestoreTestingSelection_RequestSyntax"></a>

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

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

## URI リクエストパラメータ
<a name="API_UpdateRestoreTestingSelection_RequestParameters"></a>

リクエストでは、次の URI パラメータを使用します。

 ** [RestoreTestingPlanName](#API_UpdateRestoreTestingSelection_RequestSyntax) **   <a name="Backup-UpdateRestoreTestingSelection-request-uri-RestoreTestingPlanName"></a>
指定された復元テストプランを更新するには、テストプラン名が必要です。  
必須: はい

 ** [RestoreTestingSelectionName](#API_UpdateRestoreTestingSelection_RequestSyntax) **   <a name="Backup-UpdateRestoreTestingSelection-request-uri-RestoreTestingSelectionName"></a>
更新する復元テスト選択の復元テスト選択名 (必須)。  
必須: はい

## リクエストボディ
<a name="API_UpdateRestoreTestingSelection_RequestBody"></a>

リクエストは以下の JSON 形式のデータを受け入れます。

 ** [RestoreTestingSelection](#API_UpdateRestoreTestingSelection_RequestSyntax) **   <a name="Backup-UpdateRestoreTestingSelection-request-RestoreTestingSelection"></a>
復元テスト選択を更新するには、保護対象リソースの ARN または条件を使用できますが、両方を使用することはできません。つまり、選択に `ProtectedResourceArns` が含まれる場合、`ProtectedResourceConditions` のパラメータを使用して更新をリクエストしても失敗します。  
型: [RestoreTestingSelectionForUpdate](API_RestoreTestingSelectionForUpdate.md) オブジェクト  
必須: はい

## レスポンスの構文
<a name="API_UpdateRestoreTestingSelection_ResponseSyntax"></a>

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

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

## レスポンス要素
<a name="API_UpdateRestoreTestingSelection_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [CreationTime](#API_UpdateRestoreTestingSelection_ResponseSyntax) **   <a name="Backup-UpdateRestoreTestingSelection-response-CreationTime"></a>
リソースのテスト選択が正常に更新された時間。  
タイプ: タイムスタンプ

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

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UpdateRestoreTestingSelection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateRestoreTestingSelection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateRestoreTestingSelection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateRestoreTestingSelection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateRestoreTestingSelection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateRestoreTestingSelection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateRestoreTestingSelection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateRestoreTestingSelection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateRestoreTestingSelection) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UpdateTieringConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateTieringConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateTieringConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateTieringConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateTieringConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateTieringConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateTieringConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateTieringConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateTieringConfiguration) 
+  [AWS SDK for Ruby V3](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>

バックアップゲートウェイをサーバに関連付けます。関連付けプロセスの完了後、ゲートウェイ経由で VM をバックアップおよび復元できます。

## リクエストの構文
<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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/GetGateway) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/GetGateway) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GetGateway) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/GetGateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GetGateway) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/GetGateway) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/GetGateway) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/GetGateway) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/GetGateway) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS SDK for Ruby V3](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 です。最大長は 2,048 です。  
パターン: `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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS SDK for Ruby V3](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 です。最大長は 1,000 です。  
パターン: `.+`   
必須: いいえ

## レスポンスの構文
<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 です。最大長は 1,000 です。  
パターン: `.+` 

## エラー
<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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/ListGateways) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/ListGateways) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/ListGateways) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/ListGateways) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/ListGateways) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/ListGateways) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/ListGateways) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/ListGateways) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/ListGateways) 
+  [AWS SDK for Ruby V3](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 です。最大長は 1,000 です。  
パターン: `.+`   
必須: いいえ

## レスポンスの構文
<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 リソースネーム (ARN) の順序が付けられたオブジェクト。  
型: [Hypervisor](API_BGW_Hypervisor.md) オブジェクトの配列

 ** [NextToken](#API_BGW_ListHypervisors_ResponseSyntax) **   <a name="Backup-BGW_ListHypervisors-response-NextToken"></a>
返されるリソースの部分的リストに続く次の項目です。例えば、`maxResults` の数のリソースを返すようにリクエストが行われた場合、`NextToken` を使用すると、このトークンが指す場所から開始してさらにリストの項目を返すことができます。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 1,000 です。  
パターン: `.+` 

## エラー
<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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS SDK for Ruby V3](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 です。最大長は 1,000 です。  
パターン: `.+`   
必須: いいえ

## レスポンスの構文
<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 です。最大長は 1,000 です。  
パターン: `.+` 

 ** [VirtualMachines](#API_BGW_ListVirtualMachines_ResponseSyntax) **   <a name="Backup-BGW_ListVirtualMachines-response-VirtualMachines"></a>
あなたのリスト`VirtualMachine` Amazon リソースネーム (ARN) の順序が付けられたオブジェクト。  
型: [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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS SDK for Ruby V3](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 です。最大長は 2,048 です。  
パターン: `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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/TagResource) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/UntagResource) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS SDK for Ruby V3](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 です。最大長は 2,048 です。  
パターン: `$|^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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS SDK for Ruby V3](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>
Item Filters は、検索の作成時に指定されたすべての入力項目プロパティを表します。  
型: [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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backupsearch-2018-05-10/GetSearchJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/GetSearchJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/GetSearchJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/GetSearchJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/GetSearchJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/GetSearchJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/GetSearchJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/GetSearchJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/GetSearchJob) 
+  [AWS SDK for Ruby V3](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) オブジェクト  
 **注: **このオブジェクトは共用体です。このオブジェクトのメンバーは 1 つだけ指定または取得できます。

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

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backupsearch-2018-05-10/GetSearchResultExportJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/GetSearchResultExportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/GetSearchResultExportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/GetSearchResultExportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/GetSearchResultExportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/GetSearchResultExportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/GetSearchResultExportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/GetSearchResultExportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/GetSearchResultExportJob) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backupsearch-2018-05-10/ListSearchJobBackups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/ListSearchJobBackups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/ListSearchJobBackups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/ListSearchJobBackups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/ListSearchJobBackups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/ListSearchJobBackups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/ListSearchJobBackups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/ListSearchJobBackups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/ListSearchJobBackups) 
+  [AWS SDK for Ruby V3](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>
結果は EBSResultItem または S3ResultItem のいずれかで構成されます。  
型: [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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backupsearch-2018-05-10/ListSearchJobResults) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/ListSearchJobResults) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/ListSearchJobResults) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/ListSearchJobResults) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/ListSearchJobResults) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/ListSearchJobResults) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/ListSearchJobResults) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/ListSearchJobResults) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/ListSearchJobResults) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backupsearch-2018-05-10/ListSearchJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/ListSearchJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/ListSearchJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/ListSearchJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/ListSearchJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/ListSearchJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/ListSearchJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/ListSearchJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/ListSearchJobs) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backupsearch-2018-05-10/ListSearchResultExportJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/ListSearchResultExportJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/ListSearchResultExportJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/ListSearchResultExportJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/ListSearchResultExportJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/ListSearchResultExportJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/ListSearchResultExportJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/ListSearchResultExportJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/ListSearchResultExportJobs) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backupsearch-2018-05-10/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/ListTagsForResource) 

# StartSearchJob
<a name="API_BKS_StartSearchJob"></a>

このオペレーションは、SearchScope でフィルタリングされた復旧ポイントと ItemFilters でフィルタリングされた項目を返す検索ジョブを作成します。

オプションで、ClientToken、EncryptionKeyArn、Name、Tags を含めることができます。

## リクエストの構文
<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 時間有効です。この時間が経過すると、同じトークンを持つリクエストは新しいリクエストとして処理されます。  
タイプ: 文字列  
必須: いいえ

 ** [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>
Item Filters は、検索の作成時に指定されたすべての入力項目プロパティを表します。  
EBSItemFilters または S3ItemFilters のいずれかを含みます  
型: [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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backupsearch-2018-05-10/StartSearchJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/StartSearchJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/StartSearchJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/StartSearchJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/StartSearchJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/StartSearchJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/StartSearchJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/StartSearchJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/StartSearchJob) 
+  [AWS SDK for Ruby V3](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 時間有効です。この時間が経過すると、同じトークンを持つリクエストは新しいリクエストとして処理されます。  
タイプ: 文字列  
必須: いいえ

 ** [ExportSpecification](#API_BKS_StartSearchResultExportJob_RequestSyntax) **   <a name="Backup-BKS_StartSearchResultExportJob-request-ExportSpecification"></a>
この仕様には、送信先バケットの必須文字列が含まれています。オプションで、送信先プレフィックスを含めることができます。  
型: [ExportSpecification](API_BKS_ExportSpecification.md) オブジェクト  
 **注: **このオブジェクトは共用体です。このオブジェクトのメンバーは 1 つだけ指定または取得できます。  
必須: はい

 ** [RoleArn](#API_BKS_StartSearchResultExportJob_RequestSyntax) **   <a name="Backup-BKS_StartSearchResultExportJob-request-RoleArn"></a>
このパラメータは、検索結果のエクスポートジョブを開始するために使用されるロールの ARN を指定します。  
タイプ: 文字列  
長さの制限: 最小長は 20 です。最大長は 2,048 です。  
パターン: `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>
これは、新しいエクスポートジョブに属する一意の ARN (Amazon リソースネーム) です。  
タイプ: 文字列

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

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backupsearch-2018-05-10/StartSearchResultExportJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/StartSearchResultExportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/StartSearchResultExportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/StartSearchResultExportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/StartSearchResultExportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/StartSearchResultExportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/StartSearchResultExportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/StartSearchResultExportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/StartSearchResultExportJob) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backupsearch-2018-05-10/StopSearchJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/StopSearchJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/StopSearchJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/StopSearchJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/StopSearchJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/StopSearchJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/StopSearchJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/StopSearchJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/StopSearchJob) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backupsearch-2018-05-10/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/TagResource) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backupsearch-2018-05-10/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/UntagResource) 
+  [AWS SDK for Ruby V3](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"` に設定して ACL をバックアップから除外するか、`"BackupObjectTags":"disabled"` に設定してオブジェクトタグをバックアップから除外します。デフォルトでは、ACL とオブジェクトタグの両方が S3 バックアップに含まれます。  
無効なオプションを指定すると、`InvalidParameterValueException` の例外が発生します。  
Windows VSS バックアップの詳細については、[VSS 対応の Windows Backup の作成](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 Volume Shadow Copy Service (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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/AdvancedBackupSetting) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/AdvancedBackupSetting) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/AggregatedScanResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/AggregatedScanResult) 
+  [AWS SDK for Ruby V3](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 に渡されます。これは、この表示される値が実際のバックアップサイズを過小表示する可能性があることを意味します。
タイプ: Long  
必須: いいえ

 ** BackupType **   <a name="Backup-Type-BackupJob-BackupType"></a>
バックアップジョブのバックアップのタイプを表します。  
タイプ: 文字列  
必須: いいえ

 ** BackupVaultArn **   <a name="Backup-Type-BackupJob-BackupVaultArn"></a>
`arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`などのバックアップボールトを一意に識別する Amazon リソースネーム (ARN)。  
タイプ: 文字列  
必須: いいえ

 ** BackupVaultName **   <a name="Backup-Type-BackupJob-BackupVaultName"></a>
バックアップを保存する論理コンテナの名前。バックアップボールトは、これらのボールトを作成するために使用されたアカウントと作成先の AWS リージョンに一意の名前で識別されます。  
タイプ: 文字列  
パターン: `^[a-zA-Z0-9\-\_]{2,50}$`   
必須: いいえ

 ** BytesTransferred **   <a name="Backup-Type-BackupJob-BytesTransferred"></a>
ジョブステータスの照会時にバックアップボールトに転送されたバイト単位のサイズ。  
タイプ: Long  
必須: いいえ

 ** 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 日長くする必要があります。バックアップがコールドに移行された後で、コールドへの移行 (日数) の設定を変更することはできません。  
コールドストレージに移行できるリソースタイプは、「[Feature availability by resource](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource) table. AWS Backup ignores this expression for other resource types」に記載されています。  
既存のライフサイクルと保持期間を削除し、復旧ポイントを無期限に保持するには、`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 Elastic Block Store (Amazon EBS) ボリュームや Amazon Relational Database Service (Amazon RDS) データベースなど。Windows Volume Shadow Copy Service (VSS) バックアップでは、サポートされているリソースタイプは Amazon EC2 のみです。  
タイプ: 文字列  
パターン: `^[a-zA-Z0-9\-\_\.]{1,50}$`   
必須: いいえ

 ** StartBy **   <a name="Backup-Type-BackupJob-StartBy"></a>
バックアップジョブがキャンセルされる前に開始しなければならない時刻を Unix 形式および協定世界時 (UTC)) で指定します。この値は、スケジュールされた時刻に開始ウィンドウを追加して計算されます。そのため、予定時刻が午後6時でスタートウィンドウが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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/BackupJob) 

# BackupJobSummary
<a name="API_BackupJobSummary"></a>

過去 30 日以内に作成または実行されたジョブの概要です。

返される概要には、該当するジョブの Region、Account、State、ResourceType、MessageCategory、StartTime、EndTime、および Count が含まれる場合があります。

## 内容
<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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupJobSummary) 
+  [AWS SDK for Ruby V3](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>
バックアッププランのスキャン設定が含まれ、Malware スキャナー、選択したリソース、スキャナーロールが含まれます。  
タイプ: [ScanSetting](API_ScanSetting.md) オブジェクトの配列  
必須：いいえ

## 以下の資料も参照してください。
<a name="API_BackupPlan_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupPlan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupPlan) 
+  [AWS SDK for Ruby V3](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 Volume Shadow Copy Service (VSS) バックアップジョブでのみで有効です。  
タイプ: [AdvancedBackupSetting](API_AdvancedBackupSetting.md) オブジェクトの配列  
必須: いいえ

 ** ScanSettings **   <a name="Backup-Type-BackupPlanInput-ScanSettings"></a>
バックアップルールのスキャン設定が含まれ、マルウェアスキャナー、フルスキャンモードまたは増分スキャンモードが含まれます。  
タイプ: [ScanSetting](API_ScanSetting.md) オブジェクトの配列  
必須：いいえ

## 以下の資料も参照してください。
<a name="API_BackupPlanInput_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupPlanInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupPlanInput) 
+  [AWS SDK for Ruby V3](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>
例えば、`arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50` などのバックアップ計画を一意に識別する Amazon リソースネーム (ARN) です。  
タイプ: 文字列  
必須: いいえ

 ** 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>
リクエストを識別するための一意の文字列で、失敗したリクエストを再試行する際に、オペレーションを2回実行するリスクを回避することができます。このパラメータはオプションです。  
使用する場合、このパラメータには 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>
一意のランダムに生成された UTF-8 エンコード Unicode 文字列 (最大 1,024 バイト長)。バージョン ID を編集することはできません。  
タイプ: 文字列  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_BackupPlansListMember_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupPlansListMember) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupPlansListMember) 
+  [AWS SDK for Ruby V3](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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupPlanTemplatesListMember) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupPlanTemplatesListMember) 
+  [AWS SDK for Ruby V3](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」 を含める必要があります。。  
タイプ: 文字列  
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`   
必須: はい

 ** TargetBackupVaultName **   <a name="Backup-Type-BackupRule-TargetBackupVaultName"></a>
バックアップを保存する論理コンテナの名前。バックアップボールトは、これらのボールトを作成するために使用されたアカウントと作成先の AWS リージョンに一意の名前で識別されます。  
タイプ: 文字列  
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`   
必須: はい

 ** CompletionWindowMinutes **   <a name="Backup-Type-BackupRule-CompletionWindowMinutes"></a>
バックアップジョブが正常に開始されてから完了するまで、または AWS Backupによってキャンセルされるまでの分単位の値です。この値はオプションです。  
タイプ: Long  
必須: いいえ

 ** CopyActions **   <a name="Backup-Type-BackupRule-CopyActions"></a>
`CopyAction` オブジェクトの配列で、コピーオペレーションの詳細を含みます。  
タイプ: [CopyAction](API_CopyAction.md) オブジェクトの配列  
必須: いいえ

 ** EnableContinuousBackup **   <a name="Backup-Type-BackupRule-EnableContinuousBackup"></a>
が継続的バックアップ AWS Backup を作成するかどうかを指定します。True の場合 AWS Backup 、 point-in-time復元 (PITR) が可能な継続的バックアップを作成します。False (または指定なし) の場合 AWS Backup 、 はスナップショットバックアップを作成します。  
タイプ: ブール値  
必須: いいえ

 ** IndexActions **   <a name="Backup-Type-BackupRule-IndexActions"></a>
IndexActions は、バックアップデータのインデックス作成方法を指定するために使用する配列です。  
各 BackupRule は 0 個または 1 個の IndexAction を持つことができます。各バックアップには最大 1 つのインデックスを関連付けることができるためです。  
配列内には ResourceType があります。BackupRule ごとに受け入れられるのは 1 つだけです。  
タイプ: [IndexAction](API_IndexAction.md) オブジェクトの配列  
必須: いいえ

 ** Lifecycle **   <a name="Backup-Type-BackupRule-Lifecycle"></a>
ライフサイクルは、保護されたリソースがコールドストレージに移行するタイミングと有効期限を定義します。 は、定義したライフサイクルに従ってバックアップを自動的に AWS Backup 移行および期限切れにします。  
コールドストレージに移行するバックアップは、最低 90 日間コールドストレージに保存する必要があります。したがって、「保持期間」の設定は、「コールドへの移行 (日数)」設定から 90 日以上あける必要があります。バックアップがコールドに移行された後で、「コールドへの移行 (日数)」設定を変更することはできません。  
コールドストレージに移行できるリソースタイプは、「[Feature availability by resource](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource) table. AWS Backup ignores this expression for other resource types」に記載されています。  
型: [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>
がバックアップジョブ AWS Backup を開始するタイミングを指定する UTC の cron 式。CRON 式が指定されていない場合、 AWS Backup はデフォルトの式 を使用します`cron(0 5 ? * * *)`。  
 AWS cron 式の詳細については、*Amazon CloudWatch Events ユーザーガイド*[」の「ルールのスケジュール式](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html)」を参照してください。  
cron AWS 式の 2 つの例は、 ` 15 * ? * * *` (1 時間ごとに 15 分後にバックアップを取る) と `0 12 * * ? *` (毎日正午 UTC にバックアップを取る) です。  
例のテーブルについては、前のリンクをクリックし、ページを下にスクロールします。  
タイプ: 文字列  
必須: いいえ

 ** ScheduleExpressionTimezone **   <a name="Backup-Type-BackupRule-ScheduleExpressionTimezone"></a>
スケジュール式が設定されるタイムゾーン。デフォルトでは、ScheduleExpressions は UTC です。これを、指定したタイムゾーンに変更できます。  
タイプ: 文字列  
必須: いいえ

 ** StartWindowMinutes **   <a name="Backup-Type-BackupRule-StartWindowMinutes"></a>
バックアップが予定されてから、ジョブが正常に開始されない場合にキャンセルされるまでの時間を分単位で指定する値です。この値はオプションです。この値を含める場合、エラーを避けるために少なくとも 60 分必要です。  
開始ウィンドウ中、バックアップジョブのステータスは、正常に開始されるか、開始ウィンドウの時間がなくなるまで `CREATED` ステータスのままになります。開始ウィンドウ時間内にジョブの再試行を許可するエラー AWS Backup を受け取った場合、 AWS Backup は、バックアップが正常に開始されるまで (ジョブステータスが に変わる）、またはジョブステータスが に変わるまで `EXPIRED` (開始ウィンドウ時間が終了すると予想される`RUNNING`)、少なくとも 10 分ごとにジョブの開始を自動的に再試行します。  
タイプ: Long  
必須: いいえ

 ** TargetLogicallyAirGappedBackupVaultArn **   <a name="Backup-Type-BackupRule-TargetLogicallyAirGappedBackupVaultArn"></a>
論理エアギャップボールトの ARN。ARN は同じアカウントとリージョンに存在する必要があります。提供されている場合、サポートされているフルマネージドリソースは論理エアギャップボールトに直接バックアップされ、他のサポートされているリソースはバックアップボールトに一時的な (請求可能な) スナップショットを作成し、それを論理エアギャップボールトにコピーします。サポートされていないリソースは、指定されたバックアップボールトにのみバックアップされます。  
タイプ: 文字列  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_BackupRule_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupRule) 
+  [AWS SDK for Ruby V3](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」 を含める必要があります。。  
タイプ: 文字列  
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`   
必須: はい

 ** TargetBackupVaultName **   <a name="Backup-Type-BackupRuleInput-TargetBackupVaultName"></a>
バックアップを保存する論理コンテナの名前。バックアップボールトは、これらのボールトを作成するために使用されたアカウントと作成先の AWS リージョンに一意の名前で識別されます。  
タイプ: 文字列  
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`   
必須: はい

 ** CompletionWindowMinutes **   <a name="Backup-Type-BackupRuleInput-CompletionWindowMinutes"></a>
バックアップジョブが正常に開始されてから完了するまで、または AWS Backupによってキャンセルされるまでの分単位の値です。この値はオプションです。  
タイプ: Long  
必須: いいえ

 ** CopyActions **   <a name="Backup-Type-BackupRuleInput-CopyActions"></a>
`CopyAction` オブジェクトの配列で、コピーオペレーションの詳細を含みます。  
タイプ: [CopyAction](API_CopyAction.md) オブジェクトの配列  
必須: いいえ

 ** EnableContinuousBackup **   <a name="Backup-Type-BackupRuleInput-EnableContinuousBackup"></a>
が継続的バックアップ AWS Backup を作成するかどうかを指定します。True の場合 AWS Backup 、 point-in-time復元 (PITR) が可能な継続的バックアップを作成します。False (または指定なし) の場合 AWS Backup 、 はスナップショットバックアップを作成します。  
タイプ: ブール値  
必須: いいえ

 ** IndexActions **   <a name="Backup-Type-BackupRuleInput-IndexActions"></a>
各バックアップには 0 個または 1 個のバックアップインデックスを関連付けることができるため、各 BackupRule には最大 1 つの IndexAction を設定できます。  
配列内には ResourceTypes があります。BackupRule ごとに受け入れられるリソースタイプは 1 つだけです。有効な値:  
+  Amazon Elastic Block Store 用の `EBS`
+  Amazon Simple Storage Service (Amazon S3) 用の `S3`
タイプ: [IndexAction](API_IndexAction.md) オブジェクトの配列  
必須: いいえ

 ** Lifecycle **   <a name="Backup-Type-BackupRuleInput-Lifecycle"></a>
ライフサイクルは、保護されたリソースがコールドストレージに移行するタイミングと期限切れになるタイミングを定義します。 AWS Backup は、定義したライフサイクルに従ってバックアップを自動的に移行して期限切れにします。  
コールドストレージに移行するバックアップは、最低 90 日間コールドストレージに保存する必要があります。したがって、「保持期間」の設定は、「コールドへの移行 (日数)」設定から 90 日以上あける必要があります。バックアップがコールドストレージに移行された後で、「コールドへの移行 (日数)」設定を変更することはできません。  
コールドストレージに移行できるリソースタイプは、「[Feature availability by resource](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource) table. AWS Backup ignores this expression for other resource types」に記載されています。  
このパラメータの最大値は 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>
がバックアップジョブ AWS Backup を開始するタイミングを指定する UTC の CRON 式。CRON 式が指定されていない場合、 AWS Backup はデフォルトの式 を使用します`cron(0 5 ? * * *)`。  
タイプ: 文字列  
必須: いいえ

 ** ScheduleExpressionTimezone **   <a name="Backup-Type-BackupRuleInput-ScheduleExpressionTimezone"></a>
スケジュール式が設定されるタイムゾーン。デフォルトでは、ScheduleExpressions は UTC です。これを、指定したタイムゾーンに変更できます。  
タイプ: 文字列  
必須: いいえ

 ** StartWindowMinutes **   <a name="Backup-Type-BackupRuleInput-StartWindowMinutes"></a>
バックアップが予定されてから、ジョブが正常に開始されない場合にキャンセルされるまでの時間を分単位で指定する値です。この値はオプションです。この値を含める場合、エラーを避けるために少なくとも 60 分必要です。  
このパラメータの最大値は 100 年 (52,560,000 分) です。  
開始ウィンドウ中、バックアップジョブのステータスは、正常に開始されるか、開始ウィンドウの時間がなくなるまで `CREATED` ステータスのままになります。開始ウィンドウ時間内にジョブの再試行を許可するエラー AWS Backup を受け取った場合、 AWS Backup は、バックアップが正常に開始されるまで (ジョブステータスが に変わる）、またはジョブステータスが に変わるまで `EXPIRED` (開始ウィンドウ時間が終了すると予想される`RUNNING`)、少なくとも 10 分ごとにジョブの開始を自動的に再試行します。  
タイプ: Long  
必須: いいえ

 ** TargetLogicallyAirGappedBackupVaultArn **   <a name="Backup-Type-BackupRuleInput-TargetLogicallyAirGappedBackupVaultArn"></a>
論理エアギャップボールトの ARN。ARN は同じアカウントとリージョンに存在する必要があります。提供されている場合、サポートされているフルマネージドリソースは論理エアギャップボールトに直接バックアップされ、他のサポートされているリソースはバックアップボールトに一時的な (請求可能な) スナップショットを作成し、それを論理エアギャップボールトにコピーします。サポートされていないリソースは、指定されたバックアップボールトにのみバックアップされます。  
タイプ: 文字列  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_BackupRuleInput_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupRuleInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupRuleInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/BackupRuleInput) 

# BackupSelection
<a name="API_BackupSelection"></a>

バックアップ計画にリソースのセットを指定するために使用します。

含めるか除外する条件、タグ、またはリソースを指定することをお勧めします。それ以外の場合、バックアップは、サポート対象のすべてのストレージリソースおよびオプトインされているすべてのストレージリソースを選択しようとしますが、これにより、意図しないコスト上の影響が生じる可能性があります。

詳細については、「[プログラムによるリソースの割り当て](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」 を含める必要があります。。  
タイプ: 文字列  
Pattern: `^[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 リソースネーム (ARN)。ARN の最大数は、ワイルドカードを使用しない場合は 500、またはワイルドカードを使用する場合は 30 の ARN です。  
バックアップ計画から多くのリソースを除外する必要がある場合は、1 つまたは少数のリソースタイプのみを割り当てるか、タグを使用してリソース選択を調整するなど、異なるリソース選択戦略を検討してください。  
型: 文字列の配列  
必須: いいえ

 ** Resources **   <a name="Backup-Type-BackupSelection-Resources"></a>
バックアッププランに割り当てるリソースの Amazon リソースネーム (ARN)。ARN の最大数は、ワイルドカードを使用しない場合は 500、またはワイルドカードを使用する場合は 30 ARNです。  
バックアッププランに多数のリソースを割り当てる必要がある場合は、リソースタイプのすべてのリソースを割り当てるか、タグを使用してリソース選択を調整するなど、異なるリソース選択戦略を検討してください。  
複数の ARN を指定すると、リソースはいずれかの ARN (OR ロジック) に一致します。  
バックアップ選択に ARN パターンでワイルドカードを使用する場合は、ARN 文字列の末尾にアスタリスク (\$1) (プレフィックスパターン) が表示される必要があります。たとえば、 `arn:aws:s3:::my-bucket-*`は有効ですが、`arn:aws:s3:::*-logs`サポートされていません。
型: 文字列の配列  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_BackupSelection_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupSelection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupSelection) 
+  [AWS SDK for Ruby V3](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>
リクエストを識別するための一意の文字列で、失敗したリクエストを再試行する際に、オペレーションを2回実行するリスクを回避することができます。このパラメータはオプションです。  
使用する場合、このパラメータには 1～50 文字の英数字または「-\$1」を含める必要があります 。  
タイプ: 文字列  
必須: いいえ

 ** IamRoleArn **   <a name="Backup-Type-BackupSelectionsListMember-IamRoleArn"></a>
ターゲットリカバリーポイントを作成する IAM ロール Amazon Resource Name (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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupSelectionsListMember) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupSelectionsListMember) 
+  [AWS SDK for Ruby V3](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>
`arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`などのバックアップボールトを一意に識別する Amazon リソースネーム (ARN)。  
タイプ: 文字列  
必須: いいえ

 ** 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>
リクエストを識別するための一意の文字列で、失敗したリクエストを再試行する際に、オペレーションを2回実行するリスクを回避することができます。このパラメータはオプションです。  
使用する場合、このパラメータには 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、[「 でのバックアップの暗号化 AWS Backup](https://docs.aws.amazon.com/aws-backup/latest/devguide/encryption.html)」を参照してください。  
タイプ: 文字列  
必須: いいえ

 ** EncryptionKeyType **   <a name="Backup-Type-BackupVaultListMember-EncryptionKeyType"></a>
バックアップボールトに使用される暗号化キーのタイプ。有効な値は、カスタマーマネージドキーの場合は CUSTOMER\$1MANAGED\$1KMS\$1KEY、所有キーの場合は AWS\$1OWNED\$1KMS\$1KEY 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 ボールトが復旧ポイントを保持する最大保持期間を指定するボールトロック設定。このパラメータを指定しない場合、Vault Lock はボールト内のリカバリポイントに最大保持期間を強制しません (無期限ストレージを許可)。  
指定した場合、ボールトへのバックアップジョブもしくはコピージョブには、保存期間が最大保存期間と同等もしくは以下のライフサイクル・ポリシーを持つ必要があります。ジョブの保持期間がその最大保存期間よりも長い場合、ボールトはバックアップジョブもしくはコピージョブに失敗するため、ライフサイクル設定を変更するか、別のボールトを使用する必要があります。ボールトロックの前にボールトにすでに格納されているリカバリポイントは影響を受けません。  
タイプ: Long  
必須: いいえ

 ** MinRetentionDays **   <a name="Backup-Type-BackupVaultListMember-MinRetentionDays"></a>
 AWS Backup ボールトが復旧ポイントを保持する最小保持期間を指定するボールトロック設定。このパラメータを指定しない場合、ボールトロックは最小保持期間を強制しません。  
指定した場合、ボールトへのバックアップジョブまたはコピージョブには、最小保存期間以上の保存期間を持つライフサイクルポリシーが必要です。ジョブの保持期間がその最小保存期間より短い場合、ボールトはバックアップジョブまたはコピージョブに失敗するため、ライフサイクル設定を変更するか、別のボールトを使用する必要があります。ボールトロックの前にボールトにすでに格納されているリカバリポイントは影響を受けません。  
タイプ: Long  
必須: いいえ

 ** NumberOfRecoveryPoints **   <a name="Backup-Type-BackupVaultListMember-NumberOfRecoveryPoints"></a>
バックアップボールトに保存されているリカバリーポイントの数です。コンソールに表示される復旧ポイント数の値は、概算値である場合があります。  
タイプ: Long  
必須: いいえ

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

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupVaultListMember) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupVaultListMember) 
+  [AWS SDK for Ruby V3](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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CalculatedLifecycle) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CalculatedLifecycle) 
+  [AWS SDK for Ruby V3](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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/Condition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/Condition) 
+  [AWS SDK for Ruby V3](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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ConditionParameter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ConditionParameter) 
+  [AWS SDK for Ruby V3](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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/Conditions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/Conditions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/Conditions) 

# ControlInputParameter
<a name="API_ControlInputParameter"></a>

コントロールのパラメータ。コントロールには、0、1、または複数のパラメーターを含めることができます。2 つのパラメーターを持つコントロールの例は、「バックアップ計画の頻度は少なくとも `daily` で、保存期間は、少なくとも `1 year` である」があげられます。最初のパラメータは `daily` です。2番目のパラメータは `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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ControlInputParameter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ControlInputParameter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ControlInputParameter) 

# ControlScope
<a name="API_ControlScope"></a>

フレームワークは、1 つまたは、複数のコントロールで構成されます。各コントロールには独自のコントロールスコープがあります。　 コントロールスコープには、1 つ以上のリソースタイプ、タグキーと値の組み合わせ、または 1 つのリソースタイプと 1 つのリソース ID の組み合わせを含めることができます。スコープが指定されていない場合は、レコーディンググループ内のいずれかのリソースの設定が変更されたときにルールの評価が行われます。

**注記**  
特定のリソースをすべて含むコントロールスコープを設定するには、`ControlScope` を空にするか、`CreateFramework` を呼び出し時にそれを渡さないようにします。

## 内容
<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 リソースに適用されるタグのキーと値のペアです。最大 1 つのキーと値のペアを指定できます。タグ値はオプションですが、コンソールからフレームワークを作成または編集する場合、空の文字列にすることはできません (CloudFormation テンプレートに含める場合は、値を空の文字列にすることができます)。  
タグを割り当てる構造は次のとおりです。`[{"Key":"string","Value":"string"}]` 。  
型: 文字列間のマッピング  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_ControlScope_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ControlScope) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ControlScope) 
+  [AWS SDK for Ruby V3](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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CopyAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CopyAction) 
+  [AWS SDK for Ruby V3](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>
コピージョブのサイズをバイト単位で表します。  
タイプ: Long  
必須: いいえ

 ** ChildJobsInState **   <a name="Backup-Type-CopyJob-ChildJobsInState"></a>
これにより、含まれている子 (ネストされた) コピージョブの統計が返されます。  
タイプ: 文字列を long にマッピング  
有効なキー: `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 Resource Name (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 日長くする必要があります。バックアップがコールドに移行された後で、コールドへの移行 (日数) の設定を変更することはできません。  
コールドストレージに移行できるリソースタイプは、「[Feature availability by resource](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource) table. AWS Backup ignores this expression for other resource types」に記載されています。  
既存のライフサイクルと保持期間を削除し、復旧ポイントを無期限に保持するには、`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>
子 (ネストされた) コピージョブの数。  
タイプ: Long  
必須: いいえ

 ** ParentJobId **   <a name="Backup-Type-CopyJob-ParentJobId"></a>
これは、リソースをコピーするための AWS Backup へのリクエストを一意に識別します。戻り値は親 (複合) ジョブ ID になります。  
タイプ: 文字列  
必須: いいえ

 ** ResourceArn **   <a name="Backup-Type-CopyJob-ResourceArn"></a>
コピーする AWS リソース。Amazon Elastic Block Store (Amazon EBS) ボリュームや Amazon Relational Database Service (Amazon RDS) データベースなど。  
タイプ: 文字列  
必須: いいえ

 ** ResourceName **   <a name="Backup-Type-CopyJob-ResourceName"></a>
指定されたバックアップに属するリソースの一意ではない名前。  
タイプ: 文字列  
必須: いいえ

 ** ResourceType **   <a name="Backup-Type-CopyJob-ResourceType"></a>
コピーする AWS リソースのタイプ。Amazon Elastic Block Store (Amazon EBS) ボリュームや Amazon Relational Database Service (Amazon RDS) データベースなど。  
タイプ: 文字列  
パターン: `^[a-zA-Z0-9\-\_\.]{1,50}$`   
必須: いいえ

 ** SourceBackupVaultArn **   <a name="Backup-Type-CopyJob-SourceBackupVaultArn"></a>
コピー元のボールトを一意に識別するAmazon Resource Name（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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CopyJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CopyJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CopyJob) 

# CopyJobSummary
<a name="API_CopyJobSummary"></a>

過去 30 日以内に作成または実行されたコピージョブの概要です。

返される概要には、該当するジョブの Region、Account、State、ResourceType、MessageCategory、StartTime、EndTime、および Count が含まれる場合があります。

## 内容
<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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CopyJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CopyJobSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CopyJobSummary) 

# DateRange
<a name="API_DateRange"></a>

これは、開始日 (日時) と終了日 (日時) を含むリソースフィルターです。両方の値とも必須です。将来の日時値は使用できません。

日時は、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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DateRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DateRange) 
+  [AWS SDK for Ruby V3](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 時 (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>
最大 1,024 文字のフレームワークの説明 (オプション)。  
タイプ: 文字列  
長さの制約: 最小長は 0 です。最大長は 1,024 です。  
パターン: `.*\S.*`   
必須: いいえ

 ** FrameworkName **   <a name="Backup-Type-Framework-FrameworkName"></a>
フレームワークの一意の名前です。この名前は、文字で始まり、文字 (a\$1z、A\$1Z)、数字 (0\$19)、およびアンダースコア (\$1) を含む 1 から 256 文字で構成されます。  
タイプ: 文字列  
長さの制約: 最小長は 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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/Framework) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/Framework) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/Framework) 

# FrameworkControl
<a name="API_FrameworkControl"></a>

フレームワークのすべてのコントロールに関する詳細情報が含まれています。各フレームワークには、少なくとも 1 つのコントロールを含める必要があります。

## 内容
<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>
コントロールのスコープ。コントロールスコープは、コントロールが評価する内容を定義します。　 コントロールスコープの 3 つの例は、特定のバックアップ計画、特定のタグを持つすべてのバックアップ計画、またはすべてのバックアップ計画です。  
詳細については、「[https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ControlScope.html](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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/FrameworkControl) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/FrameworkControl) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/FrameworkControl) 

# IndexAction
<a name="API_IndexAction"></a>

これは BackupRule 内のオプションの配列です。

IndexAction は 1 つの ResourceTypes で構成されます。

## 内容
<a name="API_IndexAction_Contents"></a>

 ** ResourceTypes **   <a name="Backup-Type-IndexAction-ResourceTypes"></a>
BackupRule ごとに 0 または 1 個のインデックスアクションが受け入れられます。  
有効な値:  
+  `EBS`Amazon Elastic Block Store 用の 
+  Amazon Simple Storage Service (Amazon S3) 用の `S3`
型: 文字列の配列  
パターン: `^[a-zA-Z0-9\-\_\.]{1,50}$`   
必須: いいえ

## 以下の資料も参照してください。
<a name="API_IndexAction_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/IndexAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/IndexAction) 
+  [AWS SDK for Ruby V3](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 用の 
+  Amazon Simple Storage Service (Amazon S3) 用の `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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/IndexedRecoveryPoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/IndexedRecoveryPoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/IndexedRecoveryPoint) 

# KeyValue
<a name="API_KeyValue"></a>

関連する 2 つの文字列のペアです。使用できる文字は、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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/KeyValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/KeyValue) 
+  [AWS SDK for Ruby V3](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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/LatestMpaApprovalTeamUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/LatestMpaApprovalTeamUpdate) 
+  [AWS SDK for Ruby V3](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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/LatestRevokeRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/LatestRevokeRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/LatestRevokeRequest) 

# LegalHold
<a name="API_LegalHold"></a>

リーガルホールドは、ホールド中にバックアップが削除されないようにする管理ツールです。ホールドが実施されている場合は、ホールド状態にあるバックアップは削除できず、バックアップステータスを変更するライフサイクルポリシー (コールドストレージへの移行など) は、リーガルホールドが削除されるまで延期されます。1 つのバックアップについて、リーガルホールドが複数ある場合があります。リーガルホールドは 1 つ以上のバックアップ (復旧ポイントとも呼ばれます) に適用されます。これらのバックアップは、リソースタイプとリソース 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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/LegalHold) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/LegalHold) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/LegalHold) 

# Lifecycle
<a name="API_Lifecycle"></a>

復旧ポイントがコールドストレージに移行するまでの期間、または削除されるまでの期間を日数で指定します。

コールドストレージに移行するバックアップは、最低 90 日間コールドストレージに保存する必要があります。したがって、コンソール上での保持期間の設定は、コールドへの移行 (日数) 設定から 90 日長くする必要があります。バックアップがコールドに移行された後で、コールドへの移行 (日数) の設定を変更することはできません。

コールドストレージに移行できるリソースタイプは、「[Feature availability by resource](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource) table. AWS Backup ignores this expression for other resource types」に記載されています。

既存のライフサイクルと保持期間を削除し、復旧ポイントを無期限に保持するには、`MoveToColdStorageAfterDays` と `DeleteAfterDays` に -1 を指定します。

## 内容
<a name="API_Lifecycle_Contents"></a>

 ** DeleteAfterDays **   <a name="Backup-Type-Lifecycle-DeleteAfterDays"></a>
復旧ポイントが作成されてから削除されるまでの日数。この値は、`MoveToColdStorageAfterDays` で指定された日数から 90 日以上経過している必要があります。  
タイプ: Long  
必須: いいえ

 ** DeleteAfterEvent **   <a name="Backup-Type-Lifecycle-DeleteAfterEvent"></a>
復旧ポイントが削除された後のイベント。`DeleteAfterDays` と の両方を持つ復旧ポイントは`DeleteAfterEvent`、どの条件が最初に満たされた後に削除されます。入力としては無効です。  
型: 文字列  
有効な値：`DELETE_AFTER_COPY`  
必須：いいえ

 ** MoveToColdStorageAfterDays **   <a name="Backup-Type-Lifecycle-MoveToColdStorageAfterDays"></a>
復旧ポイントが作成されてからコールドストレージに移動されるまでの日数。  
タイプ: Long  
必須: いいえ

 ** OptInToArchiveForSupportedResources **   <a name="Backup-Type-Lifecycle-OptInToArchiveForSupportedResources"></a>
この値が true の場合、バックアッププランでは、サポートされているリソースがライフサイクル設定に従ってアーカイブ (コールド) ストレージ階層に移行されます。  
タイプ: ブール値  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_Lifecycle_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/Lifecycle) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/Lifecycle) 
+  [AWS SDK for Ruby V3](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>
たとえば、Amazon Elastic Block Store（Amazon EBS）のボリュームやAmazon Relational Database Service（Amazon RDS）のデータベースなど、AWS リソースのタイプを表します。Windows ボリュームシャドウコピーサービス (VSS) バックアップでは、サポートされているリソースタイプは Amazon EC2 のみです。　  
タイプ: 文字列  
パターン: `^[a-zA-Z0-9\-\_\.]{1,50}$`   
必須: いいえ

## 以下の資料も参照してください。
<a name="API_ProtectedResource_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ProtectedResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ProtectedResource) 
+  [AWS SDK for Ruby V3](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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ProtectedResourceConditions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ProtectedResourceConditions) 
+  [AWS SDK for Ruby V3](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>
バックアップのサイズはバイト単位です。  
タイプ: Long  
必須: いいえ

 ** 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、所有キーの場合は AWS\$1OWNED\$1KMS\$1KEY 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 日以上あける必要があります。バックアップがコールドに移行された後で、「コールドへの移行 (日数)」設定を変更することはできません。  
コールドストレージに移行できるリソースタイプは、「[Feature availability by resource](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource) table. AWS Backup ignores this expression for other resource types」に記載されています。  
型: [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 Elastic Block Store (Amazon EBS) ボリュームや Amazon Relational Database Service (Amazon RDS) データベースなど。Windows Volume Shadow Copy Service (VSS) バックアップでは、サポートされているリソースタイプは Amazon 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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RecoveryPointByBackupVault) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RecoveryPointByBackupVault) 
+  [AWS SDK for Ruby V3](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>
バックアップのサイズはバイト単位です。  
タイプ: Long  
必須: いいえ

 ** 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、所有キーの場合は AWS\$1OWNED\$1KMS\$1KEY 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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RecoveryPointByResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RecoveryPointByResource) 
+  [AWS SDK for Ruby V3](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>
例えば、`arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50` などのバックアップ計画を一意に識別する Amazon リソースネーム (ARN) です。  
タイプ: 文字列  
必須: いいえ

 ** 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でエンコードされた文字列で、最大1,024バイトの長さです。編集することはできません。  
タイプ: 文字列  
必須: いいえ

 ** 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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RecoveryPointCreator) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RecoveryPointCreator) 
+  [AWS SDK for Ruby V3](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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RecoveryPointMember) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RecoveryPointMember) 
+  [AWS SDK for Ruby V3](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>
これは、開始日 (日時) と終了日 (日時) を含むリソースフィルターです。両方の値とも必須です。将来の日時値は使用できません。  
日時は、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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RecoveryPointSelection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RecoveryPointSelection) 
+  [AWS SDK for Ruby V3](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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ReportDeliveryChannel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ReportDeliveryChannel) 
+  [AWS SDK for Ruby V3](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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ReportDestination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ReportDestination) 
+  [AWS SDK for Ruby V3](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でエンコードされた、最大で1,024バイトの長さの文字列です。レポートジョブ 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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ReportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ReportJob) 
+  [AWS SDK for Ruby V3](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>
最大 1,024 文字のレポートプランの説明（オプション）。  
タイプ: 文字列  
長さの制約: 最小長は 0 です。最大長は 1,024 です。  
パターン: `.*\S.*`   
必須: いいえ

 ** ReportPlanName **   <a name="Backup-Type-ReportPlan-ReportPlanName"></a>
レポートプランの一意の名前です。この名前は、アルファベットで始まり、アルファベット(a-z, A-Z)、数字(0-9)、アンダースコア(\$1)で構成される1～256文字です。  
タイプ: 文字列  
長さの制約: 最小長は 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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ReportPlan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ReportPlan) 
+  [AWS SDK for Ruby V3](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 リソースネーム (ARN)。  
型: 文字列の配列  
必須: いいえ

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

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ReportSetting) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ReportSetting) 
+  [AWS SDK for Ruby V3](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 リソースのタイプ。Amazon S3 `S3` の場合など。 Amazon S3 階層設定の場合、これは現在 に制限されています`S3`。  
タイプ: 文字列  
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`   
必須: はい

 ** TieringDownSettingsInDays **   <a name="Backup-Type-ResourceSelection-TieringDownSettingsInDays"></a>
バックアップボールト内で作成されてから、オブジェクトが低コストのウォームストレージ階層に移行できる日数。60 日から 36500 日までの正の整数である必要があります。  
タイプ: 整数  
有効範囲: 最小値 は 60 です。最大値は 36500 です。  
必須: はい

## 以下の資料も参照してください。
<a name="API_ResourceSelection_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ResourceSelection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ResourceSelection) 
+  [AWS SDK for Ruby V3](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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreAccessBackupVaultListMember) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreAccessBackupVaultListMember) 
+  [AWS SDK for Ruby V3](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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreJobCreator) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreJobCreator) 
+  [AWS SDK for Ruby V3](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>
復元されたリソースのサイズは、バイト単位で表します。  
タイプ: Long  
必須: いいえ

 ** 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>
リカバリーポイントを復元するジョブに要する予想される分単位の時間です。  
タイプ: Long  
必須: いいえ

 ** 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) バックアップでは、サポートされているリソースタイプは Amazon 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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreJobsListMember) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreJobsListMember) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreJobsListMember) 

# RestoreJobSummary
<a name="API_RestoreJobSummary"></a>

過去 30 日以内に作成または実行された復元ジョブの概要です。

返される概要には、該当するジョブの Region、Account、State、ResourceType、MessageCategory、StartTime、EndTime、および Count が含まれる場合があります。

## 内容
<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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreJobSummary) 
+  [AWS SDK for Ruby V3](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` には 5 つのパラメータがあります (3 つが必須、2 つはオプション)。指定した値によって、復元テストに含まれる復旧ポイントが決まります。`SelectionWindowDays` 内の最新の復旧ポイントが必要かどうか、またはランダムな復旧ポイントが必要かどうかを `Algorithm` に指定し、どのボールトから復旧ポイントを選択できるかを、`IncludeVaults` を通じて指定する必要があります。  
 `Algorithm` (*必須)* 有効な値:「`LATEST_WITHIN_WINDOW`」または「`RANDOM_WITHIN_WINDOW`」。  
 `Recovery point types` (*必須)* 有効な値:「`SNAPSHOT`」および/または「`CONTINUOUS`」。`SNAPSHOT` を含めるとスナップショット復旧ポイントのみを復元します。`CONTINUOUS` を含めると継続的な復旧ポイント (ポイントインタイムリストア/PITR) を復元します。両方を使用するとスナップショットまたは継続的な復旧ポイントを復元します。復旧ポイントは、`Algorithm` の値によって決まります。  
 `IncludeVaults` (*必須*)。1 つ以上のバックアップボールトを含める必要があります。ワイルドカード ["\$1"] または特定の ARNを使用します。  
 `SelectionWindowDays` (*オプション*) 値は 1～365 の整数 (日単位) である必要があります。含まれない場合、この値はデフォルトで `30` になります。  
 `ExcludeVaults` (*オプション*)。1 つ以上の特定のバックアップボールト 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 時間 (1 週間) になります。  
タイプ: 整数  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_RestoreTestingPlanForCreate_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreTestingPlanForCreate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreTestingPlanForCreate) 
+  [AWS SDK for Ruby V3](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>
リクエストを識別し、失敗したリクエストを再試行する際に、オペレーションを 2 回実行するリスクを回避することができます。リクエストに既存のバックアッププランと一致する `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 時間 (1 週間) になります。  
タイプ: 整数  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_RestoreTestingPlanForGet_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreTestingPlanForGet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreTestingPlanForGet) 
+  [AWS SDK for Ruby V3](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 時間 (1 週間) になります。  
タイプ: 整数  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_RestoreTestingPlanForList_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreTestingPlanForList) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreTestingPlanForList) 
+  [AWS SDK for Ruby V3](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` (1 つ以上)。**  
オプション: 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 時間 (1 週間) になります。  
タイプ: 整数  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_RestoreTestingPlanForUpdate_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreTestingPlanForUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreTestingPlanForUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreTestingPlanForUpdate) 

# RestoreTestingRecoveryPointSelection
<a name="API_RestoreTestingRecoveryPointSelection"></a>

 `RecoveryPointSelection` には 5 つのパラメータがあります (3 つが必須、2 つはオプション)。指定した値によって、復元テストに含まれる復旧ポイントが決まります。`SelectionWindowDays` 内の最新の復旧ポイントが必要かどうか、またはランダムな復旧ポイントが必要かどうかを `Algorithm` に指定し、どのボールトから復旧ポイントを選択できるかを、`IncludeVaults` を通じて指定する必要があります。

 `Algorithm` (*必須)* 有効な値:「`LATEST_WITHIN_WINDOW`」または「`RANDOM_WITHIN_WINDOW`」。

 `Recovery point types` (*必須)* 有効な値:「`SNAPSHOT`」および/または「`CONTINUOUS`」。`SNAPSHOT` を含めるとスナップショット復旧ポイントのみを復元します。`CONTINUOUS` を含めると継続的な復旧ポイント (ポイントインタイムリストア/PITR) を復元します。両方を使用するとスナップショットまたは継続的な復旧ポイントを復元します。復旧ポイントは、`Algorithm` の値によって決まります。

 `IncludeVaults` (*必須*)。1 つ以上のバックアップボールトを含める必要があります。ワイルドカード ["\$1"] または特定の ARNを使用します。

 `SelectionWindowDays` (*オプション*) 値は 1～365 の整数 (日単位) である必要があります。含まれない場合、この値はデフォルトで `30` になります。

 `ExcludeVaults` (*オプション*)。1 つ以上の特定のバックアップボールト 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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreTestingRecoveryPointSelection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreTestingRecoveryPointSelection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreTestingRecoveryPointSelection) 

# RestoreTestingSelectionForCreate
<a name="API_RestoreTestingSelectionForCreate"></a>

特定の復元テスト選択に関するメタデータが含まれます。

Amazon EBS や Amazon EC2 などの ProtectedResourceType が必須です。

これは、`RestoreTestingSelectionName`、`ProtectedResourceType` と、以下のいずれかで構成されます。
+  `ProtectedResourceArns` 
+  `ProtectedResourceConditions` 

保護対象リソースのタイプごとに値を 1 つ設定できます。

復元テスト選択には、`ProtectedResourceArns` のワイルドカード値 (「\$1」) を `ProtectedResourceConditions` と併せて含めることができます。または、`ProtectedResourceArns` に保護対象リソースの ARN を最大 30 個まで含めることもできます。

 `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`
+  Amazon DynamoDB 用の `DynamoDB`
+  Amazon Elastic Block Store 用の `EBS`
+  Amazon Elastic Compute Cloud 用の `EC2`
+  Amazon Elastic File System 用の `EFS`
+  Amazon FSx の場合 用の `FSx`
+  Amazon Neptune の場合 用の `Neptune`
+  Amazon Relational Database Service 用の `RDS`
+  Amazon S3 の場合は `S3`
タイプ: 文字列  
必須: はい

 ** RestoreTestingSelectionName **   <a name="Backup-Type-RestoreTestingSelectionForCreate-RestoreTestingSelectionName"></a>
関連する復元テストプランに属する復元テスト選択の一意の名前。  
名前には英数字とアンダースコアのみを使用できます。最大長は 50 文字です。  
タイプ: 文字列  
必須: はい

 ** ProtectedResourceArns **   <a name="Backup-Type-RestoreTestingSelectionForCreate-ProtectedResourceArns"></a>
保護対象の各リソースは、特定の ARN (例: `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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreTestingSelectionForCreate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreTestingSelectionForCreate) 
+  [AWS SDK for Ruby V3](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>
リクエストを識別し、失敗したリクエストを再試行する際に、オペレーションを 2 回実行するリスクを回避することができます。リクエストに既存のバックアッププランと一致する `CreatorRequestId` が含まれる場合、そのプランが返されます。このパラメータはオプションです。  
使用する場合、このパラメータには 1～50 文字の英数字または「-\$1」を含める必要があります 。  
タイプ: 文字列  
必須: いいえ

 ** ProtectedResourceArns **   <a name="Backup-Type-RestoreTestingSelectionForGet-ProtectedResourceArns"></a>
特定の ARN (例: `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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreTestingSelectionForGet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreTestingSelectionForGet) 
+  [AWS SDK for Ruby V3](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 (7 日間に相当する時間) の整数です。  
タイプ: 整数  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_RestoreTestingSelectionForList_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreTestingSelectionForList) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreTestingSelectionForList) 
+  [AWS SDK for Ruby V3](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 (7 日間に相当する時間) の整数です。  
タイプ: 整数  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_RestoreTestingSelectionForUpdate_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreTestingSelectionForUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreTestingSelectionForUpdate) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ScanAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ScanAction) 
+  [AWS SDK for Ruby V3](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>
`arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`などのバックアップボールトを一意に識別する Amazon リソースネーム (ARN)。  
タイプ: 文字列  
必須: はい

 ** 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 Elastic Block Store (Amazon EBS) ボリュームや Amazon Relational Database Service (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` `FAILED` \$1 \$1 `CANCELED`。  
型: 文字列  
有効な値：`CANCELED | COMPLETED | COMPLETED_WITH_ISSUES | CREATED | FAILED | RUNNING`  
必須：いいえ

 ** StatusMessage **   <a name="Backup-Type-ScanJob-StatusMessage"></a>
スキャンジョブのステータスを説明する詳細なメッセージ。  
タイプ: 文字列  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_ScanJob_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ScanJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ScanJob) 
+  [AWS SDK for Ruby V3](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>
例えば、`arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50` などのバックアップ計画を一意に識別する Amazon リソースネーム (ARN) です。  
タイプ: 文字列  
必須: はい

 ** BackupPlanId **   <a name="Backup-Type-ScanJobCreator-BackupPlanId"></a>
バックアッププランの ID。  
タイプ: 文字列  
必須: はい

 ** BackupPlanVersion **   <a name="Backup-Type-ScanJobCreator-BackupPlanVersion"></a>
一意のランダムに生成された UTF-8 エンコード Unicode 文字列 (最大 1,024 バイト長)。バージョン ID を編集することはできません。  
タイプ: 文字列  
必須: はい

 ** BackupRuleId **   <a name="Backup-Type-ScanJobCreator-BackupRuleId"></a>
スキャンジョブを開始したバックアップルールを一意に識別します。  
タイプ: 文字列  
必須: はい

## 以下の資料も参照してください。
<a name="API_ScanJobCreator_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ScanJobCreator) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ScanJobCreator) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ScanJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ScanJobSummary) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ScanResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ScanResult) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ScanResultInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ScanResultInfo) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ScanSetting) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ScanSetting) 
+  [AWS SDK for Ruby V3](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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ScheduledPlanExecutionMember) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ScheduledPlanExecutionMember) 
+  [AWS SDK for Ruby V3](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>
階層化設定が適用されるバックアップボールトの名前。を使用して`*`、すべてのバックアップボールトに適用します。  
タイプ: 文字列  
Pattern: `^(\*|[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>
階層化設定の一意の名前。これは作成後に変更できず、英数字とアンダースコアのみで構成されている必要があります。  
タイプ: 文字列  
Pattern: `^[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>
これはリクエストを識別し、失敗したリクエストを 2 回実行するリスクなしに再試行できるようにする一意の文字列です。  
タイプ: 文字列  
必須: いいえ

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

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/TieringConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/TieringConfiguration) 
+  [AWS SDK for Ruby V3](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>
階層化設定が適用されるバックアップボールトの名前。を使用して`*`、すべてのバックアップボールトに適用します。  
タイプ: 文字列  
Pattern: `^(\*|[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>
階層化設定の一意の名前。これは作成後に変更できず、英数字とアンダースコアのみで構成されている必要があります。  
タイプ: 文字列  
Pattern: `^[a-zA-Z0-9_]{1,200}$`   
必須: はい

## 以下の資料も参照してください。
<a name="API_TieringConfigurationInputForCreate_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/TieringConfigurationInputForCreate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/TieringConfigurationInputForCreate) 
+  [AWS SDK for Ruby V3](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>
階層化設定が適用されるバックアップボールトの名前。を使用して`*`、すべてのバックアップボールトに適用します。  
タイプ: 文字列  
Pattern: `^(\*|[a-zA-Z0-9\-\_]{2,50})$`   
必須: はい

 ** ResourceSelection **   <a name="Backup-Type-TieringConfigurationInputForUpdate-ResourceSelection"></a>
階層設定に含めるリソースとその階層設定を指定するリソース選択オブジェクトの配列。  
型: [ResourceSelection](API_ResourceSelection.md) オブジェクトの配列  
必須: はい

## 以下の資料も参照してください。
<a name="API_TieringConfigurationInputForUpdate_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/TieringConfigurationInputForUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/TieringConfigurationInputForUpdate) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/TieringConfigurationsListMember) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/TieringConfigurationsListMember) 
+  [AWS SDK for Ruby V3](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>

ゲートウェイの帯域幅レート制限間隔を記述します。帯域幅レート制限スケジュールは、帯域幅レート制限間隔で構成されます。帯域幅レート制限間隔は、アップロードのために帯域幅レート制限が指定されている 1 つ以上の曜日の期間を定義します。

## 内容
<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>
帯域幅レート制限間隔が終了する時刻のうちの分。  
帯域幅レート制限間隔は、この 1 分間の最後に終了します。1 時間の終わりに間隔を終了するには、値 `59` を使用します。
タイプ: 整数  
有効な範囲: 最小値 は 0 です。最大値は 59 です。  
必須: はい

 ** StartHourOfDay **   <a name="Backup-Type-BGW_BandwidthRateLimitInterval-StartHourOfDay"></a>
帯域幅レート制限間隔を開始する時刻のうちの時間。  
タイプ: 整数  
有効な範囲: 最小値 は 0 です。最大値は 23 です。  
必須: はい

 ** StartMinuteOfHour **   <a name="Backup-Type-BGW_BandwidthRateLimitInterval-StartMinuteOfHour"></a>
帯域幅レート制限期間を開始する時間のうちの分。間隔はその 1 分間の開始時から始まります。間隔の開始時刻を、その時間の開始時から正確に開始するには、値 `0` を使用します。  
タイプ: 整数  
有効な範囲: 最小値 は 0 です。最大値は 59 です。  
必須: はい

 ** AverageUploadRateLimitInBitsPerSec **   <a name="Backup-Type-BGW_BandwidthRateLimitInterval-AverageUploadRateLimitInBitsPerSec"></a>
帯域幅レート制限間隔の平均アップロード速度制限単位 (ビット/秒)。アップロード速度制限が設定されていない場合、このフィールドはレスポンスに表示されません。  
タイプ: Long  
有効な範囲: 最小値 は 51200 です。最大値は 8000000000000 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_BGW_BandwidthRateLimitInterval_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/BandwidthRateLimitInterval) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/BandwidthRateLimitInterval) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/BandwidthRateLimitInterval) 

# Gateway
<a name="API_BGW_Gateway"></a>

ゲートウェイとは、お客様のネットワーク上で動作する AWS Backup ゲートウェイアプライアンスで、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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/Gateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/Gateway) 
+  [AWS SDK for Ruby V3](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>
 AWS Backup ゲートウェイがクラウドと最後に通信した時刻を Unix 形式および UTC 時間で示す詳細。  
型: タイムスタンプ  
必須: いいえ

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

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GatewayDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GatewayDetails) 
+  [AWS SDK for Ruby V3](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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/Hypervisor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/Hypervisor) 
+  [AWS SDK for Ruby V3](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 です。最大長は 2,048 です。  
パターン: `$|^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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/HypervisorDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/HypervisorDetails) 
+  [AWS SDK for Ruby V3](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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/MaintenanceStartTime) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/MaintenanceStartTime) 
+  [AWS SDK for Ruby V3](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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/Tag) 
+  [AWS SDK for Ruby V3](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 です。最大長は 4,096 です。  
パターン: `[^\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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/VirtualMachine) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/VirtualMachine) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/VirtualMachine) 

# VirtualMachineDetails
<a name="API_BGW_VirtualMachineDetails"></a>

Amazon リソースネーム (ARN) の順序が付けられた、`VirtualMachine` オブジェクトです。

## 内容
<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 です。最大長は 4,096 です。  
パターン: `[^\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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/VirtualMachineDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/VirtualMachineDetails) 
+  [AWS SDK for Ruby V3](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 を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/VmwareTag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/VmwareTag) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/VmwareToAwsTagMapping) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/VmwareToAwsTagMapping) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/BackupCreationTimeFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/BackupCreationTimeFilter) 
+  [AWS SDK for Ruby V3](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>
この数は、進行中の検索ジョブの項目フィルターに一致するすべての項目の合計です。  
タイプ: Long  
必須: いいえ

 ** ItemsScannedCount **   <a name="Backup-Type-BKS_CurrentSearchProgress-ItemsScannedCount"></a>
この数は、検索ジョブ中にこれまでにスキャンされたすべての項目の合計です。  
タイプ: Long  
必須: いいえ

 ** RecoveryPointsScannedCount **   <a name="Backup-Type-BKS_CurrentSearchProgress-RecoveryPointsScannedCount"></a>
この数は、検索ジョブ中にこれまでにスキャンされたすべてのバックアップの合計です。  
タイプ: 整数  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_BKS_CurrentSearchProgress_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/CurrentSearchProgress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/CurrentSearchProgress) 
+  [AWS SDK for Ruby V3](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 個の値を含めることができます。  
値が 1 つ含まれている場合、結果には一致する項目のみが返されます。  
複数の値が含まれている場合、結果には含まれている値のいずれかに一致するすべての項目が返されます。  
型: [TimeCondition](API_BKS_TimeCondition.md) オブジェクトの配列  
配列メンバー: 最小数は 1 項目です。最大数は 10 項目です。  
必須: いいえ

 ** FilePaths **   <a name="Backup-Type-BKS_EBSItemFilter-FilePaths"></a>
1～10 個の値を含めることができます。  
1 つのファイルパスが含まれている場合、結果はファイルパスに一致する項目のみを返します。  
複数のファイルパスが含まれている場合、結果はいずれかのファイルパスに一致するすべての項目を返します。  
型: [StringCondition](API_BKS_StringCondition.md) オブジェクトの配列  
配列メンバー: 最小数は 1 項目です。最大数は 10 項目です。  
必須: いいえ

 ** LastModificationTimes **   <a name="Backup-Type-BKS_EBSItemFilter-LastModificationTimes"></a>
1～10 個の値を含めることができます。  
値が 1 つ含まれている場合、結果には一致する項目のみが返されます。  
複数の値が含まれている場合、結果には含まれている値のいずれかに一致するすべての項目が返されます。  
型: [TimeCondition](API_BKS_TimeCondition.md) オブジェクトの配列  
配列メンバー: 最小数は 1 項目です。最大数は 10 項目です。  
必須: いいえ

 ** Sizes **   <a name="Backup-Type-BKS_EBSItemFilter-Sizes"></a>
1～10 個の値を含めることができます。  
値が 1 つ含まれている場合、結果には一致する項目のみが返されます。  
複数の値が含まれている場合、結果には含まれている値のいずれかに一致するすべての項目が返されます。  
型: [LongCondition](API_BKS_LongCondition.md) オブジェクトの配列  
配列メンバー: 最小数は 1 項目です。最大数は 10 項目です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_BKS_EBSItemFilter_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/EBSItemFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/EBSItemFilter) 
+  [AWS SDK for Ruby V3](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) の値と一致する結果に含まれる 1 つ以上の項目です。  
タイプ: 文字列  
必須: いいえ

 ** BackupVaultName **   <a name="Backup-Type-BKS_EBSResultItem-BackupVaultName"></a>
バックアップボールトの名前。  
タイプ: 文字列  
必須: いいえ

 ** CreationTime **   <a name="Backup-Type-BKS_EBSResultItem-CreationTime"></a>
これらは、Amazon EBS バックアップメタデータの検索で返される、作成時刻の値と一致する結果に含まれる 1 つ以上の項目です。  
型: タイムスタンプ  
必須: いいえ

 ** FilePath **   <a name="Backup-Type-BKS_EBSResultItem-FilePath"></a>
これらは、Amazon EBS バックアップメタデータの検索で返される、ファイルパスの値と一致する結果に含まれる 1 つ以上の項目です。  
タイプ: 文字列  
必須: いいえ

 ** FileSize **   <a name="Backup-Type-BKS_EBSResultItem-FileSize"></a>
これらは、Amazon EBS バックアップメタデータの検索で返される、ファイルサイズの値と一致する結果に含まれる 1 つ以上の項目です。  
タイプ: Long  
必須: いいえ

 ** FileSystemIdentifier **   <a name="Backup-Type-BKS_EBSResultItem-FileSystemIdentifier"></a>
これらは、Amazon EBS バックアップメタデータの検索で返される、ファイルシステムの値と一致する結果に含まれる 1 つ以上の項目です。  
タイプ: 文字列  
必須: いいえ

 ** LastModifiedTime **   <a name="Backup-Type-BKS_EBSResultItem-LastModifiedTime"></a>
これらは、Amazon EBS バックアップメタデータの検索で返される、最終変更時刻の値と一致する結果に含まれる 1 つ以上の項目です。  
型: タイムスタンプ  
必須: いいえ

 ** SourceResourceArn **   <a name="Backup-Type-BKS_EBSResultItem-SourceResourceArn"></a>
これらは、Amazon EBS バックアップメタデータの検索で返される、ソースリソースの Amazon リソースネーム (ARN) の値と一致する結果に含まれる 1 つ以上の項目です。  
タイプ: 文字列  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_BKS_EBSResultItem_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/EBSResultItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/EBSResultItem) 
+  [AWS SDK for Ruby V3](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>
これは、新しいエクスポートジョブに属する一意の ARN (Amazon リソースネーム) です。  
タイプ: 文字列  
必須: いいえ

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

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/ExportJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/ExportJobSummary) 
+  [AWS SDK for Ruby V3](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>

**重要**  
このデータ型は共用体であるため、使用または返されるときは次のメンバーのうちの 1 つだけを指定できます。

 ** s3ExportSpecification **   <a name="Backup-Type-BKS_ExportSpecification-s3ExportSpecification"></a>
これは、エクスポートジョブの送信先 Amazon S3 バケットを指定します。また、含まれている場合は、送信先プレフィックスも指定します。  
型: [S3ExportSpecification](API_BKS_S3ExportSpecification.md) オブジェクト  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_BKS_ExportSpecification_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/ExportSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/ExportSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/ExportSpecification) 

# ItemFilters
<a name="API_BKS_ItemFilters"></a>

Item Filters は、検索の作成時に指定されたすべての入力項目プロパティを表します。

EBSItemFilters または S3ItemFilters のいずれかを含みます

## 内容
<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、Sizes、または VersionIds オブジェクトを含めることができます。  
型: [S3ItemFilter](API_BKS_S3ItemFilter.md) オブジェクトの配列  
の配列メンバー: 最小数は 0 項目です。最大数は 10 項目です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_BKS_ItemFilters_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/ItemFilters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/ItemFilters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/ItemFilters) 

# LongCondition
<a name="API_BKS_LongCondition"></a>

Long 型の条件には `Value` が含まれ、オプションで `Operator` を含めることができます。

## 内容
<a name="API_BKS_LongCondition_Contents"></a>

 ** Value **   <a name="Backup-Type-BKS_LongCondition-Value"></a>
検索項目フィルターの 1 つに含まれる項目の値。  
タイプ: Long  
必須: はい

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

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/LongCondition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/LongCondition) 
+  [AWS SDK for Ruby V3](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>

**重要**  
このデータ型は共用体であるため、使用または返されるときは次のメンバーのうちの 1 つだけを指定できます。

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

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/ResultItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/ResultItem) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/S3ExportSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/S3ExportSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/S3ExportSpecification) 

# S3ItemFilter
<a name="API_BKS_S3ItemFilter"></a>

これには、ObjectKeys、CreationTimes、VersionIds、Etags などのオブジェクトの配列が含まれます。

## 内容
<a name="API_BKS_S3ItemFilter_Contents"></a>

 ** CreationTimes **   <a name="Backup-Type-BKS_S3ItemFilter-CreationTimes"></a>
1～10 個の値を含めることができます。  
値が 1 つ含まれている場合、結果には一致する項目のみが返されます。  
複数の値が含まれている場合、結果にはいずれかの値に一致するすべての項目が返されます。  
型: [TimeCondition](API_BKS_TimeCondition.md) オブジェクトの配列  
配列メンバー: 最小数は 1 項目です。最大数は 10 項目です。  
必須: いいえ

 ** ETags **   <a name="Backup-Type-BKS_S3ItemFilter-ETags"></a>
1～10 個の値を含めることができます。  
値が 1 つ含まれている場合、結果には一致する項目のみが返されます。  
複数の値が含まれている場合、結果にはいずれかの値に一致するすべての項目が返されます。  
型: [StringCondition](API_BKS_StringCondition.md) オブジェクトの配列  
配列メンバー: 最小数は 1 項目です。最大数は 10 項目です。  
必須: いいえ

 ** ObjectKeys **   <a name="Backup-Type-BKS_S3ItemFilter-ObjectKeys"></a>
1～10 個の値を含めることができます。  
値が 1 つ含まれている場合、結果には一致する項目のみが返されます。  
複数の値が含まれている場合、結果にはいずれかの値に一致するすべての項目が返されます。  
型: [StringCondition](API_BKS_StringCondition.md) オブジェクトの配列  
配列メンバー: 最小数は 1 項目です。最大数は 10 項目です。  
必須: いいえ

 ** Sizes **   <a name="Backup-Type-BKS_S3ItemFilter-Sizes"></a>
1～10 個の値を含めることができます。  
値が 1 つ含まれている場合、結果には一致する項目のみが返されます。  
複数の値が含まれている場合、結果にはいずれかの値に一致するすべての項目が返されます。  
型: [LongCondition](API_BKS_LongCondition.md) オブジェクトの配列  
配列メンバー: 最小数は 1 項目です。最大数は 10 項目です。  
必須: いいえ

 ** VersionIds **   <a name="Backup-Type-BKS_S3ItemFilter-VersionIds"></a>
1～10 個の値を含めることができます。  
値が 1 つ含まれている場合、結果には一致する項目のみが返されます。  
複数の値が含まれている場合、結果にはいずれかの値に一致するすべての項目が返されます。  
型: [StringCondition](API_BKS_StringCondition.md) オブジェクトの配列  
配列メンバー: 最小数は 1 項目です。最大数は 10 項目です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_BKS_S3ItemFilter_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/S3ItemFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/S3ItemFilter) 
+  [AWS SDK for Ruby V3](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 バックアップメタデータの検索中に入力された項目作成時刻の値と一致する、返された結果内の 1 つ以上の項目です。  
型: タイムスタンプ  
必須: いいえ

 ** ETag **   <a name="Backup-Type-BKS_S3ResultItem-ETag"></a>
これらは、Amazon S3 バックアップメタデータの検索中に入力された ETags の値と一致する、返された結果内の 1 つ以上の項目です。  
タイプ: 文字列  
必須: いいえ

 ** ObjectKey **   <a name="Backup-Type-BKS_S3ResultItem-ObjectKey"></a>
これは、オブジェクトキーの入力値と一致する Amazon S3 バックアップメタデータの検索結果で返される 1 つ以上の項目です。  
タイプ: 文字列  
必須: いいえ

 ** ObjectSize **   <a name="Backup-Type-BKS_S3ResultItem-ObjectSize"></a>
これらは、Amazon S3 バックアップメタデータの検索中に入力されたオブジェクトサイズの値と一致する返された結果の項目です。  
タイプ: Long  
必須: いいえ

 ** SourceResourceArn **   <a name="Backup-Type-BKS_S3ResultItem-SourceResourceArn"></a>
これらは、Amazon S3 バックアップメタデータの検索中にソース Amazon リソースネーム (ARN) 入力に一致する返された結果の項目です。  
タイプ: 文字列  
必須: いいえ

 ** VersionId **   <a name="Backup-Type-BKS_S3ResultItem-VersionId"></a>
これらは、Amazon S3 バックアップメタデータの検索中に入力されたバージョン ID の値と一致する、返された結果内の 1 つ以上の項目です。  
タイプ: 文字列  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_BKS_S3ResultItem_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/S3ResultItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/S3ResultItem) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/SearchJobBackupsResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/SearchJobBackupsResult) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/SearchJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/SearchJobSummary) 
+  [AWS SDK for Ruby V3](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>
これらはバックアップ (復旧ポイント) の 1 つ以上のタグです。  
タイプ: 文字列間のマッピング  
必須: いいえ

 ** SourceResourceArns **   <a name="Backup-Type-BKS_SearchScope-SourceResourceArns"></a>
ソースリソースを一意に識別する Amazon リソースネーム (ARN)。  
型: 文字列の配列  
配列メンバー: 最小数は 0 項目です。最大数は 50 項目です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_BKS_SearchScope_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/SearchScope) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/SearchScope) 
+  [AWS SDK for Ruby V3](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>
これは、検索でスキャンされる項目の合計数です。  
タイプ: Long  
必須: いいえ

 ** TotalRecoveryPointsToScanCount **   <a name="Backup-Type-BKS_SearchScopeSummary-TotalRecoveryPointsToScanCount"></a>
これは、検索でスキャンされるバックアップの合計数です。  
タイプ: 整数  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_BKS_SearchScopeSummary_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/SearchScopeSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/SearchScopeSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/SearchScopeSummary) 

# StringCondition
<a name="API_BKS_StringCondition"></a>

これには文字列の値が含まれ、1 つ以上の演算子を含めることができます。

## 内容
<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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/StringCondition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/StringCondition) 
+  [AWS SDK for Ruby V3](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>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/TimeCondition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/TimeCondition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/TimeCondition) 

# 共通パラメータ
<a name="CommonParameters"></a>

次のリストには、すべてのアクションが署名バージョン 4 リクエストにクエリ文字列で署名するために使用するパラメータを示します。アクション固有のパラメータは、アクションのトピックに示されています。署名バージョン 4 の詳細については、*IAM ユーザーガイド*[の 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*/*リージョン*/*サービス*/aws4\$1request]。  
詳細については、*IAM* [ユーザーガイドの「署名付き 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' でなければなりません。例えば、日付 `20120325T120000Z` は、有効な X-Amz-Date の値です。  
条件: X-Amz-Date はすべてのリクエストに対してオプションです。署名リクエストで使用する日付よりも優先される日付として使用できます。ISO 8601 ベーシック形式で日付ヘッダーが指定されている場合、X-Amz-Date は必要ありません。X-Amz-Date を使用すると、常に Date ヘッダーの値よりも優先されます。詳細については、*IAM ユーザーガイド*[の 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>
署名する文字列と派生署名キーから計算された 16 進符号化署名を指定します。  
条件: HTTP 認可ヘッダーではなくクエリ文字列に認証情報を含める場合は、このパラメータを指定します。  
型: 文字列  
必須: 条件による

 **X-Amz-SignedHeaders**   <a name="CommonParameters-X-Amz-SignedHeaders"></a>
正規リクエストの一部として含まれていたすべての HTTP ヘッダーを指定します。署名付きヘッダーの指定の詳細については、*IAM* [ユーザーガイドの「署名付き 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>
内部サーバーの問題のため、リクエストは現在処理できません。後でもう一度お試しください。問題が解決しない場合は、 AWS サポートにお問い合わせください。  
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