# AWS Backup API
In addition to using the console, you can use the AWS Backup API actions and data types to programmatically configure and manage AWS Backup and its resources. This section describes AWS Backup actions and data types. It contains the API reference for AWS Backup.
**AWS Backup API**
+ [AWS Backup Actions](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_Operations.html)
+ [AWS Backup Data Types](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_Types.html)
# Actions
The following actions are supported by 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)
The following actions are supported by 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)
The following actions are supported by AWS Backup search:
+ [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
The following actions are supported by 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
Associates an MPA approval team with a backup vault.
## Request Syntax
```
PUT /backup-vaults/backupVaultName/mpaApprovalTeam HTTP/1.1
Content-type: application/json
{
"MpaApprovalTeamArn": "string",
"RequesterComment": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupVaultName](#API_AssociateBackupVaultMpaApprovalTeam_RequestSyntax) **
The name of the backup vault to associate with the MPA approval team.
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [MpaApprovalTeamArn](#API_AssociateBackupVaultMpaApprovalTeam_RequestSyntax) **
The Amazon Resource Name (ARN) of the MPA approval team to associate with the backup vault.
Type: String
Required: Yes
** [RequesterComment](#API_AssociateBackupVaultMpaApprovalTeam_RequestSyntax) **
A comment provided by the requester explaining the association request.
Type: String
Required: No
## Response Syntax
```
HTTP/1.1 204
```
## Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** InvalidRequestException **
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.
## Request Syntax
```
DELETE /legal-holds/legalHoldId?cancelDescription=CancelDescription&retainRecordInDays=RetainRecordInDays HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [CancelDescription](#API_CancelLegalHold_RequestSyntax) **
A string the describes the reason for removing the legal hold.
Required: Yes
** [legalHoldId](#API_CancelLegalHold_RequestSyntax) **
The ID of the legal hold.
Required: Yes
** [RetainRecordInDays](#API_CancelLegalHold_RequestSyntax) **
The integer amount, in days, after which to remove legal hold.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 201
```
## Response Elements
If the action is successful, the service sends back an HTTP 201 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** InvalidResourceStateException **
AWS Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Creates a backup plan using a backup plan name and backup rules. A backup plan is a document that contains information that AWS Backup uses to schedule tasks that create recovery points for resources.
If you call `CreateBackupPlan` with a plan that already exists, you receive an `AlreadyExistsException` exception.
## Request Syntax
```
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 Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [BackupPlan](#API_CreateBackupPlan_RequestSyntax) **
The body of a backup plan. Includes a `BackupPlanName` and one or more sets of `Rules`.
Type: [BackupPlanInput](API_BackupPlanInput.md) object
Required: Yes
** [BackupPlanTags](#API_CreateBackupPlan_RequestSyntax) **
The tags to assign to the backup plan.
Type: String to string map
Required: No
** [CreatorRequestId](#API_CreateBackupPlan_RequestSyntax) **
Identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a `CreatorRequestId` that matches an existing backup plan, that plan is returned. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-\$1.' characters.
Type: String
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"AdvancedBackupSettings": [
{
"BackupOptions": {
"string" : "string"
},
"ResourceType": "string"
}
],
"BackupPlanArn": "string",
"BackupPlanId": "string",
"CreationDate": number,
"VersionId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [AdvancedBackupSettings](#API_CreateBackupPlan_ResponseSyntax) **
The settings for a resource type. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
Type: Array of [AdvancedBackupSetting](API_AdvancedBackupSetting.md) objects
** [BackupPlanArn](#API_CreateBackupPlan_ResponseSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, `arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50`.
Type: String
** [BackupPlanId](#API_CreateBackupPlan_ResponseSyntax) **
The ID of the backup plan.
Type: String
** [CreationDate](#API_CreateBackupPlan_ResponseSyntax) **
The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [VersionId](#API_CreateBackupPlan_ResponseSyntax) **
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AlreadyExistsException **
The required resource already exists.
** Arn **
** Context **
** CreatorRequestId **
** Type **
HTTP Status Code: 400
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** LimitExceededException **
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see [Assigning resources programmatically](https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-json).
## Request Syntax
```
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 Request Parameters
The request uses the following URI parameters.
** [backupPlanId](#API_CreateBackupSelection_RequestSyntax) **
The ID of the backup plan.
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [BackupSelection](#API_CreateBackupSelection_RequestSyntax) **
The body of a request to assign a set of resources to a backup plan.
Type: [BackupSelection](API_BackupSelection.md) object
Required: Yes
** [CreatorRequestId](#API_CreateBackupSelection_RequestSyntax) **
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-\$1.' characters.
Type: String
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"BackupPlanId": "string",
"CreationDate": number,
"SelectionId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BackupPlanId](#API_CreateBackupSelection_ResponseSyntax) **
The ID of the backup plan.
Type: String
** [CreationDate](#API_CreateBackupSelection_ResponseSyntax) **
The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [SelectionId](#API_CreateBackupSelection_ResponseSyntax) **
Uniquely identifies the body of a request to assign a set of resources to a backup plan.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AlreadyExistsException **
The required resource already exists.
** Arn **
** Context **
** CreatorRequestId **
** Type **
HTTP Status Code: 400
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** LimitExceededException **
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Creates a logical container where backups are stored. A `CreateBackupVault` request includes a name, optionally one or more resource tags, an encryption key, and a request ID.
**Note**
Do not include sensitive data, such as passport numbers, in the name of a backup vault.
## Request Syntax
```
PUT /backup-vaults/backupVaultName HTTP/1.1
Content-type: application/json
{
"BackupVaultTags": {
"string" : "string"
},
"CreatorRequestId": "string",
"EncryptionKeyArn": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupVaultName](#API_CreateBackupVault_RequestSyntax) **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of letters, numbers, and hyphens.
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [BackupVaultTags](#API_CreateBackupVault_RequestSyntax) **
The tags to assign to the backup vault.
Type: String to string map
Required: No
** [CreatorRequestId](#API_CreateBackupVault_RequestSyntax) **
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-\$1.' characters.
Type: String
Required: No
** [EncryptionKeyArn](#API_CreateBackupVault_RequestSyntax) **
The server-side encryption key that is used to protect your backups; for example, `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
Type: String
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"BackupVaultArn": "string",
"BackupVaultName": "string",
"CreationDate": number
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BackupVaultArn](#API_CreateBackupVault_ResponseSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
Type: String
** [BackupVaultName](#API_CreateBackupVault_ResponseSyntax) **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
Type: String
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
** [CreationDate](#API_CreateBackupVault_ResponseSyntax) **
The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AlreadyExistsException **
The required resource already exists.
** Arn **
** Context **
** CreatorRequestId **
** Type **
HTTP Status Code: 400
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** LimitExceededException **
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Creates a framework with one or more controls. A framework is a collection of controls that you can use to evaluate your backup practices. By using pre-built customizable controls to define your policies, you can evaluate whether your backup practices comply with your policies and which resources are not yet in compliance.
## Request Syntax
```
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 Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [FrameworkControls](#API_CreateFramework_RequestSyntax) **
The controls that make up the framework. Each control in the list has a name, input parameters, and scope.
Type: Array of [FrameworkControl](API_FrameworkControl.md) objects
Required: Yes
** [FrameworkDescription](#API_CreateFramework_RequestSyntax) **
An optional description of the framework with a maximum of 1,024 characters.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: `.*\S.*`
Required: No
** [FrameworkName](#API_CreateFramework_RequestSyntax) **
The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (\$1).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z][_a-zA-Z0-9]*`
Required: Yes
** [FrameworkTags](#API_CreateFramework_RequestSyntax) **
The tags to assign to the framework.
Type: String to string map
Required: No
** [IdempotencyToken](#API_CreateFramework_RequestSyntax) **
A customer-chosen string that you can use to distinguish between otherwise identical calls to `CreateFrameworkInput`. Retrying a successful request with the same idempotency token results in a success message with no action taken.
Type: String
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"FrameworkArn": "string",
"FrameworkName": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [FrameworkArn](#API_CreateFramework_ResponseSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
Type: String
** [FrameworkName](#API_CreateFramework_ResponseSyntax) **
The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (\$1).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z][_a-zA-Z0-9]*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AlreadyExistsException **
The required resource already exists.
** Arn **
** Context **
** CreatorRequestId **
** Type **
HTTP Status Code: 400
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** LimitExceededException **
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point.
## Request Syntax
```
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 Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [Description](#API_CreateLegalHold_RequestSyntax) **
The description of the legal hold.
Type: String
Required: Yes
** [IdempotencyToken](#API_CreateLegalHold_RequestSyntax) **
This is a user-chosen string used to distinguish between otherwise identical calls. Retrying a successful request with the same idempotency token results in a success message with no action taken.
Type: String
Required: No
** [RecoveryPointSelection](#API_CreateLegalHold_RequestSyntax) **
The criteria to assign a set of resources, such as resource types or backup vaults.
Type: [RecoveryPointSelection](API_RecoveryPointSelection.md) object
Required: No
** [Tags](#API_CreateLegalHold_RequestSyntax) **
Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: \$1 - = . \$1 : /.
Type: String to string map
Required: No
** [Title](#API_CreateLegalHold_RequestSyntax) **
The title of the legal hold.
Type: String
Required: Yes
## Response Syntax
```
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"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [CreationDate](#API_CreateLegalHold_ResponseSyntax) **
The time when the legal hold was created.
Type: Timestamp
** [Description](#API_CreateLegalHold_ResponseSyntax) **
The description of the legal hold.
Type: String
** [LegalHoldArn](#API_CreateLegalHold_ResponseSyntax) **
The Amazon Resource Name (ARN) of the legal hold.
Type: String
** [LegalHoldId](#API_CreateLegalHold_ResponseSyntax) **
The ID of the legal hold.
Type: String
** [RecoveryPointSelection](#API_CreateLegalHold_ResponseSyntax) **
The criteria to assign to a set of resources, such as resource types or backup vaults.
Type: [RecoveryPointSelection](API_RecoveryPointSelection.md) object
** [Status](#API_CreateLegalHold_ResponseSyntax) **
The status of the legal hold.
Type: String
Valid Values: `CREATING | ACTIVE | CANCELING | CANCELED`
** [Title](#API_CreateLegalHold_ResponseSyntax) **
The title of the legal hold.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** LimitExceededException **
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Creates a logical container to where backups may be copied.
This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.
**Note**
Do not include sensitive data, such as passport numbers, in the name of a backup vault.
## Request Syntax
```
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 Request Parameters
The request uses the following URI parameters.
** [backupVaultName](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **
The name of a logical container where backups are stored. Logically air-gapped backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [BackupVaultTags](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **
The tags to assign to the vault.
Type: String to string map
Required: No
** [CreatorRequestId](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **
The ID of the creation request.
This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-\$1.' characters.
Type: String
Required: No
** [EncryptionKeyArn](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **
The ARN of the customer-managed KMS key to use for encrypting the logically air-gapped backup vault. If not specified, the vault will be encrypted with an AWS-owned key managed by AWS Backup.
Type: String
Required: No
** [MaxRetentionDays](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **
The maximum retention period that the vault retains its recovery points.
Type: Long
Required: Yes
** [MinRetentionDays](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **
This setting specifies the minimum retention period that the vault retains its recovery points.
The minimum value accepted is 7 days.
Type: Long
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"BackupVaultArn": "string",
"BackupVaultName": "string",
"CreationDate": number,
"VaultState": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BackupVaultArn](#API_CreateLogicallyAirGappedBackupVault_ResponseSyntax) **
The ARN (Amazon Resource Name) of the vault.
Type: String
** [BackupVaultName](#API_CreateLogicallyAirGappedBackupVault_ResponseSyntax) **
The name of a logical container where backups are stored. Logically air-gapped backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
Type: String
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
** [CreationDate](#API_CreateLogicallyAirGappedBackupVault_ResponseSyntax) **
The date and time when the vault was created.
This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [VaultState](#API_CreateLogicallyAirGappedBackupVault_ResponseSyntax) **
The current state of the vault.
Type: String
Valid Values: `CREATING | AVAILABLE | FAILED`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AlreadyExistsException **
The required resource already exists.
** Arn **
** Context **
** CreatorRequestId **
** Type **
HTTP Status Code: 400
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** InvalidRequestException **
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
** Context **
** Type **
HTTP Status Code: 400
** LimitExceededException **
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Creates a report plan. A report plan is a document that contains information about the contents of the report and where AWS Backup will deliver it.
If you call `CreateReportPlan` with a plan that already exists, you receive an `AlreadyExistsException` exception.
## Request Syntax
```
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 Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [IdempotencyToken](#API_CreateReportPlan_RequestSyntax) **
A customer-chosen string that you can use to distinguish between otherwise identical calls to `CreateReportPlanInput`. Retrying a successful request with the same idempotency token results in a success message with no action taken.
Type: String
Required: No
** [ReportDeliveryChannel](#API_CreateReportPlan_RequestSyntax) **
A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
Type: [ReportDeliveryChannel](API_ReportDeliveryChannel.md) object
Required: Yes
** [ReportPlanDescription](#API_CreateReportPlan_RequestSyntax) **
An optional description of the report plan with a maximum of 1,024 characters.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: `.*\S.*`
Required: No
** [ReportPlanName](#API_CreateReportPlan_RequestSyntax) **
The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (\$1).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z][_a-zA-Z0-9]*`
Required: Yes
** [ReportPlanTags](#API_CreateReportPlan_RequestSyntax) **
The tags to assign to the report plan.
Type: String to string map
Required: No
** [ReportSetting](#API_CreateReportPlan_RequestSyntax) **
Identifies the report template for the report. Reports are built using a report template. The report templates are:
`RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT | SCAN_JOB_REPORT `
If the report template is `RESOURCE_COMPLIANCE_REPORT` or `CONTROL_COMPLIANCE_REPORT`, this API resource also describes the report coverage by AWS Regions and frameworks.
Type: [ReportSetting](API_ReportSetting.md) object
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"ReportPlanArn": "string",
"ReportPlanName": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [CreationTime](#API_CreateReportPlan_ResponseSyntax) **
The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [ReportPlanArn](#API_CreateReportPlan_ResponseSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
Type: String
** [ReportPlanName](#API_CreateReportPlan_ResponseSyntax) **
The unique name of the report plan.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z][_a-zA-Z0-9]*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AlreadyExistsException **
The required resource already exists.
** Arn **
** Context **
** CreatorRequestId **
** Type **
HTTP Status Code: 400
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** LimitExceededException **
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Creates a restore access backup vault that provides temporary access to recovery points in a logically air-gapped backup vault, subject to MPA approval.
## Request Syntax
```
PUT /restore-access-backup-vaults HTTP/1.1
Content-type: application/json
{
"BackupVaultName": "string",
"BackupVaultTags": {
"string" : "string"
},
"CreatorRequestId": "string",
"RequesterComment": "string",
"SourceBackupVaultArn": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [BackupVaultName](#API_CreateRestoreAccessBackupVault_RequestSyntax) **
The name of the backup vault to associate with an MPA approval team.
Type: String
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: No
** [BackupVaultTags](#API_CreateRestoreAccessBackupVault_RequestSyntax) **
Optional tags to assign to the restore access backup vault.
Type: String to string map
Required: No
** [CreatorRequestId](#API_CreateRestoreAccessBackupVault_RequestSyntax) **
A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.
Type: String
Required: No
** [RequesterComment](#API_CreateRestoreAccessBackupVault_RequestSyntax) **
A comment explaining the reason for requesting restore access to the backup vault.
Type: String
Required: No
** [SourceBackupVaultArn](#API_CreateRestoreAccessBackupVault_RequestSyntax) **
The ARN of the source backup vault containing the recovery points to which temporary access is requested.
Type: String
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"CreationDate": number,
"RestoreAccessBackupVaultArn": "string",
"RestoreAccessBackupVaultName": "string",
"VaultState": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [CreationDate](#API_CreateRestoreAccessBackupVault_ResponseSyntax) **
>The date and time when the restore access backup vault was created, in Unix format and Coordinated Universal Time
Type: Timestamp
** [RestoreAccessBackupVaultArn](#API_CreateRestoreAccessBackupVault_ResponseSyntax) **
The ARN that uniquely identifies the created restore access backup vault.
Type: String
** [RestoreAccessBackupVaultName](#API_CreateRestoreAccessBackupVault_ResponseSyntax) **
The name of the created restore access backup vault.
Type: String
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
** [VaultState](#API_CreateRestoreAccessBackupVault_ResponseSyntax) **
The current state of the restore access backup vault.
Type: String
Valid Values: `CREATING | AVAILABLE | FAILED`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AlreadyExistsException **
The required resource already exists.
** Arn **
** Context **
** CreatorRequestId **
** Type **
HTTP Status Code: 400
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** InvalidRequestException **
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
** Context **
** Type **
HTTP Status Code: 400
** LimitExceededException **
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Creates a restore testing plan.
The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.
## Request Syntax
```
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 Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [CreatorRequestId](#API_CreateRestoreTestingPlan_RequestSyntax) **
This is a unique string that identifies the request and allows failed requests to be retriedwithout the risk of running the operation twice. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-\$1.' characters.
Type: String
Required: No
** [RestoreTestingPlan](#API_CreateRestoreTestingPlan_RequestSyntax) **
A restore testing plan must contain a unique `RestoreTestingPlanName` string you create and must contain a `ScheduleExpression` cron. You may optionally include a `StartWindowHours` integer and a `CreatorRequestId` string.
The `RestoreTestingPlanName` is a unique string that is the name of the restore testing plan. This cannot be changed after creation, and it must consist of only alphanumeric characters and underscores.
Type: [RestoreTestingPlanForCreate](API_RestoreTestingPlanForCreate.md) object
Required: Yes
** [Tags](#API_CreateRestoreTestingPlan_RequestSyntax) **
The tags to assign to the restore testing plan.
Type: String to string map
Required: No
## Response Syntax
```
HTTP/1.1 201
Content-type: application/json
{
"CreationTime": number,
"RestoreTestingPlanArn": "string",
"RestoreTestingPlanName": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
** [CreationTime](#API_CreateRestoreTestingPlan_ResponseSyntax) **
The date and time a restore testing plan was created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.
Type: Timestamp
** [RestoreTestingPlanArn](#API_CreateRestoreTestingPlan_ResponseSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies the created restore testing plan.
Type: String
** [RestoreTestingPlanName](#API_CreateRestoreTestingPlan_ResponseSyntax) **
This unique string is the name of the restore testing plan.
The name cannot be changed after creation. The name consists of only alphanumeric characters and underscores. Maximum length is 50.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AlreadyExistsException **
The required resource already exists.
** Arn **
** Context **
** CreatorRequestId **
** Type **
HTTP Status Code: 400
** ConflictException **
AWS Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
** Context **
** Type **
HTTP Status Code: 400
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** LimitExceededException **
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This request can be sent after CreateRestoreTestingPlan request returns successfully. This is the second part of creating a resource testing plan, and it must be completed sequentially.
This consists of `RestoreTestingSelectionName`, `ProtectedResourceType`, and one of the following:
+ `ProtectedResourceArns`
+ `ProtectedResourceConditions`
Each protected resource type can have one single value.
A restore testing selection can include a wildcard value ("\$1") for `ProtectedResourceArns` along with `ProtectedResourceConditions`. Alternatively, you can include up to 30 specific protected resource ARNs in `ProtectedResourceArns`.
Cannot select by both protected resource types AND specific ARNs. Request will fail if both are included.
## Request Syntax
```
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 Request Parameters
The request uses the following URI parameters.
** [RestoreTestingPlanName](#API_CreateRestoreTestingSelection_RequestSyntax) **
Input the restore testing plan name that was returned from the related CreateRestoreTestingPlan request.
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [CreatorRequestId](#API_CreateRestoreTestingSelection_RequestSyntax) **
This is an optional unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. If used, this parameter must contain 1 to 50 alphanumeric or '-\$1.' characters.
Type: String
Required: No
** [RestoreTestingSelection](#API_CreateRestoreTestingSelection_RequestSyntax) **
This consists of `RestoreTestingSelectionName`, `ProtectedResourceType`, and one of the following:
+ `ProtectedResourceArns`
+ `ProtectedResourceConditions`
Each protected resource type can have one single value.
A restore testing selection can include a wildcard value ("\$1") for `ProtectedResourceArns` along with `ProtectedResourceConditions`. Alternatively, you can include up to 30 specific protected resource ARNs in `ProtectedResourceArns`.
Type: [RestoreTestingSelectionForCreate](API_RestoreTestingSelectionForCreate.md) object
Required: Yes
## Response Syntax
```
HTTP/1.1 201
Content-type: application/json
{
"CreationTime": number,
"RestoreTestingPlanArn": "string",
"RestoreTestingPlanName": "string",
"RestoreTestingSelectionName": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
** [CreationTime](#API_CreateRestoreTestingSelection_ResponseSyntax) **
The time that the resource testing selection was created.
Type: Timestamp
** [RestoreTestingPlanArn](#API_CreateRestoreTestingSelection_ResponseSyntax) **
The ARN of the restore testing plan with which the restore testing selection is associated.
Type: String
** [RestoreTestingPlanName](#API_CreateRestoreTestingSelection_ResponseSyntax) **
The name of the restore testing plan.
The name cannot be changed after creation. The name consists of only alphanumeric characters and underscores. Maximum length is 50.
Type: String
** [RestoreTestingSelectionName](#API_CreateRestoreTestingSelection_ResponseSyntax) **
The name of the restore testing selection for the related restore testing plan.
The name cannot be changed after creation. The name consists of only alphanumeric characters and underscores. Maximum length is 50.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AlreadyExistsException **
The required resource already exists.
** Arn **
** Context **
** CreatorRequestId **
** Type **
HTTP Status Code: 400
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** LimitExceededException **
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Creates a tiering configuration.
A tiering configuration enables automatic movement of backup data to a lower-cost storage tier based on the age of backed-up objects in the backup vault.
Each vault can only have one vault-specific tiering configuration, in addition to any global configuration that applies to all vaults.
## Request Syntax
```
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 Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [CreatorRequestId](#API_CreateTieringConfiguration_RequestSyntax) **
This is a unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-\$1.' characters.
Type: String
Required: No
** [TieringConfiguration](#API_CreateTieringConfiguration_RequestSyntax) **
A tiering configuration must contain a unique `TieringConfigurationName` string you create and must contain a `BackupVaultName` and `ResourceSelection`. You may optionally include a `CreatorRequestId` string.
The `TieringConfigurationName` is a unique string that is the name of the tiering configuration. This cannot be changed after creation, and it must consist of only alphanumeric characters and underscores.
Type: [TieringConfigurationInputForCreate](API_TieringConfigurationInputForCreate.md) object
Required: Yes
** [TieringConfigurationTags](#API_CreateTieringConfiguration_RequestSyntax) **
The tags to assign to the tiering configuration.
Type: String to string map
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"TieringConfigurationArn": "string",
"TieringConfigurationName": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [CreationTime](#API_CreateTieringConfiguration_ResponseSyntax) **
The date and time a tiering configuration was created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.
Type: Timestamp
** [TieringConfigurationArn](#API_CreateTieringConfiguration_ResponseSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies the created tiering configuration.
Type: String
** [TieringConfigurationName](#API_CreateTieringConfiguration_ResponseSyntax) **
This unique string is the name of the tiering configuration.
The name cannot be changed after creation. The name consists of only alphanumeric characters and underscores. Maximum length is 200.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AlreadyExistsException **
The required resource already exists.
** Arn **
** Context **
** CreatorRequestId **
** Type **
HTTP Status Code: 400
** ConflictException **
AWS Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
** Context **
** Type **
HTTP Status Code: 400
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** LimitExceededException **
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Deletes a backup plan. A backup plan can only be deleted after all associated selections of resources have been deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, if any, will still exist.
## Request Syntax
```
DELETE /backup/plans/backupPlanId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupPlanId](#API_DeleteBackupPlan_RequestSyntax) **
Uniquely identifies a backup plan.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"BackupPlanArn": "string",
"BackupPlanId": "string",
"DeletionDate": number,
"VersionId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BackupPlanArn](#API_DeleteBackupPlan_ResponseSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, `arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50`.
Type: String
** [BackupPlanId](#API_DeleteBackupPlan_ResponseSyntax) **
Uniquely identifies a backup plan.
Type: String
** [DeletionDate](#API_DeleteBackupPlan_ResponseSyntax) **
The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of `DeletionDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [VersionId](#API_DeleteBackupPlan_ResponseSyntax) **
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** InvalidRequestException **
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Deletes the resource selection associated with a backup plan that is specified by the `SelectionId`.
## Request Syntax
```
DELETE /backup/plans/backupPlanId/selections/selectionId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupPlanId](#API_DeleteBackupSelection_RequestSyntax) **
Uniquely identifies a backup plan.
Required: Yes
** [selectionId](#API_DeleteBackupSelection_RequestSyntax) **
Uniquely identifies the body of a request to assign a set of resources to a backup plan.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.
## Request Syntax
```
DELETE /backup-vaults/backupVaultName HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupVaultName](#API_DeleteBackupVault_RequestSyntax) **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** InvalidRequestException **
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Deletes the policy document that manages permissions on a backup vault.
## Request Syntax
```
DELETE /backup-vaults/backupVaultName/access-policy HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupVaultName](#API_DeleteBackupVaultAccessPolicy_RequestSyntax) **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Deletes AWS Backup Vault Lock from a backup vault specified by a backup vault name.
If the Vault Lock configuration is immutable, then you cannot delete Vault Lock using API operations, and you will receive an `InvalidRequestException` if you attempt to do so. For more information, see [Vault Lock](https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html) in the * AWS Backup Developer Guide*.
## Request Syntax
```
DELETE /backup-vaults/backupVaultName/vault-lock HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupVaultName](#API_DeleteBackupVaultLockConfiguration_RequestSyntax) **
The name of the backup vault from which to delete AWS Backup Vault Lock.
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** InvalidRequestException **
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Deletes event notifications for the specified backup vault.
## Request Syntax
```
DELETE /backup-vaults/backupVaultName/notification-configuration HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupVaultName](#API_DeleteBackupVaultNotifications_RequestSyntax) **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Deletes the framework specified by a framework name.
## Request Syntax
```
DELETE /audit/frameworks/frameworkName HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [frameworkName](#API_DeleteFramework_RequestSyntax) **
The unique name of a framework.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z][_a-zA-Z0-9]*`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
AWS Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
** Context **
** Type **
HTTP Status Code: 400
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Deletes the recovery point specified by a recovery point ID.
If the recovery point ID belongs to a continuous backup, calling this endpoint deletes the existing continuous backup and stops future continuous backup.
When an IAM role's permissions are insufficient to call this API, the service sends back an HTTP 200 response with an empty HTTP body, but the recovery point is not deleted. Instead, it enters an `EXPIRED` state.
`EXPIRED` recovery points can be deleted with this API once the IAM role has the `iam:CreateServiceLinkedRole` action. To learn more about adding this role, see [ Troubleshooting manual deletions](https://docs.aws.amazon.com/aws-backup/latest/devguide/deleting-backups.html#deleting-backups-troubleshooting).
If the user or role is deleted or the permission within the role is removed, the deletion will not be successful and will enter an `EXPIRED` state.
## Request Syntax
```
DELETE /backup-vaults/backupVaultName/recovery-points/recoveryPointArn HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupVaultName](#API_DeleteRecoveryPoint_RequestSyntax) **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
** [recoveryPointArn](#API_DeleteRecoveryPoint_RequestSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** InvalidRequestException **
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
** Context **
** Type **
HTTP Status Code: 400
** InvalidResourceStateException **
AWS Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Deletes the report plan specified by a report plan name.
## Request Syntax
```
DELETE /audit/report-plans/reportPlanName HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [reportPlanName](#API_DeleteReportPlan_RequestSyntax) **
The unique name of a report plan.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z][_a-zA-Z0-9]*`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
AWS Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
** Context **
** Type **
HTTP Status Code: 400
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This request deletes the specified restore testing plan.
Deletion can only successfully occur if all associated restore testing selections are deleted first.
## Request Syntax
```
DELETE /restore-testing/plans/RestoreTestingPlanName HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [RestoreTestingPlanName](#API_DeleteRestoreTestingPlan_RequestSyntax) **
Required unique name of the restore testing plan you wish to delete.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 204
```
## Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidRequestException **
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Input the Restore Testing Plan name and Restore Testing Selection name.
All testing selections associated with a restore testing plan must be deleted before the restore testing plan can be deleted.
## Request Syntax
```
DELETE /restore-testing/plans/RestoreTestingPlanName/selections/RestoreTestingSelectionName HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [RestoreTestingPlanName](#API_DeleteRestoreTestingSelection_RequestSyntax) **
Required unique name of the restore testing plan that contains the restore testing selection you wish to delete.
Required: Yes
** [RestoreTestingSelectionName](#API_DeleteRestoreTestingSelection_RequestSyntax) **
Required unique name of the restore testing selection you wish to delete.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 204
```
## Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Deletes the tiering configuration specified by a tiering configuration name.
## Request Syntax
```
DELETE /tiering-configurations/tieringConfigurationName HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [tieringConfigurationName](#API_DeleteTieringConfiguration_RequestSyntax) **
The unique name of a tiering configuration.
Pattern: `^[a-zA-Z0-9_]{1,200}$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns backup job details for the specified `BackupJobId`.
## Request Syntax
```
GET /backup-jobs/backupJobId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupJobId](#API_DescribeBackupJob_RequestSyntax) **
Uniquely identifies a request to AWS Backup to back up a resource.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [AccountId](#API_DescribeBackupJob_ResponseSyntax) **
Returns the account ID that owns the backup job.
Type: String
Pattern: `^[0-9]{12}$`
** [BackupJobId](#API_DescribeBackupJob_ResponseSyntax) **
Uniquely identifies a request to AWS Backup to back up a resource.
Type: String
** [BackupOptions](#API_DescribeBackupJob_ResponseSyntax) **
Represents the options specified as part of backup plan or on-demand backup job.
Type: String to string map
Key Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Value Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
** [BackupSizeInBytes](#API_DescribeBackupJob_ResponseSyntax) **
The size, in bytes, of a backup (recovery point).
This value can render differently depending on the resource type as AWS Backup pulls in data information from other AWS services. For example, the value returned may show a value of `0`, which may differ from the anticipated value.
The expected behavior for values by resource type are described as follows:
+ Amazon Aurora, Amazon DocumentDB, and Amazon Neptune do not have this value populate from the operation `GetBackupJobStatus`.
+ For Amazon DynamoDB with advanced features, this value refers to the size of the recovery point (backup).
+ Amazon EC2 and Amazon EBS show volume size (provisioned storage) returned as part of this value. Amazon EBS does not return backup size information; snapshot size will have the same value as the original resource that was backed up.
+ For Amazon EFS, this value refers to the delta bytes transferred during a backup.
+ For Amazon EKS, this value refers to the size of your nested EKS recovery point.
+ Amazon FSx does not populate this value from the operation `GetBackupJobStatus` for FSx file systems.
+ An Amazon RDS instance will show as `0`.
+ For virtual machines running VMware, this value is passed to AWS Backup through an asynchronous workflow, which can mean this displayed value can under-represent the actual backup size.
Type: Long
** [BackupType](#API_DescribeBackupJob_ResponseSyntax) **
Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow Copy Service (VSS) backup was taken, `BackupType` returns `"WindowsVSS"`. If `BackupType` is empty, then the backup type was a regular backup.
Type: String
** [BackupVaultArn](#API_DescribeBackupJob_ResponseSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
Type: String
** [BackupVaultName](#API_DescribeBackupJob_ResponseSyntax) **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
Type: String
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
** [BytesTransferred](#API_DescribeBackupJob_ResponseSyntax) **
The size in bytes transferred to a backup vault at the time that the job status was queried.
Type: Long
** [ChildJobsInState](#API_DescribeBackupJob_ResponseSyntax) **
This returns the statistics of the included child (nested) backup jobs.
Type: String to long map
Valid Keys: `CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL`
** [CompletionDate](#API_DescribeBackupJob_ResponseSyntax) **
The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of `CompletionDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [CreatedBy](#API_DescribeBackupJob_ResponseSyntax) **
Contains identifying information about the creation of a backup job, including the `BackupPlanArn`, `BackupPlanId`, `BackupPlanVersion`, and `BackupRuleId` of the backup plan that is used to create it.
Type: [RecoveryPointCreator](API_RecoveryPointCreator.md) object
** [CreationDate](#API_DescribeBackupJob_ResponseSyntax) **
The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [EncryptionKeyArn](#API_DescribeBackupJob_ResponseSyntax) **
The Amazon Resource Name (ARN) of the KMS key used to encrypt the backup. This can be a customer-managed key or an AWS managed key, depending on the vault configuration.
Type: String
** [ExpectedCompletionDate](#API_DescribeBackupJob_ResponseSyntax) **
The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of `ExpectedCompletionDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [IamRoleArn](#API_DescribeBackupJob_ResponseSyntax) **
Specifies the IAM role ARN used to create the target recovery point; for example, `arn:aws:iam::123456789012:role/S3Access`.
Type: String
** [InitiationDate](#API_DescribeBackupJob_ResponseSyntax) **
The date a backup job was initiated.
Type: Timestamp
** [IsEncrypted](#API_DescribeBackupJob_ResponseSyntax) **
A boolean value indicating whether the backup is encrypted. All backups in AWS Backup are encrypted, but this field indicates the encryption status for transparency.
Type: Boolean
** [IsParent](#API_DescribeBackupJob_ResponseSyntax) **
This returns the boolean value that a backup job is a parent (composite) job.
Type: Boolean
** [MessageCategory](#API_DescribeBackupJob_ResponseSyntax) **
The job count for the specified message category.
Example strings may include `AccessDenied`, `SUCCESS`, `AGGREGATE_ALL`, and `INVALIDPARAMETERS`. View [Monitoring](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html) for a list of accepted MessageCategory strings.
Type: String
** [NumberOfChildJobs](#API_DescribeBackupJob_ResponseSyntax) **
This returns the number of child (nested) backup jobs.
Type: Long
** [ParentJobId](#API_DescribeBackupJob_ResponseSyntax) **
This returns the parent (composite) resource backup job ID.
Type: String
** [PercentDone](#API_DescribeBackupJob_ResponseSyntax) **
Contains an estimated percentage that is complete of a job at the time the job status was queried.
Type: String
** [RecoveryPointArn](#API_DescribeBackupJob_ResponseSyntax) **
An ARN that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Type: String
** [RecoveryPointLifecycle](#API_DescribeBackupJob_ResponseSyntax) **
Specifies the time period, in days, before a recovery point transitions to cold storage or is deleted.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the retention setting must be 90 days greater than the transition to cold after days setting. The transition to cold after days setting can't be changed after a backup has been transitioned to cold.
Resource types that can transition to cold storage are listed in the [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.
To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, specify -1 for `MoveToColdStorageAfterDays` and `DeleteAfterDays`.
Type: [Lifecycle](API_Lifecycle.md) object
** [ResourceArn](#API_DescribeBackupJob_ResponseSyntax) **
An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
Type: String
** [ResourceName](#API_DescribeBackupJob_ResponseSyntax) **
The non-unique name of the resource that belongs to the specified backup.
Type: String
** [ResourceType](#API_DescribeBackupJob_ResponseSyntax) **
The type of AWS resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
Type: String
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
** [StartBy](#API_DescribeBackupJob_ResponseSyntax) **
Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the `StartBy` time would be 8:00 PM on the date specified. The value of `StartBy` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [State](#API_DescribeBackupJob_ResponseSyntax) **
The current state of a backup job.
Type: String
Valid Values: `CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL`
** [StatusMessage](#API_DescribeBackupJob_ResponseSyntax) **
A detailed message explaining the status of the job to back up a resource.
Type: String
** [VaultLockState](#API_DescribeBackupJob_ResponseSyntax) **
The lock state of the backup vault. For logically air-gapped vaults, this indicates whether the vault is locked in compliance mode. Valid values include `LOCKED` and `UNLOCKED`.
Type: String
** [VaultType](#API_DescribeBackupJob_ResponseSyntax) **
The type of backup vault where the recovery point is stored. Valid values are `BACKUP_VAULT` for standard backup vaults and `LOGICALLY_AIR_GAPPED_BACKUP_VAULT` for logically air-gapped vaults.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** DependencyFailureException **
A dependent AWS service or resource returned an error to the AWS Backup service, and the action cannot be completed.
** Context **
** Type **
HTTP Status Code: 500
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns metadata about a backup vault specified by its name.
## Request Syntax
```
GET /backup-vaults/backupVaultName?backupVaultAccountId=BackupVaultAccountId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [BackupVaultAccountId](#API_DescribeBackupVault_RequestSyntax) **
The account ID of the specified backup vault.
** [backupVaultName](#API_DescribeBackupVault_RequestSyntax) **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BackupVaultArn](#API_DescribeBackupVault_ResponseSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
Type: String
** [BackupVaultName](#API_DescribeBackupVault_ResponseSyntax) **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
Type: String
** [CreationDate](#API_DescribeBackupVault_ResponseSyntax) **
The date and time that a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [CreatorRequestId](#API_DescribeBackupVault_ResponseSyntax) **
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-\$1.' characters.
Type: String
** [EncryptionKeyArn](#API_DescribeBackupVault_ResponseSyntax) **
The server-side encryption key that is used to protect your backups; for example, `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
Type: String
** [EncryptionKeyType](#API_DescribeBackupVault_ResponseSyntax) **
The type of encryption key used for the backup vault. Valid values are CUSTOMER\$1MANAGED\$1KMS\$1KEY for customer-managed keys or AWS\$1OWNED\$1KMS\$1KEY for AWS-owned keys.
Type: String
Valid Values: `AWS_OWNED_KMS_KEY | CUSTOMER_MANAGED_KMS_KEY`
** [LatestMpaApprovalTeamUpdate](#API_DescribeBackupVault_ResponseSyntax) **
Information about the latest update to the MPA approval team association for this backup vault.
Type: [LatestMpaApprovalTeamUpdate](API_LatestMpaApprovalTeamUpdate.md) object
** [LockDate](#API_DescribeBackupVault_ResponseSyntax) **
The date and time when AWS Backup Vault Lock configuration cannot be changed or deleted.
If you applied Vault Lock to your vault without specifying a lock date, you can change any of your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.
This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [Locked](#API_DescribeBackupVault_ResponseSyntax) **
A Boolean that indicates whether AWS Backup Vault Lock is currently protecting the backup vault. `True` means that Vault Lock causes delete or update operations on the recovery points stored in the vault to fail.
Type: Boolean
** [MaxRetentionDays](#API_DescribeBackupVault_ResponseSyntax) **
The AWS Backup Vault Lock setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).
If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.
Type: Long
** [MinRetentionDays](#API_DescribeBackupVault_ResponseSyntax) **
The AWS Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock will not enforce a minimum retention period.
If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.
Type: Long
** [MpaApprovalTeamArn](#API_DescribeBackupVault_ResponseSyntax) **
The ARN of the MPA approval team associated with this backup vault.
Type: String
** [MpaSessionArn](#API_DescribeBackupVault_ResponseSyntax) **
The ARN of the MPA session associated with this backup vault.
Type: String
** [NumberOfRecoveryPoints](#API_DescribeBackupVault_ResponseSyntax) **
The number of recovery points that are stored in a backup vault.
Recovery point count value displayed in the console can be an approximation. Use [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 to obtain the exact count.
Type: Long
** [SourceBackupVaultArn](#API_DescribeBackupVault_ResponseSyntax) **
The ARN of the source backup vault from which this restore access backup vault was created.
Type: String
** [VaultState](#API_DescribeBackupVault_ResponseSyntax) **
The current state of the vault.->
Type: String
Valid Values: `CREATING | AVAILABLE | FAILED`
** [VaultType](#API_DescribeBackupVault_ResponseSyntax) **
The type of vault described.
Type: String
Valid Values: `BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT | RESTORE_ACCESS_BACKUP_VAULT`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns metadata associated with creating a copy of a resource.
## Request Syntax
```
GET /copy-jobs/copyJobId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [copyJobId](#API_DescribeCopyJob_RequestSyntax) **
Uniquely identifies a copy job.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [CopyJob](#API_DescribeCopyJob_ResponseSyntax) **
Contains detailed information about a copy job.
Type: [CopyJob](API_CopyJob.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns the framework details for the specified `FrameworkName`.
## Request Syntax
```
GET /audit/frameworks/frameworkName HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [frameworkName](#API_DescribeFramework_RequestSyntax) **
The unique name of a framework.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z][_a-zA-Z0-9]*`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [CreationTime](#API_DescribeFramework_ResponseSyntax) **
The date and time that a framework is created, in ISO 8601 representation. The value of `CreationTime` is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.
Type: Timestamp
** [DeploymentStatus](#API_DescribeFramework_ResponseSyntax) **
The deployment status of a framework. The statuses are:
`CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED`
Type: String
** [FrameworkArn](#API_DescribeFramework_ResponseSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
Type: String
** [FrameworkControls](#API_DescribeFramework_ResponseSyntax) **
The controls that make up the framework. Each control in the list has a name, input parameters, and scope.
Type: Array of [FrameworkControl](API_FrameworkControl.md) objects
** [FrameworkDescription](#API_DescribeFramework_ResponseSyntax) **
An optional description of the framework.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: `.*\S.*`
** [FrameworkName](#API_DescribeFramework_ResponseSyntax) **
The unique name of a framework.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z][_a-zA-Z0-9]*`
** [FrameworkStatus](#API_DescribeFramework_ResponseSyntax) **
A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn AWS Config recording on or off for each resource. The statuses are:
+ `ACTIVE` when recording is turned on for all resources governed by the framework.
+ `PARTIALLY_ACTIVE` when recording is turned off for at least one resource governed by the framework.
+ `INACTIVE` when recording is turned off for all resources governed by the framework.
+ `UNAVAILABLE` when AWS Backup is unable to validate recording status at this time.
Type: String
** [IdempotencyToken](#API_DescribeFramework_ResponseSyntax) **
A customer-chosen string that you can use to distinguish between otherwise identical calls to `DescribeFrameworkOutput`. Retrying a successful request with the same idempotency token results in a success message with no action taken.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Describes whether the AWS account has enabled different cross-account management options, including cross-account backup, multi-party approval, and delegated administrator. Returns an error if the account is not a member of an Organizations organization. Example: `describe-global-settings --region us-west-2`
## Request Syntax
```
GET /global-settings HTTP/1.1
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"GlobalSettings": {
"string" : "string"
},
"LastUpdateTime": number
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [GlobalSettings](#API_DescribeGlobalSettings_ResponseSyntax) **
The status of the flags `isCrossAccountBackupEnabled`, `isMpaEnabled` ('Mpa' refers to multi-party approval), and `isDelegatedAdministratorEnabled`.
+ `isCrossAccountBackupEnabled`: Allow accounts in your organization to copy backups to other accounts.
+ `isMpaEnabled`: Add cross-account access to your organization with the option to assign a Multi-party approval team to a logically air-gapped vault.
+ `isDelegatedAdministratorEnabled`: Allow Backup to automatically synchronize delegated administrator permissions with Organizations.
Type: String to string map
** [LastUpdateTime](#API_DescribeGlobalSettings_ResponseSyntax) **
The date and time that the supported flags were last updated. This update is in Unix format and Coordinated Universal Time (UTC). The value of `LastUpdateTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidRequestException **
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the AWS service type of the saved resource.
## Request Syntax
```
GET /resources/resourceArn HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [resourceArn](#API_DescribeProtectedResource_RequestSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [LastBackupTime](#API_DescribeProtectedResource_ResponseSyntax) **
The date and time that a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of `LastBackupTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [LastBackupVaultArn](#API_DescribeProtectedResource_ResponseSyntax) **
The ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point.
Type: String
** [LastRecoveryPointArn](#API_DescribeProtectedResource_ResponseSyntax) **
The ARN (Amazon Resource Name) of the most recent recovery point.
Type: String
** [LatestRestoreExecutionTimeMinutes](#API_DescribeProtectedResource_ResponseSyntax) **
The time, in minutes, that the most recent restore job took to complete.
Type: Long
** [LatestRestoreJobCreationDate](#API_DescribeProtectedResource_ResponseSyntax) **
The creation date of the most recent restore job.
Type: Timestamp
** [LatestRestoreRecoveryPointCreationDate](#API_DescribeProtectedResource_ResponseSyntax) **
The date the most recent recovery point was created.
Type: Timestamp
** [ResourceArn](#API_DescribeProtectedResource_ResponseSyntax) **
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
Type: String
** [ResourceName](#API_DescribeProtectedResource_ResponseSyntax) **
The name of the resource that belongs to the specified backup.
Type: String
** [ResourceType](#API_DescribeProtectedResource_ResponseSyntax) **
The type of AWS resource saved as a recovery point; for example, an Amazon EBS volume or an Amazon RDS database.
Type: String
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
## Request Syntax
```
GET /backup-vaults/backupVaultName/recovery-points/recoveryPointArn?backupVaultAccountId=BackupVaultAccountId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [BackupVaultAccountId](#API_DescribeRecoveryPoint_RequestSyntax) **
The account ID of the specified backup vault.
Pattern: `^[0-9]{12}$`
** [backupVaultName](#API_DescribeRecoveryPoint_RequestSyntax) **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
** [recoveryPointArn](#API_DescribeRecoveryPoint_RequestSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BackupSizeInBytes](#API_DescribeRecoveryPoint_ResponseSyntax) **
The size, in bytes, of a backup.
Type: Long
** [BackupVaultArn](#API_DescribeRecoveryPoint_ResponseSyntax) **
An ARN that uniquely identifies a backup vault; for example, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
Type: String
** [BackupVaultName](#API_DescribeRecoveryPoint_ResponseSyntax) **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
Type: String
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
** [CalculatedLifecycle](#API_DescribeRecoveryPoint_ResponseSyntax) **
A `CalculatedLifecycle` object containing `DeleteAt` and `MoveToColdStorageAt` timestamps.
Type: [CalculatedLifecycle](API_CalculatedLifecycle.md) object
** [CompletionDate](#API_DescribeRecoveryPoint_ResponseSyntax) **
The date and time that a job to create a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of `CompletionDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [CompositeMemberIdentifier](#API_DescribeRecoveryPoint_ResponseSyntax) **
The identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the [ logical ID](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax) within a stack.
Type: String
** [CreatedBy](#API_DescribeRecoveryPoint_ResponseSyntax) **
Contains identifying information about the creation of a recovery point, including the `BackupPlanArn`, `BackupPlanId`, `BackupPlanVersion`, and `BackupRuleId` of the backup plan used to create it.
Type: [RecoveryPointCreator](API_RecoveryPointCreator.md) object
** [CreationDate](#API_DescribeRecoveryPoint_ResponseSyntax) **
The date and time that a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [EncryptionKeyArn](#API_DescribeRecoveryPoint_ResponseSyntax) **
The server-side encryption key used to protect your backups; for example, `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
Type: String
** [EncryptionKeyType](#API_DescribeRecoveryPoint_ResponseSyntax) **
The type of encryption key used for the recovery point. Valid values are CUSTOMER\$1MANAGED\$1KMS\$1KEY for customer-managed keys or AWS\$1OWNED\$1KMS\$1KEY for AWS-owned keys.
Type: String
Valid Values: `AWS_OWNED_KMS_KEY | CUSTOMER_MANAGED_KMS_KEY`
** [IamRoleArn](#API_DescribeRecoveryPoint_ResponseSyntax) **
Specifies the IAM role ARN used to create the target recovery point; for example, `arn:aws:iam::123456789012:role/S3Access`.
Type: String
** [IndexStatus](#API_DescribeRecoveryPoint_ResponseSyntax) **
This is the current status for the backup index associated with the specified recovery point.
Statuses are: `PENDING` \$1 `ACTIVE` \$1 `FAILED` \$1 `DELETING`
A recovery point with an index that has the status of `ACTIVE` can be included in a search.
Type: String
Valid Values: `PENDING | ACTIVE | FAILED | DELETING`
** [IndexStatusMessage](#API_DescribeRecoveryPoint_ResponseSyntax) **
A string in the form of a detailed message explaining the status of a backup index associated with the recovery point.
Type: String
** [InitiationDate](#API_DescribeRecoveryPoint_ResponseSyntax) **
The date and time when the backup job that created this recovery point was initiated, in Unix format and Coordinated Universal Time (UTC).
Type: Timestamp
** [IsEncrypted](#API_DescribeRecoveryPoint_ResponseSyntax) **
A Boolean value that is returned as `TRUE` if the specified recovery point is encrypted, or `FALSE` if the recovery point is not encrypted.
Type: Boolean
** [IsParent](#API_DescribeRecoveryPoint_ResponseSyntax) **
This returns the boolean value that a recovery point is a parent (composite) job.
Type: Boolean
** [LastRestoreTime](#API_DescribeRecoveryPoint_ResponseSyntax) **
The date and time that a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of `LastRestoreTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [Lifecycle](#API_DescribeRecoveryPoint_ResponseSyntax) **
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.
Backups that are transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that can transition to cold storage are listed in the [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.
Type: [Lifecycle](API_Lifecycle.md) object
** [ParentRecoveryPointArn](#API_DescribeRecoveryPoint_ResponseSyntax) **
This is an ARN that uniquely identifies a parent (composite) recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Type: String
** [RecoveryPointArn](#API_DescribeRecoveryPoint_ResponseSyntax) **
An ARN that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Type: String
** [ResourceArn](#API_DescribeRecoveryPoint_ResponseSyntax) **
An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
Type: String
** [ResourceName](#API_DescribeRecoveryPoint_ResponseSyntax) **
The name of the resource that belongs to the specified backup.
Type: String
** [ResourceType](#API_DescribeRecoveryPoint_ResponseSyntax) **
The type of AWS resource to save as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
Type: String
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
** [ScanResults](#API_DescribeRecoveryPoint_ResponseSyntax) **
Contains the latest scanning results against the recovery point and currently include `MalwareScanner`, `ScanJobState`, `Findings`, and `LastScanTimestamp`
Type: Array of [ScanResult](API_ScanResult.md) objects
Array Members: Minimum number of 0 items. Maximum number of 5 items.
** [SourceBackupVaultArn](#API_DescribeRecoveryPoint_ResponseSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies the source vault where the resource was originally backed up in; for example, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`. If the recovery is restored to the same AWS account or Region, this value will be `null`.
Type: String
** [Status](#API_DescribeRecoveryPoint_ResponseSyntax) **
A status code specifying the state of the recovery point. For more information, see [ Recovery point status](https://docs.aws.amazon.com/aws-backup/latest/devguide/applicationstackbackups.html#cfnrecoverypointstatus) in the * AWS Backup Developer Guide*.
+ `CREATING` status indicates that an AWS Backup job has been initiated for a resource. The backup process has started and is actively processing a backup job for the associated recovery point.
+ `AVAILABLE` status indicates that the backup was successfully created for the recovery point. The backup process has completed without any issues, and the recovery point is now ready for use.
+ `PARTIAL` status indicates a composite recovery point has one or more nested recovery points that were not in the backup.
+ `EXPIRED` status indicates that the recovery point has exceeded its retention period, but AWS Backup lacks permission or is otherwise unable to delete it. To manually delete these recovery points, see [ Step 3: Delete the recovery points](https://docs.aws.amazon.com/aws-backup/latest/devguide/gs-cleanup-resources.html#cleanup-backups) in the *Clean up resources* section of *Getting started*.
+ `STOPPED` status occurs on a continuous backup where a user has taken some action that causes the continuous backup to be disabled. This can be caused by the removal of permissions, turning off versioning, turning off events being sent to EventBridge, or disabling the EventBridge rules that are put in place by AWS Backup. For recovery points of Amazon S3, Amazon RDS, and Amazon Aurora resources, this status occurs when the retention period of a continuous backup rule is changed.
To resolve `STOPPED` status, ensure that all requested permissions are in place and that versioning is enabled on the S3 bucket. Once these conditions are met, the next instance of a backup rule running will result in a new continuous recovery point being created. The recovery points with STOPPED status do not need to be deleted.
For SAP HANA on Amazon EC2 `STOPPED` status occurs due to user action, application misconfiguration, or backup failure. To ensure that future continuous backups succeed, refer to the recovery point status and check SAP HANA for details.
Type: String
Valid Values: `COMPLETED | PARTIAL | DELETING | EXPIRED | AVAILABLE | STOPPED | CREATING`
** [StatusMessage](#API_DescribeRecoveryPoint_ResponseSyntax) **
A status message explaining the status of the recovery point.
Type: String
** [StorageClass](#API_DescribeRecoveryPoint_ResponseSyntax) **
Specifies the storage class of the recovery point. Valid values are `WARM` or `COLD`.
Type: String
Valid Values: `WARM | COLD | DELETED`
** [VaultType](#API_DescribeRecoveryPoint_ResponseSyntax) **
The type of vault in which the described recovery point is stored.
Type: String
Valid Values: `BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT | RESTORE_ACCESS_BACKUP_VAULT`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns the current service opt-in settings for the Region. If service opt-in is enabled for a service, AWS Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, AWS Backup does not try to protect that service's resources in this Region.
## Request Syntax
```
GET /account-settings HTTP/1.1
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"ResourceTypeManagementPreference": {
"string" : boolean
},
"ResourceTypeOptInPreference": {
"string" : boolean
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ResourceTypeManagementPreference](#API_DescribeRegionSettings_ResponseSyntax) **
Returns whether AWS Backup fully manages the backups for a resource type.
For the benefits of full AWS Backup management, see [Full AWS Backup management](https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#full-management).
For a list of resource types and whether each supports full AWS Backup management, see the [Feature availability by resource](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource) table.
If `"DynamoDB":false`, you can enable full AWS Backup management for DynamoDB backup by enabling [AWS Backup's advanced DynamoDB backup features](https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html#advanced-ddb-backup-enable-cli).
Type: String to boolean map
Key Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
** [ResourceTypeOptInPreference](#API_DescribeRegionSettings_ResponseSyntax) **
The services along with the opt-in preferences in the Region.
Type: String to boolean map
Key Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns the details associated with creating a report as specified by its `ReportJobId`.
## Request Syntax
```
GET /audit/report-jobs/reportJobId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [reportJobId](#API_DescribeReportJob_RequestSyntax) **
The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. The report job ID cannot be edited.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ReportJob](#API_DescribeReportJob_ResponseSyntax) **
The information about a report job, including its completion and creation times, report destination, unique report job ID, Amazon Resource Name (ARN), report template, status, and status message.
Type: [ReportJob](API_ReportJob.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns a list of all report plans for an AWS account and AWS Region.
## Request Syntax
```
GET /audit/report-plans/reportPlanName HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [reportPlanName](#API_DescribeReportPlan_RequestSyntax) **
The unique name of a report plan.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z][_a-zA-Z0-9]*`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ReportPlan](#API_DescribeReportPlan_ResponseSyntax) **
Returns details about the report plan that is specified by its name. These details include the report plan's Amazon Resource Name (ARN), description, settings, delivery channel, deployment status, creation time, and last attempted and successful run times.
Type: [ReportPlan](API_ReportPlan.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns metadata associated with a restore job that is specified by a job ID.
## Request Syntax
```
GET /restore-jobs/restoreJobId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [restoreJobId](#API_DescribeRestoreJob_RequestSyntax) **
Uniquely identifies the job that restores a recovery point.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [AccountId](#API_DescribeRestoreJob_ResponseSyntax) **
Returns the account ID that owns the restore job.
Type: String
Pattern: `^[0-9]{12}$`
** [BackupSizeInBytes](#API_DescribeRestoreJob_ResponseSyntax) **
The size, in bytes, of the restored resource.
Type: Long
** [BackupVaultArn](#API_DescribeRestoreJob_ResponseSyntax) **
The Amazon Resource Name (ARN) of the backup vault containing the recovery point being restored. This helps identify vault access policies and permissions.
Type: String
** [CompletionDate](#API_DescribeRestoreJob_ResponseSyntax) **
The date and time that a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of `CompletionDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [CreatedBy](#API_DescribeRestoreJob_ResponseSyntax) **
Contains identifying information about the creation of a restore job.
Type: [RestoreJobCreator](API_RestoreJobCreator.md) object
** [CreatedResourceArn](#API_DescribeRestoreJob_ResponseSyntax) **
The Amazon Resource Name (ARN) of the resource that was created by the restore job.
The format of the ARN depends on the resource type of the backed-up resource.
Type: String
** [CreationDate](#API_DescribeRestoreJob_ResponseSyntax) **
The date and time that a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [DeletionStatus](#API_DescribeRestoreJob_ResponseSyntax) **
The status of the data generated by the restore test.
Type: String
Valid Values: `DELETING | FAILED | SUCCESSFUL`
** [DeletionStatusMessage](#API_DescribeRestoreJob_ResponseSyntax) **
This describes the restore job deletion status.
Type: String
** [ExpectedCompletionTimeMinutes](#API_DescribeRestoreJob_ResponseSyntax) **
The amount of time in minutes that a job restoring a recovery point is expected to take.
Type: Long
** [IamRoleArn](#API_DescribeRestoreJob_ResponseSyntax) **
Specifies the IAM role ARN used to create the target recovery point; for example, `arn:aws:iam::123456789012:role/S3Access`.
Type: String
** [IsParent](#API_DescribeRestoreJob_ResponseSyntax) **
This is a boolean value indicating whether the restore job is a parent (composite) restore job.
Type: Boolean
** [ParentJobId](#API_DescribeRestoreJob_ResponseSyntax) **
This is the unique identifier of the parent restore job for the selected restore job.
Type: String
** [PercentDone](#API_DescribeRestoreJob_ResponseSyntax) **
Contains an estimated percentage that is complete of a job at the time the job status was queried.
Type: String
** [RecoveryPointArn](#API_DescribeRestoreJob_ResponseSyntax) **
An ARN that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Type: String
** [RecoveryPointCreationDate](#API_DescribeRestoreJob_ResponseSyntax) **
The creation date of the recovery point made by the specifed restore job.
Type: Timestamp
** [ResourceType](#API_DescribeRestoreJob_ResponseSyntax) **
Returns metadata associated with a restore job listed by resource type.
Type: String
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
** [RestoreJobId](#API_DescribeRestoreJob_ResponseSyntax) **
Uniquely identifies the job that restores a recovery point.
Type: String
** [SourceResourceArn](#API_DescribeRestoreJob_ResponseSyntax) **
The Amazon Resource Name (ARN) of the original resource that was backed up. This provides context about what resource is being restored.
Type: String
** [Status](#API_DescribeRestoreJob_ResponseSyntax) **
Status code specifying the state of the job that is initiated by AWS Backup to restore a recovery point.
Type: String
Valid Values: `PENDING | RUNNING | COMPLETED | ABORTED | FAILED`
** [StatusMessage](#API_DescribeRestoreJob_ResponseSyntax) **
A message showing the status of a job to restore a recovery point.
Type: String
** [ValidationStatus](#API_DescribeRestoreJob_ResponseSyntax) **
The status of validation run on the indicated restore job.
Type: String
Valid Values: `FAILED | SUCCESSFUL | TIMED_OUT | VALIDATING`
** [ValidationStatusMessage](#API_DescribeRestoreJob_ResponseSyntax) **
The status message.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** DependencyFailureException **
A dependent AWS service or resource returned an error to the AWS Backup service, and the action cannot be completed.
** Context **
** Type **
HTTP Status Code: 500
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns scan job details for the specified ScanJobID.
## Request Syntax
```
GET /scan/jobs/ScanJobId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [ScanJobId](#API_DescribeScanJob_RequestSyntax) **
Uniquely identifies a request to AWS Backup to scan a resource.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [AccountId](#API_DescribeScanJob_ResponseSyntax) **
Returns the account ID that owns the scan job.
Pattern: `^[0-9]{12}$`
Type: String
** [BackupVaultArn](#API_DescribeScanJob_ResponseSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`
Type: String
** [BackupVaultName](#API_DescribeScanJob_ResponseSyntax) **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
Pattern: `^[a-zA-Z0-9\-\_\.]{2,50}$`
Type: String
** [CompletionDate](#API_DescribeScanJob_ResponseSyntax) **
The date and time that a backup index finished creation, in Unix format and Coordinated Universal Time (UTC). The value of `CompletionDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [CreatedBy](#API_DescribeScanJob_ResponseSyntax) **
Contains identifying information about the creation of a scan job, including the backup plan and rule that initiated the scan.
Type: [ScanJobCreator](API_ScanJobCreator.md) object
** [CreationDate](#API_DescribeScanJob_ResponseSyntax) **
The date and time that a backup index finished creation, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [IamRoleArn](#API_DescribeScanJob_ResponseSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, `arn:aws:iam::123456789012:role/S3Access`.
Type: String
** [MalwareScanner](#API_DescribeScanJob_ResponseSyntax) **
The scanning engine used for the corresponding scan job. Currently only `GUARDUTY` is supported.
Type: String
Valid Values: `GUARDDUTY`
** [RecoveryPointArn](#API_DescribeScanJob_ResponseSyntax) **
An ARN that uniquely identifies the target recovery point for scanning.; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Type: String
** [ResourceArn](#API_DescribeScanJob_ResponseSyntax) **
An ARN that uniquely identifies the source resource of the corresponding recovery point ARN.
Type: String
** [ResourceName](#API_DescribeScanJob_ResponseSyntax) **
The non-unique name of the resource that belongs to the specified backup.
Type: String
** [ResourceType](#API_DescribeScanJob_ResponseSyntax) **
The type of AWS Resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume.
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Type: String
Valid Values: `EBS | EC2 | S3`
** [ScanBaseRecoveryPointArn](#API_DescribeScanJob_ResponseSyntax) **
An ARN that uniquely identifies the base recovery point for scanning. This field will only be populated when an incremental scan job has taken place.
Type: String
** [ScanId](#API_DescribeScanJob_ResponseSyntax) **
The scan ID generated by Amazon GuardDuty for the corresponding Scan Job ID request from AWS Backup.
Type: String
** [ScanJobId](#API_DescribeScanJob_ResponseSyntax) **
The scan job ID that uniquely identified the request to AWS Backup.
Type: String
** [ScanMode](#API_DescribeScanJob_ResponseSyntax) **
Specifies the scan type used for the scan job.
Type: String
Valid Values: `FULL_SCAN | INCREMENTAL_SCAN`
** [ScannerRoleArn](#API_DescribeScanJob_ResponseSyntax) **
Specifies the scanner IAM role ARN used to for the scan job.
Type: String
** [ScanResult](#API_DescribeScanJob_ResponseSyntax) **
Contains the `ScanResultsStatus` for the scanning job and returns `THREATS_FOUND` or `NO_THREATS_FOUND` for completed jobs.
Type: [ScanResultInfo](API_ScanResultInfo.md) object
** [State](#API_DescribeScanJob_ResponseSyntax) **
The current state of a scan job.
Type: String
Valid Values: `CANCELED | COMPLETED | COMPLETED_WITH_ISSUES | CREATED | FAILED | RUNNING`
** [StatusMessage](#API_DescribeScanJob_ResponseSyntax) **
A detailed message explaining the status of the job to back up a resource.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Removes the association between an MPA approval team and a backup vault, disabling the MPA approval workflow for restore operations.
## Request Syntax
```
POST /backup-vaults/backupVaultName/mpaApprovalTeam?delete HTTP/1.1
Content-type: application/json
{
"RequesterComment": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupVaultName](#API_DisassociateBackupVaultMpaApprovalTeam_RequestSyntax) **
The name of the backup vault from which to disassociate the MPA approval team.
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [RequesterComment](#API_DisassociateBackupVaultMpaApprovalTeam_RequestSyntax) **
An optional comment explaining the reason for disassociating the MPA approval team from the backup vault.
Type: String
Required: No
## Response Syntax
```
HTTP/1.1 204
```
## Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** InvalidRequestException **
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Deletes the specified continuous backup recovery point from AWS Backup and releases control of that continuous backup to the source service, such as Amazon RDS. The source service will continue to create and retain continuous backups using the lifecycle that you specified in your original backup plan.
Does not support snapshot backup recovery points.
## Request Syntax
```
POST /backup-vaults/backupVaultName/recovery-points/recoveryPointArn/disassociate HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupVaultName](#API_DisassociateRecoveryPoint_RequestSyntax) **
The unique name of an AWS Backup vault.
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
** [recoveryPointArn](#API_DisassociateRecoveryPoint_RequestSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies an AWS Backup recovery point.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** InvalidRequestException **
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
** Context **
** Type **
HTTP Status Code: 400
** InvalidResourceStateException **
AWS Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.
## Request Syntax
```
DELETE /backup-vaults/backupVaultName/recovery-points/recoveryPointArn/parentAssociation HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupVaultName](#API_DisassociateRecoveryPointFromParent_RequestSyntax) **
The name of a logical container where the child (nested) recovery point is stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
** [recoveryPointArn](#API_DisassociateRecoveryPointFromParent_RequestSyntax) **
The Amazon Resource Name (ARN) that uniquely identifies the child (nested) recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 204
```
## Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** InvalidRequestException **
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns the backup plan that is specified by the plan ID as a backup template.
## Request Syntax
```
GET /backup/plans/backupPlanId/toTemplate/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupPlanId](#API_ExportBackupPlanTemplate_RequestSyntax) **
Uniquely identifies a backup plan.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"BackupPlanTemplateJson": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BackupPlanTemplateJson](#API_ExportBackupPlanTemplate_ResponseSyntax) **
The body of a backup plan template in JSON format.
This is a signed JSON document that cannot be modified before being passed to `GetBackupPlanFromJSON.`
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns `BackupPlan` details for the specified `BackupPlanId`. The details are the body of a backup plan in JSON format, in addition to plan metadata.
## Request Syntax
```
GET /backup/plans/backupPlanId/?MaxScheduledRunsPreview=MaxScheduledRunsPreview&versionId=VersionId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupPlanId](#API_GetBackupPlan_RequestSyntax) **
Uniquely identifies a backup plan.
Required: Yes
** [MaxScheduledRunsPreview](#API_GetBackupPlan_RequestSyntax) **
Number of future scheduled backup runs to preview. When set to 0 (default), no scheduled runs preview is included in the response. Valid range is 0-10.
Valid Range: Minimum value of 0. Maximum value of 10.
** [VersionId](#API_GetBackupPlan_RequestSyntax) **
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [AdvancedBackupSettings](#API_GetBackupPlan_ResponseSyntax) **
Contains a list of `BackupOptions` for each resource type. The list is populated only if the advanced option is set for the backup plan.
Type: Array of [AdvancedBackupSetting](API_AdvancedBackupSetting.md) objects
** [BackupPlan](#API_GetBackupPlan_ResponseSyntax) **
Specifies the body of a backup plan. Includes a `BackupPlanName` and one or more sets of `Rules`.
Type: [BackupPlan](API_BackupPlan.md) object
** [BackupPlanArn](#API_GetBackupPlan_ResponseSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, `arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50`.
Type: String
** [BackupPlanId](#API_GetBackupPlan_ResponseSyntax) **
Uniquely identifies a backup plan.
Type: String
** [CreationDate](#API_GetBackupPlan_ResponseSyntax) **
The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [CreatorRequestId](#API_GetBackupPlan_ResponseSyntax) **
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
Type: String
** [DeletionDate](#API_GetBackupPlan_ResponseSyntax) **
The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of `DeletionDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [LastExecutionDate](#API_GetBackupPlan_ResponseSyntax) **
The last time this backup plan was run. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of `LastExecutionDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [ScheduledRunsPreview](#API_GetBackupPlan_ResponseSyntax) **
List of upcoming scheduled backup runs. Only included when `MaxScheduledRunsPreview` parameter is greater than 0. Contains up to 10 future backup executions with their scheduled times, execution types, and associated rule IDs.
Type: Array of [ScheduledPlanExecutionMember](API_ScheduledPlanExecutionMember.md) objects
** [VersionId](#API_GetBackupPlan_ResponseSyntax) **
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns a valid JSON document specifying a backup plan or an error.
## Request Syntax
```
POST /backup/template/json/toPlan HTTP/1.1
Content-type: application/json
{
"BackupPlanTemplateJson": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [BackupPlanTemplateJson](#API_GetBackupPlanFromJSON_RequestSyntax) **
A customer-supplied backup plan document in JSON format.
Type: String
Required: Yes
## Response Syntax
```
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"
}
]
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BackupPlan](#API_GetBackupPlanFromJSON_ResponseSyntax) **
Specifies the body of a backup plan. Includes a `BackupPlanName` and one or more sets of `Rules`.
Type: [BackupPlan](API_BackupPlan.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** InvalidRequestException **
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
** Context **
** Type **
HTTP Status Code: 400
** LimitExceededException **
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns the template specified by its `templateId` as a backup plan.
## Request Syntax
```
GET /backup/template/plans/templateId/toPlan HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [templateId](#API_GetBackupPlanFromTemplate_RequestSyntax) **
Uniquely identifies a stored backup plan template.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
]
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BackupPlanDocument](#API_GetBackupPlanFromTemplate_ResponseSyntax) **
Returns the body of a backup plan based on the target template, including the name, rules, and backup vault of the plan.
Type: [BackupPlan](API_BackupPlan.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.
## Request Syntax
```
GET /backup/plans/backupPlanId/selections/selectionId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupPlanId](#API_GetBackupSelection_RequestSyntax) **
Uniquely identifies a backup plan.
Required: Yes
** [selectionId](#API_GetBackupSelection_RequestSyntax) **
Uniquely identifies the body of a request to assign a set of resources to a backup plan.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BackupPlanId](#API_GetBackupSelection_ResponseSyntax) **
Uniquely identifies a backup plan.
Type: String
** [BackupSelection](#API_GetBackupSelection_ResponseSyntax) **
Specifies the body of a request to assign a set of resources to a backup plan.
Type: [BackupSelection](API_BackupSelection.md) object
** [CreationDate](#API_GetBackupSelection_ResponseSyntax) **
The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [CreatorRequestId](#API_GetBackupSelection_ResponseSyntax) **
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
Type: String
** [SelectionId](#API_GetBackupSelection_ResponseSyntax) **
Uniquely identifies the body of a request to assign a set of resources to a backup plan.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns the access policy document that is associated with the named backup vault.
## Request Syntax
```
GET /backup-vaults/backupVaultName/access-policy HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupVaultName](#API_GetBackupVaultAccessPolicy_RequestSyntax) **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"BackupVaultArn": "string",
"BackupVaultName": "string",
"Policy": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BackupVaultArn](#API_GetBackupVaultAccessPolicy_ResponseSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
Type: String
** [BackupVaultName](#API_GetBackupVaultAccessPolicy_ResponseSyntax) **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
Type: String
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
** [Policy](#API_GetBackupVaultAccessPolicy_ResponseSyntax) **
The backup vault access policy document in JSON format.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns event notifications for the specified backup vault.
## Request Syntax
```
GET /backup-vaults/backupVaultName/notification-configuration HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupVaultName](#API_GetBackupVaultNotifications_RequestSyntax) **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"BackupVaultArn": "string",
"BackupVaultEvents": [ "string" ],
"BackupVaultName": "string",
"SNSTopicArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BackupVaultArn](#API_GetBackupVaultNotifications_ResponseSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
Type: String
** [BackupVaultEvents](#API_GetBackupVaultNotifications_ResponseSyntax) **
An array of events that indicate the status of jobs to back up resources to the backup vault.
Type: Array of strings
Valid Values: `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) **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
Type: String
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
** [SNSTopicArn](#API_GetBackupVaultNotifications_ResponseSyntax) **
An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS) topic; for example, `arn:aws:sns:us-west-2:111122223333:MyTopic`.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This action returns details for a specified legal hold. The details are the body of a legal hold in JSON format, in addition to metadata.
## Request Syntax
```
GET /legal-holds/legalHoldId/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [legalHoldId](#API_GetLegalHold_RequestSyntax) **
The ID of the legal hold.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [CancelDescription](#API_GetLegalHold_ResponseSyntax) **
The reason for removing the legal hold.
Type: String
** [CancellationDate](#API_GetLegalHold_ResponseSyntax) **
The time when the legal hold was cancelled.
Type: Timestamp
** [CreationDate](#API_GetLegalHold_ResponseSyntax) **
The time when the legal hold was created.
Type: Timestamp
** [Description](#API_GetLegalHold_ResponseSyntax) **
The description of the legal hold.
Type: String
** [LegalHoldArn](#API_GetLegalHold_ResponseSyntax) **
The framework ARN for the specified legal hold. The format of the ARN depends on the resource type.
Type: String
** [LegalHoldId](#API_GetLegalHold_ResponseSyntax) **
The ID of the legal hold.
Type: String
** [RecoveryPointSelection](#API_GetLegalHold_ResponseSyntax) **
The criteria to assign a set of resources, such as resource types or backup vaults.
Type: [RecoveryPointSelection](API_RecoveryPointSelection.md) object
** [RetainRecordUntil](#API_GetLegalHold_ResponseSyntax) **
The date and time until which the legal hold record is retained.
Type: Timestamp
** [Status](#API_GetLegalHold_ResponseSyntax) **
The status of the legal hold.
Type: String
Valid Values: `CREATING | ACTIVE | CANCELING | CANCELED`
** [Title](#API_GetLegalHold_ResponseSyntax) **
The title of the legal hold.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This operation returns the metadata and details specific to the backup index associated with the specified recovery point.
## Request Syntax
```
GET /backup-vaults/backupVaultName/recovery-points/recoveryPointArn/index HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupVaultName](#API_GetRecoveryPointIndexDetails_RequestSyntax) **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
Accepted characters include lowercase letters, numbers, and hyphens.
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
** [recoveryPointArn](#API_GetRecoveryPointIndexDetails_RequestSyntax) **
An ARN that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
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
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BackupVaultArn](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **
An ARN that uniquely identifies the backup vault where the recovery point index is stored.
For example, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
Type: String
** [IndexCompletionDate](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **
The date and time that a backup index finished creation, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [IndexCreationDate](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **
The date and time that a backup index was created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [IndexDeletionDate](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **
The date and time that a backup index was deleted, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [IndexStatus](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **
This is the current status for the backup index associated with the specified recovery point.
Statuses are: `PENDING` \$1 `ACTIVE` \$1 `FAILED` \$1 `DELETING`
A recovery point with an index that has the status of `ACTIVE` can be included in a search.
Type: String
Valid Values: `PENDING | ACTIVE | FAILED | DELETING`
** [IndexStatusMessage](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **
A detailed message explaining the status of a backup index associated with the recovery point.
Type: String
** [RecoveryPointArn](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **
An ARN that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Type: String
** [SourceResourceArn](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **
A string of the Amazon Resource Name (ARN) that uniquely identifies the source resource.
Type: String
** [TotalItemsIndexed](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **
Count of items within the backup index associated with the recovery point.
Type: Long
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns a set of metadata key-value pairs that were used to create the backup.
## Request Syntax
```
GET /backup-vaults/backupVaultName/recovery-points/recoveryPointArn/restore-metadata?backupVaultAccountId=BackupVaultAccountId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [BackupVaultAccountId](#API_GetRecoveryPointRestoreMetadata_RequestSyntax) **
The account ID of the specified backup vault.
Pattern: `^[0-9]{12}$`
** [backupVaultName](#API_GetRecoveryPointRestoreMetadata_RequestSyntax) **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
** [recoveryPointArn](#API_GetRecoveryPointRestoreMetadata_RequestSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"BackupVaultArn": "string",
"RecoveryPointArn": "string",
"ResourceType": "string",
"RestoreMetadata": {
"string" : "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BackupVaultArn](#API_GetRecoveryPointRestoreMetadata_ResponseSyntax) **
An ARN that uniquely identifies a backup vault; for example, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
Type: String
** [RecoveryPointArn](#API_GetRecoveryPointRestoreMetadata_ResponseSyntax) **
An ARN that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Type: String
** [ResourceType](#API_GetRecoveryPointRestoreMetadata_ResponseSyntax) **
The resource type of the recovery point.
Type: String
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
** [RestoreMetadata](#API_GetRecoveryPointRestoreMetadata_ResponseSyntax) **
The set of metadata key-value pairs that describe the original configuration of the backed-up resource. These values vary depending on the service that is being restored.
Type: String to string map
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This request returns the metadata for the specified restore job.
## Request Syntax
```
GET /restore-jobs/restoreJobId/metadata HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [restoreJobId](#API_GetRestoreJobMetadata_RequestSyntax) **
This is a unique identifier of a restore job within AWS Backup.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"Metadata": {
"string" : "string"
},
"RestoreJobId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Metadata](#API_GetRestoreJobMetadata_ResponseSyntax) **
This contains the metadata of the specified backup job.
Type: String to string map
** [RestoreJobId](#API_GetRestoreJobMetadata_ResponseSyntax) **
This is a unique identifier of a restore job within AWS Backup.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This request returns the minimal required set of metadata needed to start a restore job with secure default settings. `BackupVaultName` and `RecoveryPointArn` are required parameters. `BackupVaultAccountId` is an optional parameter.
## Request Syntax
```
GET /restore-testing/inferred-metadata?BackupVaultAccountId=BackupVaultAccountId&BackupVaultName=BackupVaultName&RecoveryPointArn=RecoveryPointArn HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [BackupVaultAccountId](#API_GetRestoreTestingInferredMetadata_RequestSyntax) **
The account ID of the specified backup vault.
** [BackupVaultName](#API_GetRestoreTestingInferredMetadata_RequestSyntax) **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWSRegion where they are created. They consist of letters, numbers, and hyphens.
Required: Yes
** [RecoveryPointArn](#API_GetRestoreTestingInferredMetadata_RequestSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"InferredMetadata": {
"string" : "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [InferredMetadata](#API_GetRestoreTestingInferredMetadata_ResponseSyntax) **
This is a string map of the metadata inferred from the request.
Type: String to string map
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns `RestoreTestingPlan` details for the specified `RestoreTestingPlanName`. The details are the body of a restore testing plan in JSON format, in addition to plan metadata.
## Request Syntax
```
GET /restore-testing/plans/RestoreTestingPlanName HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [RestoreTestingPlanName](#API_GetRestoreTestingPlan_RequestSyntax) **
Required unique name of the restore testing plan.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
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
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [RestoreTestingPlan](#API_GetRestoreTestingPlan_ResponseSyntax) **
Specifies the body of a restore testing plan. Includes `RestoreTestingPlanName`.
Type: [RestoreTestingPlanForGet](API_RestoreTestingPlanForGet.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.
## Request Syntax
```
GET /restore-testing/plans/RestoreTestingPlanName/selections/RestoreTestingSelectionName HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [RestoreTestingPlanName](#API_GetRestoreTestingSelection_RequestSyntax) **
Required unique name of the restore testing plan.
Required: Yes
** [RestoreTestingSelectionName](#API_GetRestoreTestingSelection_RequestSyntax) **
Required unique name of the restore testing selection.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
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
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [RestoreTestingSelection](#API_GetRestoreTestingSelection_ResponseSyntax) **
Unique name of the restore testing selection.
Type: [RestoreTestingSelectionForGet](API_RestoreTestingSelectionForGet.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns the AWS resource types supported by AWS Backup.
## Request Syntax
```
GET /supported-resource-types HTTP/1.1
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"ResourceTypes": [ "string" ]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ResourceTypes](#API_GetSupportedResourceTypes_ResponseSyntax) **
Contains a string with the supported AWS resource types:
+ `Aurora` for Amazon Aurora
+ `CloudFormation` for AWS CloudFormation
+ `DocumentDB` for Amazon DocumentDB (with MongoDB compatibility)
+ `DynamoDB` for Amazon DynamoDB
+ `EBS` for Amazon Elastic Block Store
+ `EC2` for Amazon Elastic Compute Cloud
+ `EFS` for Amazon Elastic File System
+ `EKS` for Amazon Elastic Kubernetes Service
+ `FSx` for Amazon FSx
+ `Neptune` for Amazon Neptune
+ `RDS` for Amazon Relational Database Service
+ `Redshift` for Amazon Redshift
+ `S3` for Amazon Simple Storage Service (Amazon S3)
+ `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic Compute Cloud instances
+ `Storage Gateway` for AWS Storage Gateway
+ `Timestream` for Amazon Timestream
+ `VirtualMachine` for VMware virtual machines
Type: Array of strings
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns `TieringConfiguration` details for the specified `TieringConfigurationName`. The details are the body of a tiering configuration in JSON format, in addition to configuration metadata.
## Request Syntax
```
GET /tiering-configurations/tieringConfigurationName HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [tieringConfigurationName](#API_GetTieringConfiguration_RequestSyntax) **
The unique name of a tiering configuration.
Pattern: `^[a-zA-Z0-9_]{1,200}$`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [TieringConfiguration](#API_GetTieringConfiguration_ResponseSyntax) **
Specifies the body of a tiering configuration. Includes `TieringConfigurationName`.
Type: [TieringConfiguration](API_TieringConfiguration.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these [monitoring tools](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html).
## Request Syntax
```
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 Request Parameters
The request uses the following URI parameters.
** [ByAccountId](#API_ListBackupJobs_RequestSyntax) **
The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.
If used from an AWS Organizations management account, passing `*` returns all jobs across the organization.
Pattern: `^[0-9]{12}$`
** [ByBackupVaultName](#API_ListBackupJobs_RequestSyntax) **
Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
** [ByCompleteAfter](#API_ListBackupJobs_RequestSyntax) **
Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
** [ByCompleteBefore](#API_ListBackupJobs_RequestSyntax) **
Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
** [ByCreatedAfter](#API_ListBackupJobs_RequestSyntax) **
Returns only backup jobs that were created after the specified date.
** [ByCreatedBefore](#API_ListBackupJobs_RequestSyntax) **
Returns only backup jobs that were created before the specified date.
** [ByMessageCategory](#API_ListBackupJobs_RequestSyntax) **
This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.
Example strings may include `AccessDenied`, `SUCCESS`, `AGGREGATE_ALL`, and `InvalidParameters`.
View [Monitoring](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html)
The wildcard () returns count of all message categories.
`AGGREGATE_ALL` aggregates job counts for all message categories and returns the sum.
** [ByParentJobId](#API_ListBackupJobs_RequestSyntax) **
This is a filter to list child (nested) jobs based on parent job ID.
** [ByResourceArn](#API_ListBackupJobs_RequestSyntax) **
Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).
** [ByResourceType](#API_ListBackupJobs_RequestSyntax) **
Returns only backup jobs for the specified resources:
+ `Aurora` for Amazon Aurora
+ `CloudFormation` for AWS CloudFormation
+ `DocumentDB` for Amazon DocumentDB (with MongoDB compatibility)
+ `DynamoDB` for Amazon DynamoDB
+ `EBS` for Amazon Elastic Block Store
+ `EC2` for Amazon Elastic Compute Cloud
+ `EFS` for Amazon Elastic File System
+ `EKS` for Amazon Elastic Kubernetes Service
+ `FSx` for Amazon FSx
+ `Neptune` for Amazon Neptune
+ `RDS` for Amazon Relational Database Service
+ `Redshift` for Amazon Redshift
+ `S3` for Amazon Simple Storage Service (Amazon S3)
+ `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic Compute Cloud instances
+ `Storage Gateway` for AWS Storage Gateway
+ `Timestream` for Amazon Timestream
+ `VirtualMachine` for VMware virtual machines
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
** [ByState](#API_ListBackupJobs_RequestSyntax) **
Returns only backup jobs that are in the specified state.
`Completed with issues` is a status found only in the AWS Backup console. For API, this status refers to jobs with a state of `COMPLETED` and a `MessageCategory` with a value other than `SUCCESS`; that is, the status is completed but comes with a status message.
To obtain the job count for `Completed with issues`, run two GET requests, and subtract the second, smaller number:
GET /backup-jobs/?state=COMPLETED
GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED
Valid Values: `CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL`
** [MaxResults](#API_ListBackupJobs_RequestSyntax) **
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_ListBackupJobs_RequestSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BackupJobs](#API_ListBackupJobs_ResponseSyntax) **
An array of structures containing metadata about your backup jobs returned in JSON format.
Type: Array of [BackupJob](API_BackupJob.md) objects
** [NextToken](#API_ListBackupJobs_ResponseSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This is a request for a summary of backup jobs created or running within the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results.
This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
## Request Syntax
```
GET /audit/backup-job-summaries?AccountId=AccountId&AggregationPeriod=AggregationPeriod&MaxResults=MaxResults&MessageCategory=MessageCategory&NextToken=NextToken&ResourceType=ResourceType&State=State HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [AccountId](#API_ListBackupJobSummaries_RequestSyntax) **
Returns the job count for the specified account.
If the request is sent from a member account or an account not part of AWS Organizations, jobs within requestor's account will be returned.
Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.
`AGGREGATE_ALL` aggregates job counts from all accounts within the authenticated organization, then returns the sum.
Pattern: `^[0-9]{12}$`
** [AggregationPeriod](#API_ListBackupJobSummaries_RequestSyntax) **
The period for the returned results.
+ `ONE_DAY` - The daily job count for the prior 14 days.
+ `SEVEN_DAYS` - The aggregated job count for the prior 7 days.
+ `FOURTEEN_DAYS` - The aggregated job count for prior 14 days.
Valid Values: `ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS`
** [MaxResults](#API_ListBackupJobSummaries_RequestSyntax) **
The maximum number of items to be returned.
The value is an integer. Range of accepted values is from 1 to 500.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [MessageCategory](#API_ListBackupJobSummaries_RequestSyntax) **
This parameter returns the job count for the specified message category.
Example accepted strings include `AccessDenied`, `Success`, and `InvalidParameters`. See [Monitoring](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html) for a list of accepted MessageCategory strings.
The the value ANY returns count of all message categories.
`AGGREGATE_ALL` aggregates job counts for all message categories and returns the sum.
** [NextToken](#API_ListBackupJobSummaries_RequestSyntax) **
The next item following a partial list of returned resources. For example, if a request is made to return `MaxResults` number of resources, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
** [ResourceType](#API_ListBackupJobSummaries_RequestSyntax) **
Returns the job count for the specified resource type. Use request `GetSupportedResourceTypes` to obtain strings for supported resource types.
The the value ANY returns count of all resource types.
`AGGREGATE_ALL` aggregates job counts for all resource types and returns the sum.
The type of AWS resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
** [State](#API_ListBackupJobSummaries_RequestSyntax) **
This parameter returns the job count for jobs with the specified state.
The the value ANY returns count of all states.
`AGGREGATE_ALL` aggregates job counts for all states and returns the sum.
`Completed with issues` is a status found only in the AWS Backup console. For API, this status refers to jobs with a state of `COMPLETED` and a `MessageCategory` with a value other than `SUCCESS`; that is, the status is completed but comes with a status message. To obtain the job count for `Completed with issues`, run two GET requests, and subtract the second, smaller number:
GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN\$1DAYS&State=COMPLETED
GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN\$1DAYS&MessageCategory=SUCCESS&State=COMPLETED
Valid Values: `CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL | AGGREGATE_ALL | ANY`
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [AggregationPeriod](#API_ListBackupJobSummaries_ResponseSyntax) **
The period for the returned results.
+ `ONE_DAY` - The daily job count for the prior 14 days.
+ `SEVEN_DAYS` - The aggregated job count for the prior 7 days.
+ `FOURTEEN_DAYS` - The aggregated job count for prior 14 days.
Type: String
** [BackupJobSummaries](#API_ListBackupJobSummaries_ResponseSyntax) **
The summary information.
Type: Array of [BackupJobSummary](API_BackupJobSummary.md) objects
** [NextToken](#API_ListBackupJobSummaries_ResponseSyntax) **
The next item following a partial list of returned resources. For example, if a request is made to return `MaxResults` number of resources, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Lists the active backup plans for the account.
## Request Syntax
```
GET /backup/plans/?includeDeleted=IncludeDeleted&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [IncludeDeleted](#API_ListBackupPlans_RequestSyntax) **
A Boolean value with a default value of `FALSE` that returns deleted backup plans when set to `TRUE`.
** [MaxResults](#API_ListBackupPlans_RequestSyntax) **
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_ListBackupPlans_RequestSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BackupPlansList](#API_ListBackupPlans_ResponseSyntax) **
Information about the backup plans.
Type: Array of [BackupPlansListMember](API_BackupPlansListMember.md) objects
** [NextToken](#API_ListBackupPlans_ResponseSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Lists the backup plan templates.
## Request Syntax
```
GET /backup/template/plans?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [MaxResults](#API_ListBackupPlanTemplates_RequestSyntax) **
The maximum number of items to return.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_ListBackupPlanTemplates_RequestSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"BackupPlanTemplatesList": [
{
"BackupPlanTemplateId": "string",
"BackupPlanTemplateName": "string"
}
],
"NextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BackupPlanTemplatesList](#API_ListBackupPlanTemplates_ResponseSyntax) **
An array of template list items containing metadata about your saved templates.
Type: Array of [BackupPlanTemplatesListMember](API_BackupPlanTemplatesListMember.md) objects
** [NextToken](#API_ListBackupPlanTemplates_ResponseSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.
## Request Syntax
```
GET /backup/plans/backupPlanId/versions/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupPlanId](#API_ListBackupPlanVersions_RequestSyntax) **
Uniquely identifies a backup plan.
Required: Yes
** [MaxResults](#API_ListBackupPlanVersions_RequestSyntax) **
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_ListBackupPlanVersions_RequestSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BackupPlanVersionsList](#API_ListBackupPlanVersions_ResponseSyntax) **
An array of version list items containing metadata about your backup plans.
Type: Array of [BackupPlansListMember](API_BackupPlansListMember.md) objects
** [NextToken](#API_ListBackupPlanVersions_ResponseSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns an array containing metadata of the resources associated with the target backup plan.
## Request Syntax
```
GET /backup/plans/backupPlanId/selections/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupPlanId](#API_ListBackupSelections_RequestSyntax) **
Uniquely identifies a backup plan.
Required: Yes
** [MaxResults](#API_ListBackupSelections_RequestSyntax) **
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_ListBackupSelections_RequestSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"BackupSelectionsList": [
{
"BackupPlanId": "string",
"CreationDate": number,
"CreatorRequestId": "string",
"IamRoleArn": "string",
"SelectionId": "string",
"SelectionName": "string"
}
],
"NextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BackupSelectionsList](#API_ListBackupSelections_ResponseSyntax) **
An array of backup selection list items containing metadata about each resource in the list.
Type: Array of [BackupSelectionsListMember](API_BackupSelectionsListMember.md) objects
** [NextToken](#API_ListBackupSelections_ResponseSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns a list of recovery point storage containers along with information about them.
## Request Syntax
```
GET /backup-vaults/?maxResults=MaxResults&nextToken=NextToken&shared=ByShared&vaultType=ByVaultType HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [ByShared](#API_ListBackupVaults_RequestSyntax) **
This parameter will sort the list of vaults by shared vaults.
** [ByVaultType](#API_ListBackupVaults_RequestSyntax) **
This parameter will sort the list of vaults by vault type.
Valid Values: `BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT | RESTORE_ACCESS_BACKUP_VAULT`
** [MaxResults](#API_ListBackupVaults_RequestSyntax) **
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_ListBackupVaults_RequestSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BackupVaultList](#API_ListBackupVaults_ResponseSyntax) **
An array of backup vault list members containing vault metadata, including Amazon Resource Name (ARN), display name, creation date, number of saved recovery points, and encryption information if the resources saved in the backup vault are encrypted.
Type: Array of [BackupVaultListMember](API_BackupVaultListMember.md) objects
** [NextToken](#API_ListBackupVaults_ResponseSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns metadata about your copy jobs.
## Request Syntax
```
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 Request Parameters
The request uses the following URI parameters.
** [ByAccountId](#API_ListCopyJobs_RequestSyntax) **
The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.
Pattern: `^[0-9]{12}$`
** [ByCompleteAfter](#API_ListCopyJobs_RequestSyntax) **
Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
** [ByCompleteBefore](#API_ListCopyJobs_RequestSyntax) **
Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
** [ByCreatedAfter](#API_ListCopyJobs_RequestSyntax) **
Returns only copy jobs that were created after the specified date.
** [ByCreatedBefore](#API_ListCopyJobs_RequestSyntax) **
Returns only copy jobs that were created before the specified date.
** [ByDestinationVaultArn](#API_ListCopyJobs_RequestSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
** [ByMessageCategory](#API_ListCopyJobs_RequestSyntax) **
This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.
Example strings may include `AccessDenied`, `SUCCESS`, `AGGREGATE_ALL`, and `INVALIDPARAMETERS`.
View [Monitoring](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html) for a list of accepted strings.
The the value ANY returns count of all message categories.
`AGGREGATE_ALL` aggregates job counts for all message categories and returns the sum.
** [ByParentJobId](#API_ListCopyJobs_RequestSyntax) **
This is a filter to list child (nested) jobs based on parent job ID.
** [ByResourceArn](#API_ListCopyJobs_RequestSyntax) **
Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).
** [ByResourceType](#API_ListCopyJobs_RequestSyntax) **
Returns only backup jobs for the specified resources:
+ `Aurora` for Amazon Aurora
+ `CloudFormation` for AWS CloudFormation
+ `DocumentDB` for Amazon DocumentDB (with MongoDB compatibility)
+ `DynamoDB` for Amazon DynamoDB
+ `EBS` for Amazon Elastic Block Store
+ `EC2` for Amazon Elastic Compute Cloud
+ `EFS` for Amazon Elastic File System
+ `EKS` for Amazon Elastic Kubernetes Service
+ `FSx` for Amazon FSx
+ `Neptune` for Amazon Neptune
+ `RDS` for Amazon Relational Database Service
+ `Redshift` for Amazon Redshift
+ `S3` for Amazon Simple Storage Service (Amazon S3)
+ `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic Compute Cloud instances
+ `Storage Gateway` for AWS Storage Gateway
+ `Timestream` for Amazon Timestream
+ `VirtualMachine` for VMware virtual machines
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
** [BySourceRecoveryPointArn](#API_ListCopyJobs_RequestSyntax) **
Filters copy jobs by the specified source recovery point ARN.
** [ByState](#API_ListCopyJobs_RequestSyntax) **
Returns only copy jobs that are in the specified state.
Valid Values: `CREATED | RUNNING | COMPLETED | FAILED | PARTIAL`
** [MaxResults](#API_ListCopyJobs_RequestSyntax) **
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_ListCopyJobs_RequestSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [CopyJobs](#API_ListCopyJobs_ResponseSyntax) **
An array of structures containing metadata about your copy jobs returned in JSON format.
Type: Array of [CopyJob](API_CopyJob.md) objects
** [NextToken](#API_ListCopyJobs_ResponseSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This request obtains a list of copy jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results.
This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
## Request Syntax
```
GET /audit/copy-job-summaries?AccountId=AccountId&AggregationPeriod=AggregationPeriod&MaxResults=MaxResults&MessageCategory=MessageCategory&NextToken=NextToken&ResourceType=ResourceType&State=State HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [AccountId](#API_ListCopyJobSummaries_RequestSyntax) **
Returns the job count for the specified account.
If the request is sent from a member account or an account not part of AWS Organizations, jobs within requestor's account will be returned.
Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.
`AGGREGATE_ALL` aggregates job counts from all accounts within the authenticated organization, then returns the sum.
Pattern: `^[0-9]{12}$`
** [AggregationPeriod](#API_ListCopyJobSummaries_RequestSyntax) **
The period for the returned results.
+ `ONE_DAY` - The daily job count for the prior 14 days.
+ `SEVEN_DAYS` - The aggregated job count for the prior 7 days.
+ `FOURTEEN_DAYS` - The aggregated job count for prior 14 days.
Valid Values: `ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS`
** [MaxResults](#API_ListCopyJobSummaries_RequestSyntax) **
This parameter sets the maximum number of items to be returned.
The value is an integer. Range of accepted values is from 1 to 500.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [MessageCategory](#API_ListCopyJobSummaries_RequestSyntax) **
This parameter returns the job count for the specified message category.
Example accepted strings include `AccessDenied`, `Success`, and `InvalidParameters`. See [Monitoring](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html) for a list of accepted MessageCategory strings.
The the value ANY returns count of all message categories.
`AGGREGATE_ALL` aggregates job counts for all message categories and returns the sum.
** [NextToken](#API_ListCopyJobSummaries_RequestSyntax) **
The next item following a partial list of returned resources. For example, if a request is made to return `MaxResults` number of resources, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
** [ResourceType](#API_ListCopyJobSummaries_RequestSyntax) **
Returns the job count for the specified resource type. Use request `GetSupportedResourceTypes` to obtain strings for supported resource types.
The the value ANY returns count of all resource types.
`AGGREGATE_ALL` aggregates job counts for all resource types and returns the sum.
The type of AWS resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
** [State](#API_ListCopyJobSummaries_RequestSyntax) **
This parameter returns the job count for jobs with the specified state.
The the value ANY returns count of all states.
`AGGREGATE_ALL` aggregates job counts for all states and returns the sum.
Valid Values: `CREATED | RUNNING | ABORTING | ABORTED | COMPLETING | COMPLETED | FAILING | FAILED | PARTIAL | AGGREGATE_ALL | ANY`
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [AggregationPeriod](#API_ListCopyJobSummaries_ResponseSyntax) **
The period for the returned results.
+ `ONE_DAY` - The daily job count for the prior 14 days.
+ `SEVEN_DAYS` - The aggregated job count for the prior 7 days.
+ `FOURTEEN_DAYS` - The aggregated job count for prior 14 days.
Type: String
** [CopyJobSummaries](#API_ListCopyJobSummaries_ResponseSyntax) **
This return shows a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
Type: Array of [CopyJobSummary](API_CopyJobSummary.md) objects
** [NextToken](#API_ListCopyJobSummaries_ResponseSyntax) **
The next item following a partial list of returned resources. For example, if a request is made to return `MaxResults` number of resources, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns a list of all frameworks for an AWS account and AWS Region.
## Request Syntax
```
GET /audit/frameworks?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [MaxResults](#API_ListFrameworks_RequestSyntax) **
The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_ListFrameworks_RequestSyntax) **
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"Frameworks": [
{
"CreationTime": number,
"DeploymentStatus": "string",
"FrameworkArn": "string",
"FrameworkDescription": "string",
"FrameworkName": "string",
"NumberOfControls": number
}
],
"NextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Frameworks](#API_ListFrameworks_ResponseSyntax) **
The frameworks with details for each framework, including the framework name, Amazon Resource Name (ARN), description, number of controls, creation time, and deployment status.
Type: Array of [Framework](API_Framework.md) objects
** [NextToken](#API_ListFrameworks_ResponseSyntax) **
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This operation returns a list of recovery points that have an associated index, belonging to the specified account.
Optional parameters you can include are: MaxResults; NextToken; SourceResourceArns; CreatedBefore; CreatedAfter; and ResourceType.
## Request Syntax
```
GET /indexes/recovery-point/?createdAfter=CreatedAfter&createdBefore=CreatedBefore&indexStatus=IndexStatus&maxResults=MaxResults&nextToken=NextToken&resourceType=ResourceType&sourceResourceArn=SourceResourceArn HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [CreatedAfter](#API_ListIndexedRecoveryPoints_RequestSyntax) **
Returns only indexed recovery points that were created after the specified date.
** [CreatedBefore](#API_ListIndexedRecoveryPoints_RequestSyntax) **
Returns only indexed recovery points that were created before the specified date.
** [IndexStatus](#API_ListIndexedRecoveryPoints_RequestSyntax) **
Include this parameter to filter the returned list by the indicated statuses.
Accepted values: `PENDING` \$1 `ACTIVE` \$1 `FAILED` \$1 `DELETING`
A recovery point with an index that has the status of `ACTIVE` can be included in a search.
Valid Values: `PENDING | ACTIVE | FAILED | DELETING`
** [MaxResults](#API_ListIndexedRecoveryPoints_RequestSyntax) **
The maximum number of resource list items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_ListIndexedRecoveryPoints_RequestSyntax) **
The next item following a partial list of returned recovery points.
For example, if a request is made to return `MaxResults` number of indexed recovery points, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
** [ResourceType](#API_ListIndexedRecoveryPoints_RequestSyntax) **
Returns a list of indexed recovery points for the specified resource type(s).
Accepted values include:
+ `EBS` for Amazon Elastic Block Store
+ `S3` for Amazon Simple Storage Service (Amazon S3)
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
** [SourceResourceArn](#API_ListIndexedRecoveryPoints_RequestSyntax) **
A string of the Amazon Resource Name (ARN) that uniquely identifies the source resource.
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [IndexedRecoveryPoints](#API_ListIndexedRecoveryPoints_ResponseSyntax) **
This is a list of recovery points that have an associated index, belonging to the specified account.
Type: Array of [IndexedRecoveryPoint](API_IndexedRecoveryPoint.md) objects
** [NextToken](#API_ListIndexedRecoveryPoints_ResponseSyntax) **
The next item following a partial list of returned recovery points.
For example, if a request is made to return `MaxResults` number of indexed recovery points, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This action returns metadata about active and previous legal holds.
## Request Syntax
```
GET /legal-holds/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [MaxResults](#API_ListLegalHolds_RequestSyntax) **
The maximum number of resource list items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_ListLegalHolds_RequestSyntax) **
The next item following a partial list of returned resources. For example, if a request is made to return `MaxResults` number of resources, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [LegalHolds](#API_ListLegalHolds_ResponseSyntax) **
This is an array of returned legal holds, both active and previous.
Type: Array of [LegalHold](API_LegalHold.md) objects
** [NextToken](#API_ListLegalHolds_ResponseSyntax) **
The next item following a partial list of returned resources. For example, if a request is made to return `MaxResults` number of resources, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns an array of resources with recovery points created by AWS Backup (regardless of the recovery point's [status](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_DescribeRecoveryPoint.html#Backup-DescribeRecoveryPoint-response-Status)), including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.
## Request Syntax
```
GET /resources/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [MaxResults](#API_ListProtectedResources_RequestSyntax) **
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_ListProtectedResources_RequestSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Results": [
{
"LastBackupTime": number,
"LastBackupVaultArn": "string",
"LastRecoveryPointArn": "string",
"ResourceArn": "string",
"ResourceName": "string",
"ResourceType": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_ListProtectedResources_ResponseSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
** [Results](#API_ListProtectedResources_ResponseSyntax) **
An array of resources successfully backed up by AWS Backup including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.
Type: Array of [ProtectedResource](API_ProtectedResource.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This request lists the protected resources corresponding to each backup vault.
## Request Syntax
```
GET /backup-vaults/backupVaultName/resources/?backupVaultAccountId=BackupVaultAccountId&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [BackupVaultAccountId](#API_ListProtectedResourcesByBackupVault_RequestSyntax) **
The list of protected resources by backup vault within the vault(s) you specify by account ID.
Pattern: `^[0-9]{12}$`
** [backupVaultName](#API_ListProtectedResourcesByBackupVault_RequestSyntax) **
The list of protected resources by backup vault within the vault(s) you specify by name.
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
** [MaxResults](#API_ListProtectedResourcesByBackupVault_RequestSyntax) **
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_ListProtectedResourcesByBackupVault_RequestSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Results": [
{
"LastBackupTime": number,
"LastBackupVaultArn": "string",
"LastRecoveryPointArn": "string",
"ResourceArn": "string",
"ResourceName": "string",
"ResourceType": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_ListProtectedResourcesByBackupVault_ResponseSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
** [Results](#API_ListProtectedResourcesByBackupVault_ResponseSyntax) **
These are the results returned for the request ListProtectedResourcesByBackupVault.
Type: Array of [ProtectedResource](API_ProtectedResource.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns detailed information about the recovery points stored in a backup vault.
## Request Syntax
```
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 Request Parameters
The request uses the following URI parameters.
** [BackupVaultAccountId](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **
This parameter will sort the list of recovery points by account ID.
Pattern: `^[0-9]{12}$`
** [backupVaultName](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
Backup vault name might not be available when a supported service creates the backup.
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
** [ByBackupPlanId](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **
Returns only recovery points that match the specified backup plan ID.
** [ByCreatedAfter](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **
Returns only recovery points that were created after the specified timestamp.
** [ByCreatedBefore](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **
Returns only recovery points that were created before the specified timestamp.
** [ByParentRecoveryPointArn](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **
This returns only recovery points that match the specified parent (composite) recovery point Amazon Resource Name (ARN).
** [ByResourceArn](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **
Returns only recovery points that match the specified resource Amazon Resource Name (ARN).
** [ByResourceType](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **
Returns only recovery points that match the specified resource type(s):
+ `Aurora` for Amazon Aurora
+ `CloudFormation` for AWS CloudFormation
+ `DocumentDB` for Amazon DocumentDB (with MongoDB compatibility)
+ `DynamoDB` for Amazon DynamoDB
+ `EBS` for Amazon Elastic Block Store
+ `EC2` for Amazon Elastic Compute Cloud
+ `EFS` for Amazon Elastic File System
+ `EKS` for Amazon Elastic Kubernetes Service
+ `FSx` for Amazon FSx
+ `Neptune` for Amazon Neptune
+ `RDS` for Amazon Relational Database Service
+ `Redshift` for Amazon Redshift
+ `S3` for Amazon Simple Storage Service (Amazon S3)
+ `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic Compute Cloud instances
+ `Storage Gateway` for AWS Storage Gateway
+ `Timestream` for Amazon Timestream
+ `VirtualMachine` for VMware virtual machines
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
** [MaxResults](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_ListRecoveryPointsByBackupVault_ResponseSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
** [RecoveryPoints](#API_ListRecoveryPointsByBackupVault_ResponseSyntax) **
An array of objects that contain detailed information about recovery points saved in a backup vault.
Type: Array of [RecoveryPointByBackupVault](API_RecoveryPointByBackupVault.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
## Request Syntax
```
GET /legal-holds/legalHoldId/recovery-points?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [legalHoldId](#API_ListRecoveryPointsByLegalHold_RequestSyntax) **
The ID of the legal hold.
Required: Yes
** [MaxResults](#API_ListRecoveryPointsByLegalHold_RequestSyntax) **
The maximum number of resource list items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_ListRecoveryPointsByLegalHold_RequestSyntax) **
The next item following a partial list of returned resources. For example, if a request is made to return `MaxResults` number of resources, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"RecoveryPoints": [
{
"BackupVaultName": "string",
"RecoveryPointArn": "string",
"ResourceArn": "string",
"ResourceType": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_ListRecoveryPointsByLegalHold_ResponseSyntax) **
The next item following a partial list of returned resources.
Type: String
** [RecoveryPoints](#API_ListRecoveryPointsByLegalHold_ResponseSyntax) **
The recovery points.
Type: Array of [RecoveryPointMember](API_RecoveryPointMember.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
The information about the recovery points of the type specified by a resource Amazon Resource Name (ARN).
**Note**
For Amazon EFS and Amazon EC2, this action only lists recovery points created by AWS Backup.
## Request Syntax
```
GET /resources/resourceArn/recovery-points/?managedByAWSBackupOnly=ManagedByAWSBackupOnly&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [ManagedByAWSBackupOnly](#API_ListRecoveryPointsByResource_RequestSyntax) **
This attribute filters recovery points based on ownership.
If this is set to `TRUE`, the response will contain recovery points associated with the selected resources that are managed by AWS Backup.
If this is set to `FALSE`, the response will contain all recovery points associated with the selected resource.
Type: Boolean
** [MaxResults](#API_ListRecoveryPointsByResource_RequestSyntax) **
The maximum number of items to be returned.
Amazon RDS requires a value of at least 20.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_ListRecoveryPointsByResource_RequestSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
** [resourceArn](#API_ListRecoveryPointsByResource_RequestSyntax) **
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_ListRecoveryPointsByResource_ResponseSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
** [RecoveryPoints](#API_ListRecoveryPointsByResource_ResponseSyntax) **
An array of objects that contain detailed information about recovery points of the specified resource type.
Only Amazon EFS and Amazon EC2 recovery points return BackupVaultName.
Type: Array of [RecoveryPointByResource](API_RecoveryPointByResource.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns details about your report jobs.
## Request Syntax
```
GET /audit/report-jobs?CreationAfter=ByCreationAfter&CreationBefore=ByCreationBefore&MaxResults=MaxResults&NextToken=NextToken&ReportPlanName=ByReportPlanName&Status=ByStatus HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [ByCreationAfter](#API_ListReportJobs_RequestSyntax) **
Returns only report jobs that were created after the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.
** [ByCreationBefore](#API_ListReportJobs_RequestSyntax) **
Returns only report jobs that were created before the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.
** [ByReportPlanName](#API_ListReportJobs_RequestSyntax) **
Returns only report jobs with the specified report plan name.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z][_a-zA-Z0-9]*`
** [ByStatus](#API_ListReportJobs_RequestSyntax) **
Returns only report jobs that are in the specified status. The statuses are:
`CREATED | RUNNING | COMPLETED | FAILED | COMPLETED_WITH_ISSUES`
Please note that only scanning jobs finish with state completed with issues. For backup jobs this is a console interpretation of a job that finishes in completed state and has a status message.
** [MaxResults](#API_ListReportJobs_RequestSyntax) **
The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_ListReportJobs_RequestSyntax) **
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_ListReportJobs_ResponseSyntax) **
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
Type: String
** [ReportJobs](#API_ListReportJobs_ResponseSyntax) **
Details about your report jobs in JSON format.
Type: Array of [ReportJob](API_ReportJob.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns a list of your report plans. For detailed information about a single report plan, use `DescribeReportPlan`.
## Request Syntax
```
GET /audit/report-plans?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [MaxResults](#API_ListReportPlans_RequestSyntax) **
The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_ListReportPlans_RequestSyntax) **
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_ListReportPlans_ResponseSyntax) **
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
Type: String
** [ReportPlans](#API_ListReportPlans_ResponseSyntax) **
The report plans with detailed information for each plan. This information includes the Amazon Resource Name (ARN), report plan name, description, settings, delivery channel, deployment status, creation time, and last times the report plan attempted to and successfully ran.
Type: Array of [ReportPlan](API_ReportPlan.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns a list of restore access backup vaults associated with a specified backup vault.
## Request Syntax
```
GET /logically-air-gapped-backup-vaults/backupVaultName/restore-access-backup-vaults/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupVaultName](#API_ListRestoreAccessBackupVaults_RequestSyntax) **
The name of the backup vault for which to list associated restore access backup vaults.
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
** [MaxResults](#API_ListRestoreAccessBackupVaults_RequestSyntax) **
The maximum number of items to return in the response.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_ListRestoreAccessBackupVaults_RequestSyntax) **
The pagination token from a previous request to retrieve the next set of results.
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_ListRestoreAccessBackupVaults_ResponseSyntax) **
The pagination token to use in a subsequent request to retrieve the next set of results.
Type: String
** [RestoreAccessBackupVaults](#API_ListRestoreAccessBackupVaults_ResponseSyntax) **
A list of restore access backup vaults associated with the specified backup vault.
Type: Array of [RestoreAccessBackupVaultListMember](API_RestoreAccessBackupVaultListMember.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns a list of jobs that AWS Backup initiated to restore a saved resource, including details about the recovery process.
## Request Syntax
```
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 Request Parameters
The request uses the following URI parameters.
** [ByAccountId](#API_ListRestoreJobs_RequestSyntax) **
The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.
Pattern: `^[0-9]{12}$`
** [ByCompleteAfter](#API_ListRestoreJobs_RequestSyntax) **
Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
** [ByCompleteBefore](#API_ListRestoreJobs_RequestSyntax) **
Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
** [ByCreatedAfter](#API_ListRestoreJobs_RequestSyntax) **
Returns only restore jobs that were created after the specified date.
** [ByCreatedBefore](#API_ListRestoreJobs_RequestSyntax) **
Returns only restore jobs that were created before the specified date.
** [ByParentJobId](#API_ListRestoreJobs_RequestSyntax) **
This is a filter to list child (nested) restore jobs based on parent restore job ID.
** [ByResourceType](#API_ListRestoreJobs_RequestSyntax) **
Include this parameter to return only restore jobs for the specified resources:
+ `Aurora` for Amazon Aurora
+ `CloudFormation` for AWS CloudFormation
+ `DocumentDB` for Amazon DocumentDB (with MongoDB compatibility)
+ `DynamoDB` for Amazon DynamoDB
+ `EBS` for Amazon Elastic Block Store
+ `EC2` for Amazon Elastic Compute Cloud
+ `EFS` for Amazon Elastic File System
+ `EKS` for Amazon Elastic Kubernetes Service
+ `FSx` for Amazon FSx
+ `Neptune` for Amazon Neptune
+ `RDS` for Amazon Relational Database Service
+ `Redshift` for Amazon Redshift
+ `S3` for Amazon Simple Storage Service (Amazon S3)
+ `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic Compute Cloud instances
+ `Storage Gateway` for AWS Storage Gateway
+ `Timestream` for Amazon Timestream
+ `VirtualMachine` for VMware virtual machines
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
** [ByRestoreTestingPlanArn](#API_ListRestoreJobs_RequestSyntax) **
This returns only restore testing jobs that match the specified resource Amazon Resource Name (ARN).
** [ByStatus](#API_ListRestoreJobs_RequestSyntax) **
Returns only restore jobs associated with the specified job status.
Valid Values: `PENDING | RUNNING | COMPLETED | ABORTED | FAILED`
** [MaxResults](#API_ListRestoreJobs_RequestSyntax) **
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_ListRestoreJobs_RequestSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_ListRestoreJobs_ResponseSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
** [RestoreJobs](#API_ListRestoreJobs_ResponseSyntax) **
An array of objects that contain detailed information about jobs to restore saved resources.
Type: Array of [RestoreJobsListMember](API_RestoreJobsListMember.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This returns restore jobs that contain the specified protected resource.
You must include `ResourceArn`. You can optionally include `NextToken`, `ByStatus`, `MaxResults`, `ByRecoveryPointCreationDateAfter` , and `ByRecoveryPointCreationDateBefore`.
## Request Syntax
```
GET /resources/resourceArn/restore-jobs/?maxResults=MaxResults&nextToken=NextToken&recoveryPointCreationDateAfter=ByRecoveryPointCreationDateAfter&recoveryPointCreationDateBefore=ByRecoveryPointCreationDateBefore&status=ByStatus HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [ByRecoveryPointCreationDateAfter](#API_ListRestoreJobsByProtectedResource_RequestSyntax) **
Returns only restore jobs of recovery points that were created after the specified date.
** [ByRecoveryPointCreationDateBefore](#API_ListRestoreJobsByProtectedResource_RequestSyntax) **
Returns only restore jobs of recovery points that were created before the specified date.
** [ByStatus](#API_ListRestoreJobsByProtectedResource_RequestSyntax) **
Returns only restore jobs associated with the specified job status.
Valid Values: `PENDING | RUNNING | COMPLETED | ABORTED | FAILED`
** [MaxResults](#API_ListRestoreJobsByProtectedResource_RequestSyntax) **
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_ListRestoreJobsByProtectedResource_RequestSyntax) **
The next item following a partial list of returned items. For example, if a request ismade to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
** [resourceArn](#API_ListRestoreJobsByProtectedResource_RequestSyntax) **
Returns only restore jobs that match the specified resource Amazon Resource Name (ARN).
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_ListRestoreJobsByProtectedResource_ResponseSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows youto return more items in your list starting at the location pointed to by the next token
Type: String
** [RestoreJobs](#API_ListRestoreJobsByProtectedResource_ResponseSyntax) **
An array of objects that contain detailed information about jobs to restore saved resources.>
Type: Array of [RestoreJobsListMember](API_RestoreJobsListMember.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This request obtains a summary of restore jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, AggregationPeriod, MaxResults, or NextToken to filter results.
This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
## Request Syntax
```
GET /audit/restore-job-summaries?AccountId=AccountId&AggregationPeriod=AggregationPeriod&MaxResults=MaxResults&NextToken=NextToken&ResourceType=ResourceType&State=State HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [AccountId](#API_ListRestoreJobSummaries_RequestSyntax) **
Returns the job count for the specified account.
If the request is sent from a member account or an account not part of AWS Organizations, jobs within requestor's account will be returned.
Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.
`AGGREGATE_ALL` aggregates job counts from all accounts within the authenticated organization, then returns the sum.
Pattern: `^[0-9]{12}$`
** [AggregationPeriod](#API_ListRestoreJobSummaries_RequestSyntax) **
The period for the returned results.
+ `ONE_DAY` - The daily job count for the prior 14 days.
+ `SEVEN_DAYS` - The aggregated job count for the prior 7 days.
+ `FOURTEEN_DAYS` - The aggregated job count for prior 14 days.
Valid Values: `ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS`
** [MaxResults](#API_ListRestoreJobSummaries_RequestSyntax) **
This parameter sets the maximum number of items to be returned.
The value is an integer. Range of accepted values is from 1 to 500.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_ListRestoreJobSummaries_RequestSyntax) **
The next item following a partial list of returned resources. For example, if a request is made to return `MaxResults` number of resources, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
** [ResourceType](#API_ListRestoreJobSummaries_RequestSyntax) **
Returns the job count for the specified resource type. Use request `GetSupportedResourceTypes` to obtain strings for supported resource types.
The the value ANY returns count of all resource types.
`AGGREGATE_ALL` aggregates job counts for all resource types and returns the sum.
The type of AWS resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
** [State](#API_ListRestoreJobSummaries_RequestSyntax) **
This parameter returns the job count for jobs with the specified state.
The the value ANY returns count of all states.
`AGGREGATE_ALL` aggregates job counts for all states and returns the sum.
Valid Values: `CREATED | PENDING | RUNNING | ABORTED | COMPLETED | FAILED | AGGREGATE_ALL | ANY`
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [AggregationPeriod](#API_ListRestoreJobSummaries_ResponseSyntax) **
The period for the returned results.
+ `ONE_DAY` - The daily job count for the prior 14 days.
+ `SEVEN_DAYS` - The aggregated job count for the prior 7 days.
+ `FOURTEEN_DAYS` - The aggregated job count for prior 14 days.
Type: String
** [NextToken](#API_ListRestoreJobSummaries_ResponseSyntax) **
The next item following a partial list of returned resources. For example, if a request is made to return `MaxResults` number of resources, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
** [RestoreJobSummaries](#API_ListRestoreJobSummaries_ResponseSyntax) **
This return contains a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
Type: Array of [RestoreJobSummary](API_RestoreJobSummary.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns a list of restore testing plans.
## Request Syntax
```
GET /restore-testing/plans?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [MaxResults](#API_ListRestoreTestingPlans_RequestSyntax) **
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_ListRestoreTestingPlans_RequestSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the nexttoken.
## Request Body
The request does not have a request body.
## Response Syntax
```
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
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_ListRestoreTestingPlans_ResponseSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the nexttoken.
Type: String
** [RestoreTestingPlans](#API_ListRestoreTestingPlans_ResponseSyntax) **
This is a returned list of restore testing plans.
Type: Array of [RestoreTestingPlanForList](API_RestoreTestingPlanForList.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns a list of restore testing selections. Can be filtered by `MaxResults` and `RestoreTestingPlanName`.
## Request Syntax
```
GET /restore-testing/plans/RestoreTestingPlanName/selections?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [MaxResults](#API_ListRestoreTestingSelections_RequestSyntax) **
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_ListRestoreTestingSelections_RequestSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the nexttoken.
** [RestoreTestingPlanName](#API_ListRestoreTestingSelections_RequestSyntax) **
Returns restore testing selections by the specified restore testing plan name.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"RestoreTestingSelections": [
{
"CreationTime": number,
"IamRoleArn": "string",
"ProtectedResourceType": "string",
"RestoreTestingPlanName": "string",
"RestoreTestingSelectionName": "string",
"ValidationWindowHours": number
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_ListRestoreTestingSelections_ResponseSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the nexttoken.
Type: String
** [RestoreTestingSelections](#API_ListRestoreTestingSelections_ResponseSyntax) **
The returned restore testing selections associated with the restore testing plan.
Type: Array of [RestoreTestingSelectionForList](API_RestoreTestingSelectionForList.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns a list of existing scan jobs for an authenticated account for the last 30 days.
## Request Syntax
```
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 Request Parameters
The request uses the following URI parameters.
** [ByAccountId](#API_ListScanJobs_RequestSyntax) **
The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.
If used from an AWS Organizations management account, passing `*` returns all jobs across the organization.
Pattern: `^[0-9]{12}$`
** [ByBackupVaultName](#API_ListScanJobs_RequestSyntax) **
Returns only scan jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
Pattern: `^[a-zA-Z0-9\-\_\.]{2,50}$`
** [ByCompleteAfter](#API_ListScanJobs_RequestSyntax) **
Returns only scan jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
** [ByCompleteBefore](#API_ListScanJobs_RequestSyntax) **
Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
** [ByMalwareScanner](#API_ListScanJobs_RequestSyntax) **
Returns only the scan jobs for the specified malware scanner. Currently only supports `GUARDDUTY`.
Valid Values: `GUARDDUTY`
** [ByRecoveryPointArn](#API_ListScanJobs_RequestSyntax) **
Returns only the scan jobs that are ran against the specified recovery point.
** [ByResourceArn](#API_ListScanJobs_RequestSyntax) **
Returns only scan jobs that match the specified resource Amazon Resource Name (ARN).
** [ByResourceType](#API_ListScanJobs_RequestSyntax) **
Returns restore testing selections by the specified restore testing plan name.
+ `EBS`for Amazon Elastic Block Store
+ `EC2`for Amazon Elastic Compute Cloud
+ `S3`for Amazon Simple Storage Service (Amazon S3)
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Valid Values: `EBS | EC2 | S3`
** [ByScanResultStatus](#API_ListScanJobs_RequestSyntax) **
Returns only the scan jobs for the specified scan results:
+ `THREATS_FOUND`
+ `NO_THREATS_FOUND`
Valid Values: `NO_THREATS_FOUND | THREATS_FOUND`
** [ByState](#API_ListScanJobs_RequestSyntax) **
Returns only the scan jobs for the specified scanning job state.
Valid Values: `CANCELED | COMPLETED | COMPLETED_WITH_ISSUES | CREATED | FAILED | RUNNING`
** [MaxResults](#API_ListScanJobs_RequestSyntax) **
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_ListScanJobs_RequestSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_ListScanJobs_ResponseSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
** [ScanJobs](#API_ListScanJobs_ResponseSyntax) **
An array of structures containing metadata about your scan jobs returned in JSON format.
Type: Array of [ScanJob](API_ScanJob.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This is a request for a summary of scan jobs created or running within the most recent 30 days.
## Request Syntax
```
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 Request Parameters
The request uses the following URI parameters.
** [AccountId](#API_ListScanJobSummaries_RequestSyntax) **
Returns the job count for the specified account.
If the request is sent from a member account or an account not part of AWS Organizations, jobs within requestor's account will be returned.
Root, admin, and delegated administrator accounts can use the value `ANY` to return job counts from every account in the organization.
`AGGREGATE_ALL` aggregates job counts from all accounts within the authenticated organization, then returns the sum.
Pattern: `^[0-9]{12}$`
** [AggregationPeriod](#API_ListScanJobSummaries_RequestSyntax) **
The period for the returned results.
+ `ONE_DAY`The daily job count for the prior 1 day.
+ `SEVEN_DAYS`The daily job count for the prior 7 days.
+ `FOURTEEN_DAYS`The daily job count for the prior 14 days.
Valid Values: `ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS`
** [MalwareScanner](#API_ListScanJobSummaries_RequestSyntax) **
Returns only the scan jobs for the specified malware scanner. Currently the only MalwareScanner is `GUARDDUTY`. But the field also supports `ANY`, and `AGGREGATE_ALL`.
Valid Values: `GUARDDUTY`
** [MaxResults](#API_ListScanJobSummaries_RequestSyntax) **
The maximum number of items to be returned.
The value is an integer. Range of accepted values is from 1 to 500.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_ListScanJobSummaries_RequestSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
** [ResourceType](#API_ListScanJobSummaries_RequestSyntax) **
Returns the job count for the specified resource type. Use request `GetSupportedResourceTypes` to obtain strings for supported resource types.
The the value `ANY` returns count of all resource types.
`AGGREGATE_ALL` aggregates job counts for all resource types and returns the sum.
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
** [ScanResultStatus](#API_ListScanJobSummaries_RequestSyntax) **
Returns only the scan jobs for the specified scan results.
Valid Values: `NO_THREATS_FOUND | THREATS_FOUND`
** [State](#API_ListScanJobSummaries_RequestSyntax) **
Returns only the scan jobs for the specified scanning job state.
Valid Values: `CREATED | COMPLETED | COMPLETED_WITH_ISSUES | RUNNING | FAILED | CANCELED | AGGREGATE_ALL | ANY`
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [AggregationPeriod](#API_ListScanJobSummaries_ResponseSyntax) **
The period for the returned results.
+ `ONE_DAY`The daily job count for the prior 1 day.
+ `SEVEN_DAYS`The daily job count for the prior 7 days.
+ `FOURTEEN_DAYS`The daily job count for the prior 14 days.
Valid Values: `'ONE_DAY'` \$1 `'SEVEN_DAYS'` \$1 `'FOURTEEN_DAYS'`
Type: String
** [NextToken](#API_ListScanJobSummaries_ResponseSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
** [ScanJobSummaries](#API_ListScanJobSummaries_ResponseSyntax) **
The summary information.
Type: Array of [ScanJobSummary](API_ScanJobSummary.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns the tags assigned to the resource, such as a target recovery point, backup plan, or backup vault.
This operation returns results depending on the resource type used in the value for `resourceArn`. For example, recovery points of Amazon DynamoDB with Advanced Settings have an ARN (Amazon Resource Name) that begins with `arn:aws:backup`. Recovery points (backups) of DynamoDB without Advanced Settings enabled have an ARN that begins with `arn:aws:dynamodb`.
When this operation is called and when you include values of `resourceArn` that have an ARN other than `arn:aws:backup`, it may return one of the exceptions listed below. To prevent this exception, include only values representing resource types that are fully managed by AWS Backup. These have an ARN that begins `arn:aws:backup` and they are noted in the [Feature availability by resource](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource) table.
## Request Syntax
```
GET /tags/resourceArn/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [MaxResults](#API_ListTags_RequestSyntax) **
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_ListTags_RequestSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
** [resourceArn](#API_ListTags_RequestSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the type of resource. Valid targets for `ListTags` are recovery points, backup plans, and backup vaults.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Tags": {
"string" : "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_ListTags_ResponseSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
** [Tags](#API_ListTags_ResponseSyntax) **
Information about the tags.
Type: String to string map
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Returns a list of tiering configurations.
## Request Syntax
```
GET /tiering-configurations/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [MaxResults](#API_ListTieringConfigurations_RequestSyntax) **
The maximum number of items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_ListTieringConfigurations_RequestSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"TieringConfigurations": [
{
"BackupVaultName": "string",
"CreationTime": number,
"LastUpdatedTime": number,
"TieringConfigurationArn": "string",
"TieringConfigurationName": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_ListTieringConfigurations_ResponseSyntax) **
The next item following a partial list of returned items. For example, if a request is made to return `MaxResults` number of items, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
** [TieringConfigurations](#API_ListTieringConfigurations_ResponseSyntax) **
An array of tiering configurations returned by the `ListTieringConfigurations` call.
Type: Array of [TieringConfigurationsListMember](API_TieringConfigurationsListMember.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format.
## Request Syntax
```
PUT /backup-vaults/backupVaultName/access-policy HTTP/1.1
Content-type: application/json
{
"Policy": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupVaultName](#API_PutBackupVaultAccessPolicy_RequestSyntax) **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [Policy](#API_PutBackupVaultAccessPolicy_RequestSyntax) **
The backup vault access policy document in JSON format.
Type: String
Required: No
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Applies AWS Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and maximum retention period for future backup and copy jobs that target a backup vault.
**Note**
AWS Backup Vault Lock has been assessed by Cohasset Associates for use in environments that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about how AWS Backup Vault Lock relates to these regulations, see the [Cohasset Associates Compliance Assessment.](https://docs.aws.amazon.com/aws-backup/latest/devguide/samples/cohassetreport.zip)
For more information, see [AWS Backup Vault Lock](https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html).
## Request Syntax
```
PUT /backup-vaults/backupVaultName/vault-lock HTTP/1.1
Content-type: application/json
{
"ChangeableForDays": number,
"MaxRetentionDays": number,
"MinRetentionDays": number
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupVaultName](#API_PutBackupVaultLockConfiguration_RequestSyntax) **
The AWS Backup Vault Lock configuration that specifies the name of the backup vault it protects.
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [ChangeableForDays](#API_PutBackupVaultLockConfiguration_RequestSyntax) **
The AWS Backup Vault Lock configuration that specifies the number of days before the lock date. For example, setting `ChangeableForDays` to 30 on Jan. 1, 2022 at 8pm UTC will set the lock date to Jan. 31, 2022 at 8pm UTC.
AWS Backup enforces a 72-hour cooling-off period before Vault Lock takes effect and becomes immutable. Therefore, you must set `ChangeableForDays` to 3 or greater.
The maximum value you can specify is 36,500 days (approximately 100 years).
Before the lock date, you can delete Vault Lock from the vault using `DeleteBackupVaultLockConfiguration` or change the Vault Lock configuration using `PutBackupVaultLockConfiguration`. On and after the lock date, the Vault Lock becomes immutable and cannot be changed or deleted.
If this parameter is not specified, you can delete Vault Lock from the vault using `DeleteBackupVaultLockConfiguration` or change the Vault Lock configuration using `PutBackupVaultLockConfiguration` at any time.
Type: Long
Required: No
** [MaxRetentionDays](#API_PutBackupVaultLockConfiguration_RequestSyntax) **
The AWS Backup Vault Lock configuration that specifies the maximum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to destroy certain data after retaining it for four years (1460 days).
If this parameter is not included, Vault Lock does not enforce a maximum retention period on the recovery points in the vault. If this parameter is included without a value, Vault Lock will not enforce a maximum retention period.
If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. The longest maximum retention period you can specify is 36500 days (approximately 100 years). Recovery points already saved in the vault prior to Vault Lock are not affected.
Type: Long
Required: No
** [MinRetentionDays](#API_PutBackupVaultLockConfiguration_RequestSyntax) **
The AWS Backup Vault Lock configuration that specifies the minimum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to retain certain data for at least seven years (2555 days).
This parameter is required when a vault lock is created through AWS CloudFormation; otherwise, this parameter is optional. If this parameter is not specified, Vault Lock will not enforce a minimum retention period.
If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails that backup or copy job, and you should either modify your lifecycle settings or use a different vault. The shortest minimum retention period you can specify is 1 day. Recovery points already saved in the vault prior to Vault Lock are not affected.
Type: Long
Required: No
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** InvalidRequestException **
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Turns on notifications on a backup vault for the specified topic and events.
## Request Syntax
```
PUT /backup-vaults/backupVaultName/notification-configuration HTTP/1.1
Content-type: application/json
{
"BackupVaultEvents": [ "string" ],
"SNSTopicArn": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupVaultName](#API_PutBackupVaultNotifications_RequestSyntax) **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [BackupVaultEvents](#API_PutBackupVaultNotifications_RequestSyntax) **
An array of events that indicate the status of jobs to back up resources to the backup vault. For the list of supported events, common use cases, and code samples, see [Notification options with AWS Backup](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-notifications.html).
The list below includes both supported events and deprecated events that are no longer in use (for reference). Deprecated events do not return statuses or notifications.
Type: Array of strings
Valid Values: `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`
Required: Yes
** [SNSTopicArn](#API_PutBackupVaultNotifications_RequestSyntax) **
The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, `arn:aws:sns:us-west-2:111122223333:MyVaultTopic`.
Type: String
Required: Yes
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This request allows you to send your independent self-run restore test validation results. `RestoreJobId` and `ValidationStatus` are required. Optionally, you can input a `ValidationStatusMessage`.
## Request Syntax
```
PUT /restore-jobs/restoreJobId/validations HTTP/1.1
Content-type: application/json
{
"ValidationStatus": "string",
"ValidationStatusMessage": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [restoreJobId](#API_PutRestoreValidationResult_RequestSyntax) **
This is a unique identifier of a restore job within AWS Backup.
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [ValidationStatus](#API_PutRestoreValidationResult_RequestSyntax) **
The status of your restore validation.
Type: String
Valid Values: `FAILED | SUCCESSFUL | TIMED_OUT | VALIDATING`
Required: Yes
** [ValidationStatusMessage](#API_PutRestoreValidationResult_RequestSyntax) **
This is an optional message string you can input to describe the validation status for the restore test validation.
Type: String
Required: No
## Response Syntax
```
HTTP/1.1 204
```
## Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** InvalidRequestException **
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Revokes access to a restore access backup vault, removing the ability to restore from its recovery points and permanently deleting the vault.
## Request Syntax
```
DELETE /logically-air-gapped-backup-vaults/backupVaultName/restore-access-backup-vaults/restoreAccessBackupVaultArn?requesterComment=RequesterComment HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupVaultName](#API_RevokeRestoreAccessBackupVault_RequestSyntax) **
The name of the source backup vault associated with the restore access backup vault to be revoked.
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
** [RequesterComment](#API_RevokeRestoreAccessBackupVault_RequestSyntax) **
A comment explaining the reason for revoking access to the restore access backup vault.
** [restoreAccessBackupVaultArn](#API_RevokeRestoreAccessBackupVault_RequestSyntax) **
The ARN of the restore access backup vault to revoke.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** InvalidRequestException **
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Starts an on-demand backup job for the specified resource.
## Request Syntax
```
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 Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [BackupOptions](#API_StartBackupJob_RequestSyntax) **
The backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
Valid values: Set to `"WindowsVSS":"enabled"` to enable the `WindowsVSS` backup option and create a Windows VSS backup. Set to `"WindowsVSS""disabled"` to create a regular backup. The `WindowsVSS` option is not enabled by default.
Type: String to string map
Key Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Value Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Required: No
** [BackupVaultName](#API_StartBackupJob_RequestSyntax) **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
Type: String
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
** [CompleteWindowMinutes](#API_StartBackupJob_RequestSyntax) **
A value in minutes during which a successfully started backup must complete, or else AWS Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for `StartWindowMinutes`, or if the backup started later than scheduled.
Like `StartWindowMinutes`, this parameter has a maximum value of 100 years (52,560,000 minutes).
Type: Long
Required: No
** [IamRoleArn](#API_StartBackupJob_RequestSyntax) **
Specifies the IAM role ARN used to create the target recovery point; for example, `arn:aws:iam::123456789012:role/S3Access`.
Type: String
Required: Yes
** [IdempotencyToken](#API_StartBackupJob_RequestSyntax) **
A customer-chosen string that you can use to distinguish between otherwise identical calls to `StartBackupJob`. Retrying a successful request with the same idempotency token results in a success message with no action taken.
Type: String
Required: No
** [Index](#API_StartBackupJob_RequestSyntax) **
Include this parameter to enable index creation if your backup job has a resource type that supports backup indexes.
Resource types that support backup indexes include:
+ `EBS` for Amazon Elastic Block Store
+ `S3` for Amazon Simple Storage Service (Amazon S3)
Index can have 1 of 2 possible values, either `ENABLED` or `DISABLED`.
To create a backup index for an eligible `ACTIVE` recovery point that does not yet have a backup index, set value to `ENABLED`.
To delete a backup index, set value to `DISABLED`.
Type: String
Valid Values: `ENABLED | DISABLED`
Required: No
** [Lifecycle](#API_StartBackupJob_RequestSyntax) **
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup will transition and expire backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that can transition to cold storage are listed in the [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.
This parameter has a maximum value of 100 years (36,500 days).
Type: [Lifecycle](API_Lifecycle.md) object
Required: No
** [LogicallyAirGappedBackupVaultArn](#API_StartBackupJob_RequestSyntax) **
The ARN of a logically air-gapped vault. ARN must be in the same account and Region. If provided, supported fully managed resources back up directly to logically air-gapped vault, while other supported resources create a temporary (billable) snapshot in backup vault, then copy it to logically air-gapped vault. Unsupported resources only back up to the specified backup vault.
Type: String
Required: No
** [RecoveryPointTags](#API_StartBackupJob_RequestSyntax) **
The tags to assign to the resources.
Type: String to string map
Required: No
** [ResourceArn](#API_StartBackupJob_RequestSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
Type: String
Required: Yes
** [StartWindowMinutes](#API_StartBackupJob_RequestSyntax) **
A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours. If this value is included, it must be at least 60 minutes to avoid errors.
This parameter has a maximum value of 100 years (52,560,000 minutes).
During the start window, the backup job status remains in `CREATED` status until it has successfully begun or until the start window time has run out. If within the start window time AWS Backup receives an error that allows the job to be retried, AWS Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to `RUNNING`) or until the job status changes to `EXPIRED` (which is expected to occur when the start window time is over).
Type: Long
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"BackupJobId": "string",
"CreationDate": number,
"IsParent": boolean,
"RecoveryPointArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BackupJobId](#API_StartBackupJob_ResponseSyntax) **
Uniquely identifies a request to AWS Backup to back up a resource.
Type: String
** [CreationDate](#API_StartBackupJob_ResponseSyntax) **
The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [IsParent](#API_StartBackupJob_ResponseSyntax) **
This is a returned boolean value indicating this is a parent (composite) backup job.
Type: Boolean
** [RecoveryPointArn](#API_StartBackupJob_ResponseSyntax) **
*Note: This field is only returned for Amazon EFS and Advanced DynamoDB resources.*
An ARN that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** InvalidRequestException **
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
** Context **
** Type **
HTTP Status Code: 400
** LimitExceededException **
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Starts a job to create a one-time copy of the specified resource.
Does not support continuous backups.
See [Copy job retry](https://docs.aws.amazon.com/aws-backup/latest/devguide/recov-point-create-a-copy.html#backup-copy-retry) for information on how AWS Backup retries copy job operations.
## Request Syntax
```
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 Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [DestinationBackupVaultArn](#API_StartCopyJob_RequestSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to copy to; for example, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
Type: String
Required: Yes
** [IamRoleArn](#API_StartCopyJob_RequestSyntax) **
Specifies the IAM role ARN used to copy the target recovery point; for example, `arn:aws:iam::123456789012:role/S3Access`.
Type: String
Required: Yes
** [IdempotencyToken](#API_StartCopyJob_RequestSyntax) **
A customer-chosen string that you can use to distinguish between otherwise identical calls to `StartCopyJob`. Retrying a successful request with the same idempotency token results in a success message with no action taken.
Type: String
Required: No
** [Lifecycle](#API_StartCopyJob_RequestSyntax) **
Specifies the time period, in days, before a recovery point transitions to cold storage or is deleted.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the retention setting must be 90 days greater than the transition to cold after days setting. The transition to cold after days setting can't be changed after a backup has been transitioned to cold.
Resource types that can transition to cold storage are listed in the [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.
To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, specify -1 for `MoveToColdStorageAfterDays` and `DeleteAfterDays`.
Type: [Lifecycle](API_Lifecycle.md) object
Required: No
** [RecoveryPointArn](#API_StartCopyJob_RequestSyntax) **
An ARN that uniquely identifies a recovery point to use for the copy job; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Type: String
Required: Yes
** [SourceBackupVaultName](#API_StartCopyJob_RequestSyntax) **
The name of a logical source container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
Type: String
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"CopyJobId": "string",
"CreationDate": number,
"IsParent": boolean
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [CopyJobId](#API_StartCopyJob_ResponseSyntax) **
Uniquely identifies a copy job.
Type: String
** [CreationDate](#API_StartCopyJob_ResponseSyntax) **
The date and time that a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [IsParent](#API_StartCopyJob_ResponseSyntax) **
This is a returned boolean value indicating this is a parent (composite) copy job.
Type: Boolean
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** InvalidRequestException **
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
** Context **
** Type **
HTTP Status Code: 400
** LimitExceededException **
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Starts an on-demand report job for the specified report plan.
## Request Syntax
```
POST /audit/report-jobs/reportPlanName HTTP/1.1
Content-type: application/json
{
"IdempotencyToken": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [reportPlanName](#API_StartReportJob_RequestSyntax) **
The unique name of a report plan.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z][_a-zA-Z0-9]*`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [IdempotencyToken](#API_StartReportJob_RequestSyntax) **
A customer-chosen string that you can use to distinguish between otherwise identical calls to `StartReportJobInput`. Retrying a successful request with the same idempotency token results in a success message with no action taken.
Type: String
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"ReportJobId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ReportJobId](#API_StartReportJob_ResponseSyntax) **
The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. The report job ID cannot be edited.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Recovers the saved resource identified by an Amazon Resource Name (ARN).
## Request Syntax
```
PUT /restore-jobs HTTP/1.1
Content-type: application/json
{
"CopySourceTagsToRestoredResource": boolean,
"IamRoleArn": "string",
"IdempotencyToken": "string",
"Metadata": {
"string" : "string"
},
"RecoveryPointArn": "string",
"ResourceType": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [CopySourceTagsToRestoredResource](#API_StartRestoreJob_RequestSyntax) **
This is an optional parameter. If this equals `True`, tags included in the backup will be copied to the restored resource.
This can only be applied to backups created through AWS Backup.
Type: Boolean
Required: No
** [IamRoleArn](#API_StartRestoreJob_RequestSyntax) **
The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create the target resource; for example: `arn:aws:iam::123456789012:role/S3Access`.
Type: String
Required: No
** [IdempotencyToken](#API_StartRestoreJob_RequestSyntax) **
A customer-chosen string that you can use to distinguish between otherwise identical calls to `StartRestoreJob`. Retrying a successful request with the same idempotency token results in a success message with no action taken.
Type: String
Required: No
** [Metadata](#API_StartRestoreJob_RequestSyntax) **
A set of metadata key-value pairs.
You can get configuration metadata about a resource at the time it was backed up by calling `GetRecoveryPointRestoreMetadata`. However, values in addition to those provided by `GetRecoveryPointRestoreMetadata` might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.
For more information about the metadata for each resource, see the following:
+ [Metadata for Amazon Aurora](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-aur.html#aur-restore-cli)
+ [Metadata for Amazon DocumentDB](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-docdb.html#docdb-restore-cli)
+ [Metadata for AWS CloudFormation](https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-application-stacks.html#restoring-cfn-cli)
+ [Metadata for Amazon DynamoDB](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-dynamodb.html#ddb-restore-cli)
+ [ Metadata for Amazon EBS](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-ebs.html#ebs-restore-cli)
+ [Metadata for Amazon EC2](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-ec2.html#restoring-ec2-cli)
+ [Metadata for Amazon EFS](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-efs.html#efs-restore-cli)
+ [Metadata for Amazon EKS](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-eks.html#eks-restore-backup-section)
+ [Metadata for Amazon FSx](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-fsx.html#fsx-restore-cli)
+ [Metadata for Amazon Neptune](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-nep.html#nep-restore-cli)
+ [Metadata for Amazon RDS](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-rds.html#rds-restore-cli)
+ [Metadata for Amazon Redshift](https://docs.aws.amazon.com/aws-backup/latest/devguide/redshift-restores.html#redshift-restore-api)
+ [Metadata for AWS Storage Gateway](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-storage-gateway.html#restoring-sgw-cli)
+ [Metadata for Amazon S3](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-s3.html#s3-restore-cli)
+ [Metadata for Amazon Timestream](https://docs.aws.amazon.com/aws-backup/latest/devguide/timestream-restore.html#timestream-restore-api)
+ [Metadata for virtual machines](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-vm.html#vm-restore-cli)
Type: String to string map
Required: Yes
** [RecoveryPointArn](#API_StartRestoreJob_RequestSyntax) **
An ARN that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Type: String
Required: Yes
** [ResourceType](#API_StartRestoreJob_RequestSyntax) **
Starts a job to restore a recovery point for one of the following resources:
+ `Aurora` - Amazon Aurora
+ `DocumentDB` - Amazon DocumentDB
+ `CloudFormation` - AWS CloudFormation
+ `DynamoDB` - Amazon DynamoDB
+ `EBS` - Amazon Elastic Block Store
+ `EC2` - Amazon Elastic Compute Cloud
+ `EFS` - Amazon Elastic File System
+ `EKS` - Amazon Elastic Kubernetes Service
+ `FSx` - Amazon FSx
+ `Neptune` - Amazon Neptune
+ `RDS` - Amazon Relational Database Service
+ `Redshift` - Amazon Redshift
+ `Storage Gateway` - AWS Storage Gateway
+ `S3` - Amazon Simple Storage Service
+ `Timestream` - Amazon Timestream
+ `VirtualMachine` - Virtual machines
Type: String
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"RestoreJobId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [RestoreJobId](#API_StartRestoreJob_ResponseSyntax) **
Uniquely identifies the job that restores a recovery point.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** InvalidRequestException **
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Starts scanning jobs for specific resources.
## Request Syntax
```
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 Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [BackupVaultName](#API_StartScanJob_RequestSyntax) **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Type: String
Required: Yes
** [IamRoleArn](#API_StartScanJob_RequestSyntax) **
Specifies the IAM role ARN used to create the target recovery point; for example, `arn:aws:iam::123456789012:role/S3Access`.
Type: String
Required: Yes
** [IdempotencyToken](#API_StartScanJob_RequestSyntax) **
A customer-chosen string that you can use to distinguish between otherwise identical calls to `StartScanJob`. Retrying a successful request with the same idempotency token results in a success message with no action taken.
Type: String
Required: No
** [MalwareScanner](#API_StartScanJob_RequestSyntax) **
Specifies the malware scanner used during the scan job. Currently only supports `GUARDDUTY`.
Type: String
Valid Values: `GUARDDUTY`
Required: Yes
** [RecoveryPointArn](#API_StartScanJob_RequestSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a recovery point. This is your target recovery point for a full scan. If you are running an incremental scan, this will be your a recovery point which has been created after your base recovery point selection.
Type: String
Required: Yes
** [ScanBaseRecoveryPointArn](#API_StartScanJob_RequestSyntax) **
An ARN that uniquely identifies the base recovery point to be used for incremental scanning.
Type: String
Required: No
** [ScanMode](#API_StartScanJob_RequestSyntax) **
Specifies the scan type use for the scan job.
Includes:
+ `FULL_SCAN` will scan the entire data lineage within the backup.
+ `INCREMENTAL_SCAN` will scan the data difference between the target recovery point and base recovery point ARN.
Type: String
Valid Values: `FULL_SCAN | INCREMENTAL_SCAN`
Required: Yes
** [ScannerRoleArn](#API_StartScanJob_RequestSyntax) **
Specified the IAM scanner role ARN.
Type: String
Required: Yes
## Response Syntax
```
HTTP/1.1 201
Content-type: application/json
{
"CreationDate": number,
"ScanJobId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
** [CreationDate](#API_StartScanJob_ResponseSyntax) **
The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [ScanJobId](#API_StartScanJob_ResponseSyntax) **
Uniquely identifies a request to AWS Backup to back up a resource.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** InvalidRequestException **
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
** Context **
** Type **
HTTP Status Code: 400
** LimitExceededException **
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Attempts to cancel a job to create a one-time backup of a resource.
This action is not supported for the following services:
+ Amazon Aurora
+ Amazon DocumentDB (with MongoDB compatibility)
+ Amazon FSx for Lustre
+ Amazon FSx for NetApp ONTAP
+ Amazon FSx for OpenZFS
+ Amazon FSx for Windows File Server
+ Amazon Neptune
+ SAP HANA databases on Amazon EC2 instances
+ Amazon RDS
## Request Syntax
```
POST /backup-jobs/backupJobId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupJobId](#API_StopBackupJob_RequestSyntax) **
Uniquely identifies a request to AWS Backup to back up a resource.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** InvalidRequestException **
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Assigns a set of key-value pairs to a resource.
## Request Syntax
```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json
{
"Tags": {
"string" : "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [resourceArn](#API_TagResource_RequestSyntax) **
The ARN that uniquely identifies the resource.
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [Tags](#API_TagResource_RequestSyntax) **
Key-value pairs that are used to help organize your resources. You can assign your own metadata to the resources you create. For clarity, this is the structure to assign tags: `[{"Key":"string","Value":"string"}]`.
Type: String to string map
Required: Yes
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** LimitExceededException **
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
This API is not supported for recovery points for resource types including Aurora, Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune, and Amazon RDS.
## Request Syntax
```
POST /untag/resourceArn HTTP/1.1
Content-type: application/json
{
"TagKeyList": [ "string" ]
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [resourceArn](#API_UntagResource_RequestSyntax) **
An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.
ARNs that do not include `backup` are incompatible with tagging. `TagResource` and `UntagResource` with invalid ARNs will result in an error. Acceptable ARN content can include `arn:aws:backup:us-east`. Invalid ARN content may look like `arn:aws:ec2:us-east`.
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [TagKeyList](#API_UntagResource_RequestSyntax) **
The keys to identify which key-value tags to remove from a resource.
Type: Array of strings
Required: Yes
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Updates the specified backup plan. The new version is uniquely identified by its ID.
## Request Syntax
```
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 Request Parameters
The request uses the following URI parameters.
** [backupPlanId](#API_UpdateBackupPlan_RequestSyntax) **
The ID of the backup plan.
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [BackupPlan](#API_UpdateBackupPlan_RequestSyntax) **
The body of a backup plan. Includes a `BackupPlanName` and one or more sets of `Rules`.
Type: [BackupPlanInput](API_BackupPlanInput.md) object
Required: Yes
## Response Syntax
```
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"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [AdvancedBackupSettings](#API_UpdateBackupPlan_ResponseSyntax) **
Contains a list of `BackupOptions` for each resource type.
Type: Array of [AdvancedBackupSetting](API_AdvancedBackupSetting.md) objects
** [BackupPlanArn](#API_UpdateBackupPlan_ResponseSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, `arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50`.
Type: String
** [BackupPlanId](#API_UpdateBackupPlan_ResponseSyntax) **
Uniquely identifies a backup plan.
Type: String
** [CreationDate](#API_UpdateBackupPlan_ResponseSyntax) **
The date and time a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [ScanSettings](#API_UpdateBackupPlan_ResponseSyntax) **
Contains your scanning configuration for the backup plan and includes the Malware scanner, your selected resources, and scanner role.
Type: Array of [ScanSetting](API_ScanSetting.md) objects
** [VersionId](#API_UpdateBackupPlan_ResponseSyntax) **
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Updates the specified framework.
## Request Syntax
```
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 Request Parameters
The request uses the following URI parameters.
** [frameworkName](#API_UpdateFramework_RequestSyntax) **
The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (\$1).
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z][_a-zA-Z0-9]*`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [FrameworkControls](#API_UpdateFramework_RequestSyntax) **
The controls that make up the framework. Each control in the list has a name, input parameters, and scope.
Type: Array of [FrameworkControl](API_FrameworkControl.md) objects
Required: No
** [FrameworkDescription](#API_UpdateFramework_RequestSyntax) **
An optional description of the framework with a maximum 1,024 characters.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: `.*\S.*`
Required: No
** [IdempotencyToken](#API_UpdateFramework_RequestSyntax) **
A customer-chosen string that you can use to distinguish between otherwise identical calls to `UpdateFrameworkInput`. Retrying a successful request with the same idempotency token results in a success message with no action taken.
Type: String
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"FrameworkArn": "string",
"FrameworkName": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [CreationTime](#API_UpdateFramework_ResponseSyntax) **
The date and time that a framework is created, in ISO 8601 representation. The value of `CreationTime` is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.
Type: Timestamp
** [FrameworkArn](#API_UpdateFramework_ResponseSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
Type: String
** [FrameworkName](#API_UpdateFramework_ResponseSyntax) **
The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (\$1).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z][_a-zA-Z0-9]*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AlreadyExistsException **
The required resource already exists.
** Arn **
** Context **
** CreatorRequestId **
** Type **
HTTP Status Code: 400
** ConflictException **
AWS Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
** Context **
** Type **
HTTP Status Code: 400
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** LimitExceededException **
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Updates whether the AWS account has enabled different cross-account management options, including cross-account backup, multi-party approval, and delegated administrator. Returns an error if the account is not an Organizations management account. Use the `DescribeGlobalSettings` API to determine the current settings.
## Request Syntax
```
PUT /global-settings HTTP/1.1
Content-type: application/json
{
"GlobalSettings": {
"string" : "string"
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [GlobalSettings](#API_UpdateGlobalSettings_RequestSyntax) **
Inputs can include:
A value for `isCrossAccountBackupEnabled`. Values can be true or false. Example: `update-global-settings --global-settings isCrossAccountBackupEnabled=false`.
A value for Multi-party approval, styled as `isMpaEnabled`. Values can be true or false. Example: `update-global-settings --global-settings isMpaEnabled=false`.
A value for Backup Service-Linked Role creation, styled as `isDelegatedAdministratorEnabled`. Values can be true or false. Example: `update-global-settings --global-settings isDelegatedAdministratorEnabled=false`.
Type: String to string map
Required: No
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** InvalidRequestException **
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This operation updates the settings of a recovery point index.
Required: BackupVaultName, RecoveryPointArn, and IAMRoleArn
## Request Syntax
```
POST /backup-vaults/backupVaultName/recovery-points/recoveryPointArn/index HTTP/1.1
Content-type: application/json
{
"IamRoleArn": "string",
"Index": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupVaultName](#API_UpdateRecoveryPointIndexSettings_RequestSyntax) **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
Accepted characters include lowercase letters, numbers, and hyphens.
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
** [recoveryPointArn](#API_UpdateRecoveryPointIndexSettings_RequestSyntax) **
An ARN that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [IamRoleArn](#API_UpdateRecoveryPointIndexSettings_RequestSyntax) **
This specifies the IAM role ARN used for this operation.
For example, arn:aws:iam::123456789012:role/S3Access
Type: String
Required: No
** [Index](#API_UpdateRecoveryPointIndexSettings_RequestSyntax) **
Index can have 1 of 2 possible values, either `ENABLED` or `DISABLED`.
To create a backup index for an eligible `ACTIVE` recovery point that does not yet have a backup index, set value to `ENABLED`.
To delete a backup index, set value to `DISABLED`.
Type: String
Valid Values: `ENABLED | DISABLED`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"BackupVaultName": "string",
"Index": "string",
"IndexStatus": "string",
"RecoveryPointArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BackupVaultName](#API_UpdateRecoveryPointIndexSettings_ResponseSyntax) **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
Type: String
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
** [Index](#API_UpdateRecoveryPointIndexSettings_ResponseSyntax) **
Index can have 1 of 2 possible values, either `ENABLED` or `DISABLED`.
A value of `ENABLED` means a backup index for an eligible `ACTIVE` recovery point has been created.
A value of `DISABLED` means a backup index was deleted.
Type: String
Valid Values: `ENABLED | DISABLED`
** [IndexStatus](#API_UpdateRecoveryPointIndexSettings_ResponseSyntax) **
This is the current status for the backup index associated with the specified recovery point.
Statuses are: `PENDING` \$1 `ACTIVE` \$1 `FAILED` \$1 `DELETING`
A recovery point with an index that has the status of `ACTIVE` can be included in a search.
Type: String
Valid Values: `PENDING | ACTIVE | FAILED | DELETING`
** [RecoveryPointArn](#API_UpdateRecoveryPointIndexSettings_ResponseSyntax) **
An ARN that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** InvalidRequestException **
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Sets the transition lifecycle of a recovery point.
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.
Resource types that can transition to cold storage are listed in the [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.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
**Important**
If your lifecycle currently uses the parameters `DeleteAfterDays` and `MoveToColdStorageAfterDays`, include these parameters and their values when you call this operation. Not including them may result in your plan updating with null values.
This operation does not support continuous backups.
## Request Syntax
```
POST /backup-vaults/backupVaultName/recovery-points/recoveryPointArn HTTP/1.1
Content-type: application/json
{
"Lifecycle": {
"DeleteAfterDays": number,
"DeleteAfterEvent": "string",
"MoveToColdStorageAfterDays": number,
"OptInToArchiveForSupportedResources": boolean
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [backupVaultName](#API_UpdateRecoveryPointLifecycle_RequestSyntax) **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
** [recoveryPointArn](#API_UpdateRecoveryPointLifecycle_RequestSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [Lifecycle](#API_UpdateRecoveryPointLifecycle_RequestSyntax) **
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Type: [Lifecycle](API_Lifecycle.md) object
Required: No
## Response Syntax
```
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"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BackupVaultArn](#API_UpdateRecoveryPointLifecycle_ResponseSyntax) **
An ARN that uniquely identifies a backup vault; for example, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
Type: String
** [CalculatedLifecycle](#API_UpdateRecoveryPointLifecycle_ResponseSyntax) **
A `CalculatedLifecycle` object containing `DeleteAt` and `MoveToColdStorageAt` timestamps.
Type: [CalculatedLifecycle](API_CalculatedLifecycle.md) object
** [Lifecycle](#API_UpdateRecoveryPointLifecycle_ResponseSyntax) **
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that can transition to cold storage are listed in the [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.
Type: [Lifecycle](API_Lifecycle.md) object
** [RecoveryPointArn](#API_UpdateRecoveryPointLifecycle_ResponseSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** InvalidRequestException **
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Updates the current service opt-in settings for the Region.
Use the `DescribeRegionSettings` API to determine the resource types that are supported.
## Request Syntax
```
PUT /account-settings HTTP/1.1
Content-type: application/json
{
"ResourceTypeManagementPreference": {
"string" : boolean
},
"ResourceTypeOptInPreference": {
"string" : boolean
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [ResourceTypeManagementPreference](#API_UpdateRegionSettings_RequestSyntax) **
Enables or disables full AWS Backup management of backups for a resource type. To enable full AWS Backup management for DynamoDB along with [AWS Backup's advanced DynamoDB backup features](https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html), follow the procedure to [ enable advanced DynamoDB backup programmatically](https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html#advanced-ddb-backup-enable-cli).
Type: String to boolean map
Key Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Required: No
** [ResourceTypeOptInPreference](#API_UpdateRegionSettings_RequestSyntax) **
Updates the list of services along with the opt-in preferences for the Region.
If resource assignments are only based on tags, then service opt-in settings are applied. If a resource type is explicitly assigned to a backup plan, such as Amazon S3, Amazon EC2, or Amazon RDS, it will be included in the backup even if the opt-in is not enabled for that particular service. If both a resource type and tags are specified in a resource assignment, the resource type specified in the backup plan takes priority over the tag condition. Service opt-in settings are disregarded in this situation.
Type: String to boolean map
Key Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Required: No
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Updates the specified report plan.
## Request Syntax
```
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 Request Parameters
The request uses the following URI parameters.
** [reportPlanName](#API_UpdateReportPlan_RequestSyntax) **
The unique name of the report plan. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (\$1).
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z][_a-zA-Z0-9]*`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [IdempotencyToken](#API_UpdateReportPlan_RequestSyntax) **
A customer-chosen string that you can use to distinguish between otherwise identical calls to `UpdateReportPlanInput`. Retrying a successful request with the same idempotency token results in a success message with no action taken.
Type: String
Required: No
** [ReportDeliveryChannel](#API_UpdateReportPlan_RequestSyntax) **
The information about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
Type: [ReportDeliveryChannel](API_ReportDeliveryChannel.md) object
Required: No
** [ReportPlanDescription](#API_UpdateReportPlan_RequestSyntax) **
An optional description of the report plan with a maximum 1,024 characters.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: `.*\S.*`
Required: No
** [ReportSetting](#API_UpdateReportPlan_RequestSyntax) **
The report template for the report. Reports are built using a report template. The report templates are:
`RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT`
If the report template is `RESOURCE_COMPLIANCE_REPORT` or `CONTROL_COMPLIANCE_REPORT`, this API resource also describes the report coverage by AWS Regions and frameworks.
Type: [ReportSetting](API_ReportSetting.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"ReportPlanArn": "string",
"ReportPlanName": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [CreationTime](#API_UpdateReportPlan_ResponseSyntax) **
The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [ReportPlanArn](#API_UpdateReportPlan_ResponseSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
Type: String
** [ReportPlanName](#API_UpdateReportPlan_ResponseSyntax) **
The unique name of the report plan.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z][_a-zA-Z0-9]*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
AWS Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
** Context **
** Type **
HTTP Status Code: 400
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This request will send changes to your specified restore testing plan. `RestoreTestingPlanName` cannot be updated after it is created.
`RecoveryPointSelection` can contain:
+ `Algorithm`
+ `ExcludeVaults`
+ `IncludeVaults`
+ `RecoveryPointTypes`
+ `SelectionWindowDays`
## Request Syntax
```
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 Request Parameters
The request uses the following URI parameters.
** [RestoreTestingPlanName](#API_UpdateRestoreTestingPlan_RequestSyntax) **
The name of the restore testing plan name.
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [RestoreTestingPlan](#API_UpdateRestoreTestingPlan_RequestSyntax) **
Specifies the body of a restore testing plan.
Type: [RestoreTestingPlanForUpdate](API_RestoreTestingPlanForUpdate.md) object
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"RestoreTestingPlanArn": "string",
"RestoreTestingPlanName": "string",
"UpdateTime": number
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [CreationTime](#API_UpdateRestoreTestingPlan_ResponseSyntax) **
The time the resource testing plan was created.
Type: Timestamp
** [RestoreTestingPlanArn](#API_UpdateRestoreTestingPlan_ResponseSyntax) **
Unique ARN (Amazon Resource Name) of the restore testing plan.
Type: String
** [RestoreTestingPlanName](#API_UpdateRestoreTestingPlan_ResponseSyntax) **
The name cannot be changed after creation. The name consists of only alphanumeric characters and underscores. Maximum length is 50.
Type: String
** [UpdateTime](#API_UpdateRestoreTestingPlan_ResponseSyntax) **
The time the update completed for the restore testing plan.
Type: Timestamp
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
AWS Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
** Context **
** Type **
HTTP Status Code: 400
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Updates the specified restore testing selection.
Most elements except the `RestoreTestingSelectionName` can be updated with this request.
You can use either protected resource ARNs or conditions, but not both.
## Request Syntax
```
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 Request Parameters
The request uses the following URI parameters.
** [RestoreTestingPlanName](#API_UpdateRestoreTestingSelection_RequestSyntax) **
The restore testing plan name is required to update the indicated testing plan.
Required: Yes
** [RestoreTestingSelectionName](#API_UpdateRestoreTestingSelection_RequestSyntax) **
The required restore testing selection name of the restore testing selection you wish to update.
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [RestoreTestingSelection](#API_UpdateRestoreTestingSelection_RequestSyntax) **
To update your restore testing selection, you can use either protected resource ARNs or conditions, but not both. That is, if your selection has `ProtectedResourceArns`, requesting an update with the parameter `ProtectedResourceConditions` will be unsuccessful.
Type: [RestoreTestingSelectionForUpdate](API_RestoreTestingSelectionForUpdate.md) object
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"RestoreTestingPlanArn": "string",
"RestoreTestingPlanName": "string",
"RestoreTestingSelectionName": "string",
"UpdateTime": number
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [CreationTime](#API_UpdateRestoreTestingSelection_ResponseSyntax) **
The time the resource testing selection was updated successfully.
Type: Timestamp
** [RestoreTestingPlanArn](#API_UpdateRestoreTestingSelection_ResponseSyntax) **
Unique string that is the name of the restore testing plan.
Type: String
** [RestoreTestingPlanName](#API_UpdateRestoreTestingSelection_ResponseSyntax) **
The restore testing plan with which the updated restore testing selection is associated.
Type: String
** [RestoreTestingSelectionName](#API_UpdateRestoreTestingSelection_ResponseSyntax) **
The returned restore testing selection name.
Type: String
** [UpdateTime](#API_UpdateRestoreTestingSelection_ResponseSyntax) **
The time the update completed for the restore testing selection.
Type: Timestamp
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
AWS Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
** Context **
** Type **
HTTP Status Code: 400
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This request will send changes to your specified tiering configuration. `TieringConfigurationName` cannot be updated after it is created.
`ResourceSelection` can contain:
+ `Resources`
+ `TieringDownSettingsInDays`
+ `ResourceType`
## Request Syntax
```
PUT /tiering-configurations/tieringConfigurationName HTTP/1.1
Content-type: application/json
{
"TieringConfiguration": {
"BackupVaultName": "string",
"ResourceSelection": [
{
"Resources": [ "string" ],
"ResourceType": "string",
"TieringDownSettingsInDays": number
}
]
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [tieringConfigurationName](#API_UpdateTieringConfiguration_RequestSyntax) **
The name of a tiering configuration to update.
Pattern: `^[a-zA-Z0-9_]{1,200}$`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [TieringConfiguration](#API_UpdateTieringConfiguration_RequestSyntax) **
Specifies the body of a tiering configuration.
Type: [TieringConfigurationInputForUpdate](API_TieringConfigurationInputForUpdate.md) object
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"LastUpdatedTime": number,
"TieringConfigurationArn": "string",
"TieringConfigurationName": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [CreationTime](#API_UpdateTieringConfiguration_ResponseSyntax) **
The date and time a tiering configuration was created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.
Type: Timestamp
** [LastUpdatedTime](#API_UpdateTieringConfiguration_ResponseSyntax) **
The date and time a tiering configuration was updated, in Unix format and Coordinated Universal Time (UTC). The value of `LastUpdatedTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.
Type: Timestamp
** [TieringConfigurationArn](#API_UpdateTieringConfiguration_ResponseSyntax) **
An Amazon Resource Name (ARN) that uniquely identifies the updated tiering configuration.
Type: String
** [TieringConfigurationName](#API_UpdateTieringConfiguration_ResponseSyntax) **
This unique string is the name of the tiering configuration.
Type: String
Pattern: `^[a-zA-Z0-9_]{1,200}$`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AlreadyExistsException **
The required resource already exists.
** Arn **
** Context **
** CreatorRequestId **
** Type **
HTTP Status Code: 400
** ConflictException **
AWS Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
** Context **
** Type **
HTTP Status Code: 400
** InvalidParameterValueException **
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
** Context **
** Type **
HTTP Status Code: 400
** LimitExceededException **
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
** Context **
** Type **
HTTP Status Code: 400
** MissingParameterValueException **
Indicates that a required parameter is missing.
** Context **
** Type **
HTTP Status Code: 400
** ResourceNotFoundException **
A resource that is required for the action doesn't exist.
** Context **
** Type **
HTTP Status Code: 400
** ServiceUnavailableException **
The request failed due to a temporary failure of the server.
** Context **
** Type **
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
The following actions are supported by 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
Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.
## Request Syntax
```
{
"GatewayArn": "string",
"ServerArn": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [GatewayArn](#API_BGW_AssociateGatewayToServer_RequestSyntax) **
The Amazon Resource Name (ARN) of the gateway. Use the `ListGateways` operation to return a list of gateways for your account and AWS Region.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 180.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: Yes
** [ServerArn](#API_BGW_AssociateGatewayToServer_RequestSyntax) **
The Amazon Resource Name (ARN) of the server that hosts your virtual machines.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: Yes
## Response Syntax
```
{
"GatewayArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [GatewayArn](#API_BGW_AssociateGatewayToServer_ResponseSyntax) **
The Amazon Resource Name (ARN) of a gateway.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 180.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The operation cannot proceed because it is not supported.
** ErrorCode **
A description of why the operation is not supported.
HTTP Status Code: 400
** InternalServerException **
The operation did not succeed because an internal error occurred. Try again later.
** ErrorCode **
A description of which internal error occured.
HTTP Status Code: 500
** ThrottlingException **
TPS has been limited to protect against intentional or unintentional high request volumes.
** ErrorCode **
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
** ValidationException **
The operation did not succeed because a validation error occurred.
** ErrorCode **
A description of what caused the validation error.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Creates a backup gateway. After you create a gateway, you can associate it with a server using the `AssociateGatewayToServer` operation.
## Request Syntax
```
{
"ActivationKey": "string",
"GatewayDisplayName": "string",
"GatewayType": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ActivationKey](#API_BGW_CreateGateway_RequestSyntax) **
The activation key of the created gateway.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern: `[0-9a-zA-Z\-]+`
Required: Yes
** [GatewayDisplayName](#API_BGW_CreateGateway_RequestSyntax) **
The display name of the created gateway.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9-]*`
Required: Yes
** [GatewayType](#API_BGW_CreateGateway_RequestSyntax) **
The type of created gateway.
Type: String
Valid Values: `BACKUP_VM`
Required: Yes
** [Tags](#API_BGW_CreateGateway_RequestSyntax) **
A list of up to 50 tags to assign to the gateway. Each tag is a key-value pair.
Type: Array of [Tag](API_BGW_Tag.md) objects
Required: No
## Response Syntax
```
{
"GatewayArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [GatewayArn](#API_BGW_CreateGateway_ResponseSyntax) **
The Amazon Resource Name (ARN) of the gateway you create.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 180.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The operation did not succeed because an internal error occurred. Try again later.
** ErrorCode **
A description of which internal error occured.
HTTP Status Code: 500
** ThrottlingException **
TPS has been limited to protect against intentional or unintentional high request volumes.
** ErrorCode **
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
** ValidationException **
The operation did not succeed because a validation error occurred.
** ErrorCode **
A description of what caused the validation error.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Deletes a backup gateway.
## Request Syntax
```
{
"GatewayArn": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [GatewayArn](#API_BGW_DeleteGateway_RequestSyntax) **
The Amazon Resource Name (ARN) of the gateway to delete.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 180.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: Yes
## Response Syntax
```
{
"GatewayArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [GatewayArn](#API_BGW_DeleteGateway_ResponseSyntax) **
The Amazon Resource Name (ARN) of the gateway you deleted.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 180.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The operation did not succeed because an internal error occurred. Try again later.
** ErrorCode **
A description of which internal error occured.
HTTP Status Code: 500
** ResourceNotFoundException **
A resource that is required for the action wasn't found.
** ErrorCode **
A description of which resource wasn't found.
HTTP Status Code: 400
** ThrottlingException **
TPS has been limited to protect against intentional or unintentional high request volumes.
** ErrorCode **
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
** ValidationException **
The operation did not succeed because a validation error occurred.
** ErrorCode **
A description of what caused the validation error.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Deletes a hypervisor.
## Request Syntax
```
{
"HypervisorArn": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [HypervisorArn](#API_BGW_DeleteHypervisor_RequestSyntax) **
The Amazon Resource Name (ARN) of the hypervisor to delete.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: Yes
## Response Syntax
```
{
"HypervisorArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [HypervisorArn](#API_BGW_DeleteHypervisor_ResponseSyntax) **
The Amazon Resource Name (ARN) of the hypervisor you deleted.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The operation cannot proceed because you have insufficient permissions.
** ErrorCode **
A description of why you have insufficient permissions.
HTTP Status Code: 400
** ConflictException **
The operation cannot proceed because it is not supported.
** ErrorCode **
A description of why the operation is not supported.
HTTP Status Code: 400
** InternalServerException **
The operation did not succeed because an internal error occurred. Try again later.
** ErrorCode **
A description of which internal error occured.
HTTP Status Code: 500
** ResourceNotFoundException **
A resource that is required for the action wasn't found.
** ErrorCode **
A description of which resource wasn't found.
HTTP Status Code: 400
** ThrottlingException **
TPS has been limited to protect against intentional or unintentional high request volumes.
** ErrorCode **
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
** ValidationException **
The operation did not succeed because a validation error occurred.
** ErrorCode **
A description of what caused the validation error.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Disassociates a backup gateway from the specified server. After the disassociation process finishes, the gateway can no longer access the virtual machines on the server.
## Request Syntax
```
{
"GatewayArn": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [GatewayArn](#API_BGW_DisassociateGatewayFromServer_RequestSyntax) **
The Amazon Resource Name (ARN) of the gateway to disassociate.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 180.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: Yes
## Response Syntax
```
{
"GatewayArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [GatewayArn](#API_BGW_DisassociateGatewayFromServer_ResponseSyntax) **
The Amazon Resource Name (ARN) of the gateway you disassociated.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 180.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The operation cannot proceed because it is not supported.
** ErrorCode **
A description of why the operation is not supported.
HTTP Status Code: 400
** InternalServerException **
The operation did not succeed because an internal error occurred. Try again later.
** ErrorCode **
A description of which internal error occured.
HTTP Status Code: 500
** ResourceNotFoundException **
A resource that is required for the action wasn't found.
** ErrorCode **
A description of which resource wasn't found.
HTTP Status Code: 400
** ThrottlingException **
TPS has been limited to protect against intentional or unintentional high request volumes.
** ErrorCode **
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
** ValidationException **
The operation did not succeed because a validation error occurred.
** ErrorCode **
A description of what caused the validation error.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Retrieves the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to get a gateway's bandwidth rate limit schedule.
## Request Syntax
```
{
"GatewayArn": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [GatewayArn](#API_BGW_GetBandwidthRateLimitSchedule_RequestSyntax) **
The Amazon Resource Name (ARN) of the gateway. Use the [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) operation to return a list of gateways for your account and AWS Region.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 180.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: Yes
## Response Syntax
```
{
"BandwidthRateLimitIntervals": [
{
"AverageUploadRateLimitInBitsPerSec": number,
"DaysOfWeek": [ number ],
"EndHourOfDay": number,
"EndMinuteOfHour": number,
"StartHourOfDay": number,
"StartMinuteOfHour": number
}
],
"GatewayArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BandwidthRateLimitIntervals](#API_BGW_GetBandwidthRateLimitSchedule_ResponseSyntax) **
An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.
Type: Array of [BandwidthRateLimitInterval](API_BGW_BandwidthRateLimitInterval.md) objects
Array Members: Minimum number of 0 items. Maximum number of 20 items.
** [GatewayArn](#API_BGW_GetBandwidthRateLimitSchedule_ResponseSyntax) **
The Amazon Resource Name (ARN) of the gateway. Use the [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) operation to return a list of gateways for your account and AWS Region.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 180.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The operation did not succeed because an internal error occurred. Try again later.
** ErrorCode **
A description of which internal error occured.
HTTP Status Code: 500
** ResourceNotFoundException **
A resource that is required for the action wasn't found.
** ErrorCode **
A description of which resource wasn't found.
HTTP Status Code: 400
** ThrottlingException **
TPS has been limited to protect against intentional or unintentional high request volumes.
** ErrorCode **
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
** ValidationException **
The operation did not succeed because a validation error occurred.
** ErrorCode **
A description of what caused the validation error.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
By providing the ARN (Amazon Resource Name), this API returns the gateway.
## Request Syntax
```
{
"GatewayArn": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [GatewayArn](#API_BGW_GetGateway_RequestSyntax) **
The Amazon Resource Name (ARN) of the gateway.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 180.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: Yes
## Response Syntax
```
{
"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"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Gateway](#API_BGW_GetGateway_ResponseSyntax) **
By providing the ARN (Amazon Resource Name), this API returns the gateway.
Type: [GatewayDetails](API_BGW_GatewayDetails.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The operation did not succeed because an internal error occurred. Try again later.
** ErrorCode **
A description of which internal error occured.
HTTP Status Code: 500
** ResourceNotFoundException **
A resource that is required for the action wasn't found.
** ErrorCode **
A description of which resource wasn't found.
HTTP Status Code: 400
** ThrottlingException **
TPS has been limited to protect against intentional or unintentional high request volumes.
** ErrorCode **
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
** ValidationException **
The operation did not succeed because a validation error occurred.
** ErrorCode **
A description of what caused the validation error.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This action requests information about the specified hypervisor to which the gateway will connect. A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.
## Request Syntax
```
{
"HypervisorArn": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [HypervisorArn](#API_BGW_GetHypervisor_RequestSyntax) **
The Amazon Resource Name (ARN) of the hypervisor.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: Yes
## Response Syntax
```
{
"Hypervisor": {
"Host": "string",
"HypervisorArn": "string",
"KmsKeyArn": "string",
"LastSuccessfulMetadataSyncTime": number,
"LatestMetadataSyncStatus": "string",
"LatestMetadataSyncStatusMessage": "string",
"LogGroupArn": "string",
"Name": "string",
"State": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Hypervisor](#API_BGW_GetHypervisor_ResponseSyntax) **
Details about the requested hypervisor.
Type: [HypervisorDetails](API_BGW_HypervisorDetails.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The operation did not succeed because an internal error occurred. Try again later.
** ErrorCode **
A description of which internal error occured.
HTTP Status Code: 500
** ResourceNotFoundException **
A resource that is required for the action wasn't found.
** ErrorCode **
A description of which resource wasn't found.
HTTP Status Code: 400
** ThrottlingException **
TPS has been limited to protect against intentional or unintentional high request volumes.
** ErrorCode **
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
** ValidationException **
The operation did not succeed because a validation error occurred.
** ErrorCode **
A description of what caused the validation error.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This action retrieves the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the hypervisor to the properties available in AWS.
## Request Syntax
```
{
"HypervisorArn": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [HypervisorArn](#API_BGW_GetHypervisorPropertyMappings_RequestSyntax) **
The Amazon Resource Name (ARN) of the hypervisor.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: Yes
## Response Syntax
```
{
"HypervisorArn": "string",
"IamRoleArn": "string",
"VmwareToAwsTagMappings": [
{
"AwsTagKey": "string",
"AwsTagValue": "string",
"VmwareCategory": "string",
"VmwareTagName": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [HypervisorArn](#API_BGW_GetHypervisorPropertyMappings_ResponseSyntax) **
The Amazon Resource Name (ARN) of the hypervisor.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `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) **
The Amazon Resource Name (ARN) of the IAM role.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: `arn:(aws|aws-cn|aws-us-gov):iam::([0-9]+):role/(\S+)`
** [VmwareToAwsTagMappings](#API_BGW_GetHypervisorPropertyMappings_ResponseSyntax) **
This is a display of the mappings of VMware tags to the AWS tags.
Type: Array of [VmwareToAwsTagMapping](API_BGW_VmwareToAwsTagMapping.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The operation did not succeed because an internal error occurred. Try again later.
** ErrorCode **
A description of which internal error occured.
HTTP Status Code: 500
** ResourceNotFoundException **
A resource that is required for the action wasn't found.
** ErrorCode **
A description of which resource wasn't found.
HTTP Status Code: 400
** ThrottlingException **
TPS has been limited to protect against intentional or unintentional high request volumes.
** ErrorCode **
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
** ValidationException **
The operation did not succeed because a validation error occurred.
** ErrorCode **
A description of what caused the validation error.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
By providing the ARN (Amazon Resource Name), this API returns the virtual machine.
## Request Syntax
```
{
"ResourceArn": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ResourceArn](#API_BGW_GetVirtualMachine_RequestSyntax) **
The Amazon Resource Name (ARN) of the virtual machine.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: Yes
## Response Syntax
```
{
"VirtualMachine": {
"HostName": "string",
"HypervisorId": "string",
"LastBackupDate": number,
"Name": "string",
"Path": "string",
"ResourceArn": "string",
"VmwareTags": [
{
"VmwareCategory": "string",
"VmwareTagDescription": "string",
"VmwareTagName": "string"
}
]
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [VirtualMachine](#API_BGW_GetVirtualMachine_ResponseSyntax) **
This object contains the basic attributes of `VirtualMachine` contained by the output of `GetVirtualMachine`
Type: [VirtualMachineDetails](API_BGW_VirtualMachineDetails.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The operation did not succeed because an internal error occurred. Try again later.
** ErrorCode **
A description of which internal error occured.
HTTP Status Code: 500
** ResourceNotFoundException **
A resource that is required for the action wasn't found.
** ErrorCode **
A description of which resource wasn't found.
HTTP Status Code: 400
** ThrottlingException **
TPS has been limited to protect against intentional or unintentional high request volumes.
** ErrorCode **
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
** ValidationException **
The operation did not succeed because a validation error occurred.
** ErrorCode **
A description of what caused the validation error.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Connect to a hypervisor by importing its configuration.
## Request Syntax
```
{
"Host": "string",
"KmsKeyArn": "string",
"Name": "string",
"Password": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"Username": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [Host](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **
The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
Type: String
Length Constraints: Minimum length of 3. Maximum length of 128.
Pattern: `.+`
Required: Yes
** [KmsKeyArn](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **
The AWS Key Management Service for the hypervisor.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `(^arn:(aws|aws-cn|aws-us-gov):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)`
Required: No
** [Name](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **
The name of the hypervisor.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9-]*`
Required: Yes
** [Password](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **
The password for the hypervisor.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[ -~]+`
Required: No
** [Tags](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **
The tags of the hypervisor configuration to import.
Type: Array of [Tag](API_BGW_Tag.md) objects
Required: No
** [Username](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **
The username for the hypervisor.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*`
Required: No
## Response Syntax
```
{
"HypervisorArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [HypervisorArn](#API_BGW_ImportHypervisorConfiguration_ResponseSyntax) **
The Amazon Resource Name (ARN) of the hypervisor you disassociated.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The operation cannot proceed because you have insufficient permissions.
** ErrorCode **
A description of why you have insufficient permissions.
HTTP Status Code: 400
** ConflictException **
The operation cannot proceed because it is not supported.
** ErrorCode **
A description of why the operation is not supported.
HTTP Status Code: 400
** InternalServerException **
The operation did not succeed because an internal error occurred. Try again later.
** ErrorCode **
A description of which internal error occured.
HTTP Status Code: 500
** ThrottlingException **
TPS has been limited to protect against intentional or unintentional high request volumes.
** ErrorCode **
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
** ValidationException **
The operation did not succeed because a validation error occurred.
** ErrorCode **
A description of what caused the validation error.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Lists backup gateways owned by an AWS account in an AWS Region. The returned list is ordered by gateway Amazon Resource Name (ARN).
## Request Syntax
```
{
"MaxResults": number,
"NextToken": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [MaxResults](#API_BGW_ListGateways_RequestSyntax) **
The maximum number of gateways to list.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
** [NextToken](#API_BGW_ListGateways_RequestSyntax) **
The next item following a partial list of returned resources. For example, if a request is made to return `MaxResults` number of resources, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `.+`
Required: No
## Response Syntax
```
{
"Gateways": [
{
"GatewayArn": "string",
"GatewayDisplayName": "string",
"GatewayType": "string",
"HypervisorId": "string",
"LastSeenTime": number
}
],
"NextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Gateways](#API_BGW_ListGateways_ResponseSyntax) **
A list of your gateways.
Type: Array of [Gateway](API_BGW_Gateway.md) objects
** [NextToken](#API_BGW_ListGateways_ResponseSyntax) **
The next item following a partial list of returned resources. For example, if a request is made to return `maxResults` number of resources, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `.+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The operation did not succeed because an internal error occurred. Try again later.
** ErrorCode **
A description of which internal error occured.
HTTP Status Code: 500
** ThrottlingException **
TPS has been limited to protect against intentional or unintentional high request volumes.
** ErrorCode **
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
** ValidationException **
The operation did not succeed because a validation error occurred.
** ErrorCode **
A description of what caused the validation error.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Lists your hypervisors.
## Request Syntax
```
{
"MaxResults": number,
"NextToken": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [MaxResults](#API_BGW_ListHypervisors_RequestSyntax) **
The maximum number of hypervisors to list.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
** [NextToken](#API_BGW_ListHypervisors_RequestSyntax) **
The next item following a partial list of returned resources. For example, if a request is made to return `maxResults` number of resources, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `.+`
Required: No
## Response Syntax
```
{
"Hypervisors": [
{
"Host": "string",
"HypervisorArn": "string",
"KmsKeyArn": "string",
"Name": "string",
"State": "string"
}
],
"NextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Hypervisors](#API_BGW_ListHypervisors_ResponseSyntax) **
A list of your `Hypervisor` objects, ordered by their Amazon Resource Names (ARNs).
Type: Array of [Hypervisor](API_BGW_Hypervisor.md) objects
** [NextToken](#API_BGW_ListHypervisors_ResponseSyntax) **
The next item following a partial list of returned resources. For example, if a request is made to return `maxResults` number of resources, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `.+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The operation did not succeed because an internal error occurred. Try again later.
** ErrorCode **
A description of which internal error occured.
HTTP Status Code: 500
** ThrottlingException **
TPS has been limited to protect against intentional or unintentional high request volumes.
** ErrorCode **
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
** ValidationException **
The operation did not succeed because a validation error occurred.
** ErrorCode **
A description of what caused the validation error.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
## Request Syntax
```
{
"ResourceArn": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ResourceArn](#API_BGW_ListTagsForResource_RequestSyntax) **
The Amazon Resource Name (ARN) of the resource's tags to list.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: Yes
## Response Syntax
```
{
"ResourceArn": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ResourceArn](#API_BGW_ListTagsForResource_ResponseSyntax) **
The Amazon Resource Name (ARN) of the resource's tags that you listed.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `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 list of the resource's tags.
Type: Array of [Tag](API_BGW_Tag.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The operation did not succeed because an internal error occurred. Try again later.
** ErrorCode **
A description of which internal error occured.
HTTP Status Code: 500
** ResourceNotFoundException **
A resource that is required for the action wasn't found.
** ErrorCode **
A description of which resource wasn't found.
HTTP Status Code: 400
** ThrottlingException **
TPS has been limited to protect against intentional or unintentional high request volumes.
** ErrorCode **
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
** ValidationException **
The operation did not succeed because a validation error occurred.
** ErrorCode **
A description of what caused the validation error.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Lists your virtual machines.
## Request Syntax
```
{
"HypervisorArn": "string",
"MaxResults": number,
"NextToken": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [HypervisorArn](#API_BGW_ListVirtualMachines_RequestSyntax) **
The Amazon Resource Name (ARN) of the hypervisor connected to your virtual machine.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: No
** [MaxResults](#API_BGW_ListVirtualMachines_RequestSyntax) **
The maximum number of virtual machines to list.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
** [NextToken](#API_BGW_ListVirtualMachines_RequestSyntax) **
The next item following a partial list of returned resources. For example, if a request is made to return `maxResults` number of resources, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `.+`
Required: No
## Response Syntax
```
{
"NextToken": "string",
"VirtualMachines": [
{
"HostName": "string",
"HypervisorId": "string",
"LastBackupDate": number,
"Name": "string",
"Path": "string",
"ResourceArn": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_BGW_ListVirtualMachines_ResponseSyntax) **
The next item following a partial list of returned resources. For example, if a request is made to return `maxResults` number of resources, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `.+`
** [VirtualMachines](#API_BGW_ListVirtualMachines_ResponseSyntax) **
A list of your `VirtualMachine` objects, ordered by their Amazon Resource Names (ARNs).
Type: Array of [VirtualMachine](API_BGW_VirtualMachine.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The operation did not succeed because an internal error occurred. Try again later.
** ErrorCode **
A description of which internal error occured.
HTTP Status Code: 500
** ThrottlingException **
TPS has been limited to protect against intentional or unintentional high request volumes.
** ErrorCode **
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
** ValidationException **
The operation did not succeed because a validation error occurred.
** ErrorCode **
A description of what caused the validation error.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This action sets the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have a bandwidth rate limit schedule, which means no bandwidth rate limiting is in effect. Use this to initiate a gateway's bandwidth rate limit schedule.
## Request Syntax
```
{
"BandwidthRateLimitIntervals": [
{
"AverageUploadRateLimitInBitsPerSec": number,
"DaysOfWeek": [ number ],
"EndHourOfDay": number,
"EndMinuteOfHour": number,
"StartHourOfDay": number,
"StartMinuteOfHour": number
}
],
"GatewayArn": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [BandwidthRateLimitIntervals](#API_BGW_PutBandwidthRateLimitSchedule_RequestSyntax) **
An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.
Type: Array of [BandwidthRateLimitInterval](API_BGW_BandwidthRateLimitInterval.md) objects
Array Members: Minimum number of 0 items. Maximum number of 20 items.
Required: Yes
** [GatewayArn](#API_BGW_PutBandwidthRateLimitSchedule_RequestSyntax) **
The Amazon Resource Name (ARN) of the gateway. Use the [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) operation to return a list of gateways for your account and AWS Region.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 180.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: Yes
## Response Syntax
```
{
"GatewayArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [GatewayArn](#API_BGW_PutBandwidthRateLimitSchedule_ResponseSyntax) **
The Amazon Resource Name (ARN) of the gateway. Use the [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) operation to return a list of gateways for your account and AWS Region.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 180.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The operation did not succeed because an internal error occurred. Try again later.
** ErrorCode **
A description of which internal error occured.
HTTP Status Code: 500
** ResourceNotFoundException **
A resource that is required for the action wasn't found.
** ErrorCode **
A description of which resource wasn't found.
HTTP Status Code: 400
** ThrottlingException **
TPS has been limited to protect against intentional or unintentional high request volumes.
** ErrorCode **
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
** ValidationException **
The operation did not succeed because a validation error occurred.
** ErrorCode **
A description of what caused the validation error.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This action sets the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the hypervisor to the properties available in AWS.
## Request Syntax
```
{
"HypervisorArn": "string",
"IamRoleArn": "string",
"VmwareToAwsTagMappings": [
{
"AwsTagKey": "string",
"AwsTagValue": "string",
"VmwareCategory": "string",
"VmwareTagName": "string"
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [HypervisorArn](#API_BGW_PutHypervisorPropertyMappings_RequestSyntax) **
The Amazon Resource Name (ARN) of the hypervisor.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: Yes
** [IamRoleArn](#API_BGW_PutHypervisorPropertyMappings_RequestSyntax) **
The Amazon Resource Name (ARN) of the IAM role.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: `arn:(aws|aws-cn|aws-us-gov):iam::([0-9]+):role/(\S+)`
Required: Yes
** [VmwareToAwsTagMappings](#API_BGW_PutHypervisorPropertyMappings_RequestSyntax) **
This action requests the mappings of VMware tags to the AWS tags.
Type: Array of [VmwareToAwsTagMapping](API_BGW_VmwareToAwsTagMapping.md) objects
Required: Yes
## Response Syntax
```
{
"HypervisorArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [HypervisorArn](#API_BGW_PutHypervisorPropertyMappings_ResponseSyntax) **
The Amazon Resource Name (ARN) of the hypervisor.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The operation cannot proceed because you have insufficient permissions.
** ErrorCode **
A description of why you have insufficient permissions.
HTTP Status Code: 400
** ConflictException **
The operation cannot proceed because it is not supported.
** ErrorCode **
A description of why the operation is not supported.
HTTP Status Code: 400
** InternalServerException **
The operation did not succeed because an internal error occurred. Try again later.
** ErrorCode **
A description of which internal error occured.
HTTP Status Code: 500
** ResourceNotFoundException **
A resource that is required for the action wasn't found.
** ErrorCode **
A description of which resource wasn't found.
HTTP Status Code: 400
** ThrottlingException **
TPS has been limited to protect against intentional or unintentional high request volumes.
** ErrorCode **
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
** ValidationException **
The operation did not succeed because a validation error occurred.
** ErrorCode **
A description of what caused the validation error.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Set the maintenance start time for a gateway.
## Request Syntax
```
{
"DayOfMonth": number,
"DayOfWeek": number,
"GatewayArn": "string",
"HourOfDay": number,
"MinuteOfHour": number
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [DayOfMonth](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **
The day of the month start maintenance on a gateway.
Valid values range from `Sunday` to `Saturday`.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 31.
Required: No
** [DayOfWeek](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **
The day of the week to start maintenance on a gateway.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 6.
Required: No
** [GatewayArn](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **
The Amazon Resource Name (ARN) for the gateway, used to specify its maintenance start time.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 180.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: Yes
** [HourOfDay](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **
The hour of the day to start maintenance on a gateway.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 23.
Required: Yes
** [MinuteOfHour](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **
The minute of the hour to start maintenance on a gateway.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 59.
Required: Yes
## Response Syntax
```
{
"GatewayArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [GatewayArn](#API_BGW_PutMaintenanceStartTime_ResponseSyntax) **
The Amazon Resource Name (ARN) of a gateway for which you set the maintenance start time.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 180.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The operation cannot proceed because it is not supported.
** ErrorCode **
A description of why the operation is not supported.
HTTP Status Code: 400
** InternalServerException **
The operation did not succeed because an internal error occurred. Try again later.
** ErrorCode **
A description of which internal error occured.
HTTP Status Code: 500
** ResourceNotFoundException **
A resource that is required for the action wasn't found.
** ErrorCode **
A description of which resource wasn't found.
HTTP Status Code: 400
** ThrottlingException **
TPS has been limited to protect against intentional or unintentional high request volumes.
** ErrorCode **
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
** ValidationException **
The operation did not succeed because a validation error occurred.
** ErrorCode **
A description of what caused the validation error.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This action sends a request to sync metadata across the specified virtual machines.
## Request Syntax
```
{
"HypervisorArn": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [HypervisorArn](#API_BGW_StartVirtualMachinesMetadataSync_RequestSyntax) **
The Amazon Resource Name (ARN) of the hypervisor.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: Yes
## Response Syntax
```
{
"HypervisorArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [HypervisorArn](#API_BGW_StartVirtualMachinesMetadataSync_ResponseSyntax) **
The Amazon Resource Name (ARN) of the hypervisor.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The operation cannot proceed because you have insufficient permissions.
** ErrorCode **
A description of why you have insufficient permissions.
HTTP Status Code: 400
** InternalServerException **
The operation did not succeed because an internal error occurred. Try again later.
** ErrorCode **
A description of which internal error occured.
HTTP Status Code: 500
** ResourceNotFoundException **
A resource that is required for the action wasn't found.
** ErrorCode **
A description of which resource wasn't found.
HTTP Status Code: 400
** ThrottlingException **
TPS has been limited to protect against intentional or unintentional high request volumes.
** ErrorCode **
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
** ValidationException **
The operation did not succeed because a validation error occurred.
** ErrorCode **
A description of what caused the validation error.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Tag the resource.
## Request Syntax
```
{
"ResourceARN": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ResourceARN](#API_BGW_TagResource_RequestSyntax) **
The Amazon Resource Name (ARN) of the resource to tag.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: Yes
** [Tags](#API_BGW_TagResource_RequestSyntax) **
A list of tags to assign to the resource.
Type: Array of [Tag](API_BGW_Tag.md) objects
Required: Yes
## Response Syntax
```
{
"ResourceARN": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ResourceARN](#API_BGW_TagResource_ResponseSyntax) **
The Amazon Resource Name (ARN) of the resource you tagged.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The operation did not succeed because an internal error occurred. Try again later.
** ErrorCode **
A description of which internal error occured.
HTTP Status Code: 500
** ResourceNotFoundException **
A resource that is required for the action wasn't found.
** ErrorCode **
A description of which resource wasn't found.
HTTP Status Code: 400
** ThrottlingException **
TPS has been limited to protect against intentional or unintentional high request volumes.
** ErrorCode **
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
** ValidationException **
The operation did not succeed because a validation error occurred.
** ErrorCode **
A description of what caused the validation error.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
## Request Syntax
```
{
"GatewayArn": "string",
"Host": "string",
"Password": "string",
"Username": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [GatewayArn](#API_BGW_TestHypervisorConfiguration_RequestSyntax) **
The Amazon Resource Name (ARN) of the gateway to the hypervisor to test.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 180.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: Yes
** [Host](#API_BGW_TestHypervisorConfiguration_RequestSyntax) **
The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
Type: String
Length Constraints: Minimum length of 3. Maximum length of 128.
Pattern: `.+`
Required: Yes
** [Password](#API_BGW_TestHypervisorConfiguration_RequestSyntax) **
The password for the hypervisor.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[ -~]+`
Required: No
** [Username](#API_BGW_TestHypervisorConfiguration_RequestSyntax) **
The username for the hypervisor.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*`
Required: No
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The operation cannot proceed because it is not supported.
** ErrorCode **
A description of why the operation is not supported.
HTTP Status Code: 400
** InternalServerException **
The operation did not succeed because an internal error occurred. Try again later.
** ErrorCode **
A description of which internal error occured.
HTTP Status Code: 500
** ResourceNotFoundException **
A resource that is required for the action wasn't found.
** ErrorCode **
A description of which resource wasn't found.
HTTP Status Code: 400
** ThrottlingException **
TPS has been limited to protect against intentional or unintentional high request volumes.
** ErrorCode **
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
** ValidationException **
The operation did not succeed because a validation error occurred.
** ErrorCode **
A description of what caused the validation error.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Removes tags from the resource.
## Request Syntax
```
{
"ResourceARN": "string",
"TagKeys": [ "string" ]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [ResourceARN](#API_BGW_UntagResource_RequestSyntax) **
The Amazon Resource Name (ARN) of the resource from which to remove tags.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: Yes
** [TagKeys](#API_BGW_UntagResource_RequestSyntax) **
The list of tag keys specifying which tags to remove.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`
Required: Yes
## Response Syntax
```
{
"ResourceARN": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ResourceARN](#API_BGW_UntagResource_ResponseSyntax) **
The Amazon Resource Name (ARN) of the resource from which you removed tags.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The operation did not succeed because an internal error occurred. Try again later.
** ErrorCode **
A description of which internal error occured.
HTTP Status Code: 500
** ResourceNotFoundException **
A resource that is required for the action wasn't found.
** ErrorCode **
A description of which resource wasn't found.
HTTP Status Code: 400
** ThrottlingException **
TPS has been limited to protect against intentional or unintentional high request volumes.
** ErrorCode **
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
** ValidationException **
The operation did not succeed because a validation error occurred.
** ErrorCode **
A description of what caused the validation error.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.
## Request Syntax
```
{
"GatewayArn": "string",
"GatewayDisplayName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [GatewayArn](#API_BGW_UpdateGatewayInformation_RequestSyntax) **
The Amazon Resource Name (ARN) of the gateway to update.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 180.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: Yes
** [GatewayDisplayName](#API_BGW_UpdateGatewayInformation_RequestSyntax) **
The updated display name of the gateway.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9-]*`
Required: No
## Response Syntax
```
{
"GatewayArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [GatewayArn](#API_BGW_UpdateGatewayInformation_ResponseSyntax) **
The Amazon Resource Name (ARN) of the gateway you updated.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 180.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConflictException **
The operation cannot proceed because it is not supported.
** ErrorCode **
A description of why the operation is not supported.
HTTP Status Code: 400
** InternalServerException **
The operation did not succeed because an internal error occurred. Try again later.
** ErrorCode **
A description of which internal error occured.
HTTP Status Code: 500
** ResourceNotFoundException **
A resource that is required for the action wasn't found.
** ErrorCode **
A description of which resource wasn't found.
HTTP Status Code: 400
** ThrottlingException **
TPS has been limited to protect against intentional or unintentional high request volumes.
** ErrorCode **
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
** ValidationException **
The operation did not succeed because a validation error occurred.
** ErrorCode **
A description of what caused the validation error.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.
**Note**
When you make this request, you get a `200 OK` success response immediately. However, it might take some time for the update to complete.
## Request Syntax
```
{
"GatewayArn": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [GatewayArn](#API_BGW_UpdateGatewaySoftwareNow_RequestSyntax) **
The Amazon Resource Name (ARN) of the gateway to be updated.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 180.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: Yes
## Response Syntax
```
{
"GatewayArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [GatewayArn](#API_BGW_UpdateGatewaySoftwareNow_ResponseSyntax) **
The Amazon Resource Name (ARN) of the gateway you updated.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 180.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerException **
The operation did not succeed because an internal error occurred. Try again later.
** ErrorCode **
A description of which internal error occured.
HTTP Status Code: 500
** ResourceNotFoundException **
A resource that is required for the action wasn't found.
** ErrorCode **
A description of which resource wasn't found.
HTTP Status Code: 400
** ThrottlingException **
TPS has been limited to protect against intentional or unintentional high request volumes.
** ErrorCode **
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
** ValidationException **
The operation did not succeed because a validation error occurred.
** ErrorCode **
A description of what caused the validation error.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
Updates a hypervisor metadata, including its host, username, and password. Specify which hypervisor to update using the Amazon Resource Name (ARN) of the hypervisor in your request.
## Request Syntax
```
{
"Host": "string",
"HypervisorArn": "string",
"LogGroupArn": "string",
"Name": "string",
"Password": "string",
"Username": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [Host](#API_BGW_UpdateHypervisor_RequestSyntax) **
The updated host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
Type: String
Length Constraints: Minimum length of 3. Maximum length of 128.
Pattern: `.+`
Required: No
** [HypervisorArn](#API_BGW_UpdateHypervisor_RequestSyntax) **
The Amazon Resource Name (ARN) of the hypervisor to update.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: Yes
** [LogGroupArn](#API_BGW_UpdateHypervisor_RequestSyntax) **
The Amazon Resource Name (ARN) of the group of gateways within the requested log.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `$|^arn:(aws|aws-cn|aws-us-gov):logs:([a-zA-Z0-9-]+):([0-9]+):log-group:[a-zA-Z0-9_\-\/\.]+:\*`
Required: No
** [Name](#API_BGW_UpdateHypervisor_RequestSyntax) **
The updated name for the hypervisor
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9-]*`
Required: No
** [Password](#API_BGW_UpdateHypervisor_RequestSyntax) **
The updated password for the hypervisor.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[ -~]+`
Required: No
** [Username](#API_BGW_UpdateHypervisor_RequestSyntax) **
The updated username for the hypervisor.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*`
Required: No
## Response Syntax
```
{
"HypervisorArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [HypervisorArn](#API_BGW_UpdateHypervisor_ResponseSyntax) **
The Amazon Resource Name (ARN) of the hypervisor you updated.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The operation cannot proceed because you have insufficient permissions.
** ErrorCode **
A description of why you have insufficient permissions.
HTTP Status Code: 400
** ConflictException **
The operation cannot proceed because it is not supported.
** ErrorCode **
A description of why the operation is not supported.
HTTP Status Code: 400
** InternalServerException **
The operation did not succeed because an internal error occurred. Try again later.
** ErrorCode **
A description of which internal error occured.
HTTP Status Code: 500
** ResourceNotFoundException **
A resource that is required for the action wasn't found.
** ErrorCode **
A description of which resource wasn't found.
HTTP Status Code: 400
** ThrottlingException **
TPS has been limited to protect against intentional or unintentional high request volumes.
** ErrorCode **
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
** ValidationException **
The operation did not succeed because a validation error occurred.
** ErrorCode **
A description of what caused the validation error.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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 search
The following actions are supported by AWS Backup search:
+ [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
This operation retrieves metadata of a search job, including its progress.
## Request Syntax
```
GET /search-jobs/SearchJobIdentifier HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [SearchJobIdentifier](#API_BKS_GetSearchJob_RequestSyntax) **
Required unique string that specifies the search job.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [CompletionTime](#API_BKS_GetSearchJob_ResponseSyntax) **
The date and time that a search job completed, in Unix format and Coordinated Universal Time (UTC). The value of `CompletionTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [CreationTime](#API_BKS_GetSearchJob_ResponseSyntax) **
The date and time that a search job was created, in Unix format and Coordinated Universal Time (UTC). The value of `CompletionTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [CurrentSearchProgress](#API_BKS_GetSearchJob_ResponseSyntax) **
Returns numbers representing BackupsScannedCount, ItemsScanned, and ItemsMatched.
Type: [CurrentSearchProgress](API_BKS_CurrentSearchProgress.md) object
** [EncryptionKeyArn](#API_BKS_GetSearchJob_ResponseSyntax) **
The encryption key for the specified search job.
Example: `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
Type: String
** [ItemFilters](#API_BKS_GetSearchJob_ResponseSyntax) **
Item Filters represent all input item properties specified when the search was created.
Type: [ItemFilters](API_BKS_ItemFilters.md) object
** [Name](#API_BKS_GetSearchJob_ResponseSyntax) **
Returned name of the specified search job.
Type: String
** [SearchJobArn](#API_BKS_GetSearchJob_ResponseSyntax) **
The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.
Type: String
** [SearchJobIdentifier](#API_BKS_GetSearchJob_ResponseSyntax) **
The unique string that identifies the specified search job.
Type: String
** [SearchScope](#API_BKS_GetSearchJob_ResponseSyntax) **
The search scope is all backup properties input into a search.
Type: [SearchScope](API_BKS_SearchScope.md) object
** [SearchScopeSummary](#API_BKS_GetSearchJob_ResponseSyntax) **
Returned summary of the specified search job scope, including:
+ TotalBackupsToScanCount, the number of recovery points returned by the search.
+ TotalItemsToScanCount, the number of items returned by the search.
Type: [SearchScopeSummary](API_BKS_SearchScopeSummary.md) object
** [Status](#API_BKS_GetSearchJob_ResponseSyntax) **
The current status of the specified search job.
A search job may have one of the following statuses: `RUNNING`; `COMPLETED`; `STOPPED`; `FAILED`; `TIMED_OUT`; or `EXPIRED` .
Type: String
Valid Values: `RUNNING | COMPLETED | STOPPING | STOPPED | FAILED`
** [StatusMessage](#API_BKS_GetSearchJob_ResponseSyntax) **
A status message will be returned for either a earch job with a status of `ERRORED` or a status of `COMPLETED` jobs with issues.
For example, a message may say that a search contained recovery points unable to be scanned because of a permissions issue.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You do not have sufficient access to perform this action.
** message **
User does not have sufficient access to perform this action.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
** message **
Unexpected error during processing of request.
** retryAfterSeconds **
Retry the call after number of seconds.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource was not found for this request.
Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.
** message **
Request references a resource which does not exist.
** resourceId **
Hypothetical identifier of the resource affected.
** resourceType **
Hypothetical type of the resource affected.
HTTP Status Code: 404
** ThrottlingException **
The request was denied due to request throttling.
** message **
Request was unsuccessful due to request throttling.
** quotaCode **
This is the code unique to the originating service with the quota.
** retryAfterSeconds **
Retry the call after number of seconds.
** serviceCode **
This is the code unique to the originating service.
HTTP Status Code: 429
** ValidationException **
The input fails to satisfy the constraints specified by a service.
** message **
The input fails to satisfy the constraints specified by an Amazon service.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This operation retrieves the metadata of an export job.
An export job is an operation that transmits the results of a search job to a specified S3 bucket in a .csv file.
An export job allows you to retain results of a search beyond the search job's scheduled retention of 7 days.
## Request Syntax
```
GET /export-search-jobs/ExportJobIdentifier HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [ExportJobIdentifier](#API_BKS_GetSearchResultExportJob_RequestSyntax) **
This is the unique string that identifies a specific export job.
Required for this operation.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"CompletionTime": number,
"CreationTime": number,
"ExportJobArn": "string",
"ExportJobIdentifier": "string",
"ExportSpecification": { ... },
"SearchJobArn": "string",
"Status": "string",
"StatusMessage": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [CompletionTime](#API_BKS_GetSearchResultExportJob_ResponseSyntax) **
The date and time that an export job completed, in Unix format and Coordinated Universal Time (UTC). The value of `CreationTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [CreationTime](#API_BKS_GetSearchResultExportJob_ResponseSyntax) **
The date and time that an export job was created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [ExportJobArn](#API_BKS_GetSearchResultExportJob_ResponseSyntax) **
The unique Amazon Resource Name (ARN) that uniquely identifies the export job.
Type: String
** [ExportJobIdentifier](#API_BKS_GetSearchResultExportJob_ResponseSyntax) **
This is the unique string that identifies the specified export job.
Type: String
** [ExportSpecification](#API_BKS_GetSearchResultExportJob_ResponseSyntax) **
The export specification consists of the destination S3 bucket to which the search results were exported, along with the destination prefix.
Type: [ExportSpecification](API_BKS_ExportSpecification.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
** [SearchJobArn](#API_BKS_GetSearchResultExportJob_ResponseSyntax) **
The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.
Type: String
** [Status](#API_BKS_GetSearchResultExportJob_ResponseSyntax) **
This is the current status of the export job.
Type: String
Valid Values: `RUNNING | FAILED | COMPLETED`
** [StatusMessage](#API_BKS_GetSearchResultExportJob_ResponseSyntax) **
A status message is a string that is returned for search job with a status of `FAILED`, along with steps to remedy and retry the operation.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You do not have sufficient access to perform this action.
** message **
User does not have sufficient access to perform this action.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
** message **
Unexpected error during processing of request.
** retryAfterSeconds **
Retry the call after number of seconds.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource was not found for this request.
Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.
** message **
Request references a resource which does not exist.
** resourceId **
Hypothetical identifier of the resource affected.
** resourceType **
Hypothetical type of the resource affected.
HTTP Status Code: 404
** ThrottlingException **
The request was denied due to request throttling.
** message **
Request was unsuccessful due to request throttling.
** quotaCode **
This is the code unique to the originating service with the quota.
** retryAfterSeconds **
Retry the call after number of seconds.
** serviceCode **
This is the code unique to the originating service.
HTTP Status Code: 429
** ValidationException **
The input fails to satisfy the constraints specified by a service.
** message **
The input fails to satisfy the constraints specified by an Amazon service.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This operation returns a list of all backups (recovery points) in a paginated format that were included in the search job.
If a search does not display an expected backup in the results, you can call this operation to display each backup included in the search. Any backups that were not included because they have a `FAILED` status from a permissions issue will be displayed, along with a status message.
Only recovery points with a backup index that has a status of `ACTIVE` will be included in search results. If the index has any other status, its status will be displayed along with a status message.
## Request Syntax
```
GET /search-jobs/SearchJobIdentifier/backups?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [MaxResults](#API_BKS_ListSearchJobBackups_RequestSyntax) **
The maximum number of resource list items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_BKS_ListSearchJobBackups_RequestSyntax) **
The next item following a partial list of returned backups included in a search job.
For example, if a request is made to return `MaxResults` number of backups, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
** [SearchJobIdentifier](#API_BKS_ListSearchJobBackups_RequestSyntax) **
The unique string that specifies the search job.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_BKS_ListSearchJobBackups_ResponseSyntax) **
The next item following a partial list of returned backups included in a search job.
For example, if a request is made to return `MaxResults` number of backups, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
** [Results](#API_BKS_ListSearchJobBackups_ResponseSyntax) **
The recovery points returned the results of a search job
Type: Array of [SearchJobBackupsResult](API_BKS_SearchJobBackupsResult.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You do not have sufficient access to perform this action.
** message **
User does not have sufficient access to perform this action.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
** message **
Unexpected error during processing of request.
** retryAfterSeconds **
Retry the call after number of seconds.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource was not found for this request.
Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.
** message **
Request references a resource which does not exist.
** resourceId **
Hypothetical identifier of the resource affected.
** resourceType **
Hypothetical type of the resource affected.
HTTP Status Code: 404
** ThrottlingException **
The request was denied due to request throttling.
** message **
Request was unsuccessful due to request throttling.
** quotaCode **
This is the code unique to the originating service with the quota.
** retryAfterSeconds **
Retry the call after number of seconds.
** serviceCode **
This is the code unique to the originating service.
HTTP Status Code: 429
** ValidationException **
The input fails to satisfy the constraints specified by a service.
** message **
The input fails to satisfy the constraints specified by an Amazon service.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This operation returns a list of a specified search job.
## Request Syntax
```
GET /search-jobs/SearchJobIdentifier/search-results?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [MaxResults](#API_BKS_ListSearchJobResults_RequestSyntax) **
The maximum number of resource list items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_BKS_ListSearchJobResults_RequestSyntax) **
The next item following a partial list of returned search job results.
For example, if a request is made to return `MaxResults` number of search job results, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
** [SearchJobIdentifier](#API_BKS_ListSearchJobResults_RequestSyntax) **
The unique string that specifies the search job.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Results": [
{ ... }
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_BKS_ListSearchJobResults_ResponseSyntax) **
The next item following a partial list of search job results.
For example, if a request is made to return `MaxResults` number of backups, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
** [Results](#API_BKS_ListSearchJobResults_ResponseSyntax) **
The results consist of either EBSResultItem or S3ResultItem.
Type: Array of [ResultItem](API_BKS_ResultItem.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You do not have sufficient access to perform this action.
** message **
User does not have sufficient access to perform this action.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
** message **
Unexpected error during processing of request.
** retryAfterSeconds **
Retry the call after number of seconds.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource was not found for this request.
Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.
** message **
Request references a resource which does not exist.
** resourceId **
Hypothetical identifier of the resource affected.
** resourceType **
Hypothetical type of the resource affected.
HTTP Status Code: 404
** ThrottlingException **
The request was denied due to request throttling.
** message **
Request was unsuccessful due to request throttling.
** quotaCode **
This is the code unique to the originating service with the quota.
** retryAfterSeconds **
Retry the call after number of seconds.
** serviceCode **
This is the code unique to the originating service.
HTTP Status Code: 429
** ValidationException **
The input fails to satisfy the constraints specified by a service.
** message **
The input fails to satisfy the constraints specified by an Amazon service.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This operation returns a list of search jobs belonging to an account.
## Request Syntax
```
GET /search-jobs?MaxResults=MaxResults&NextToken=NextToken&Status=ByStatus HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [ByStatus](#API_BKS_ListSearchJobs_RequestSyntax) **
Include this parameter to filter list by search job status.
Valid Values: `RUNNING | COMPLETED | STOPPING | STOPPED | FAILED`
** [MaxResults](#API_BKS_ListSearchJobs_RequestSyntax) **
The maximum number of resource list items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_BKS_ListSearchJobs_RequestSyntax) **
The next item following a partial list of returned search jobs.
For example, if a request is made to return `MaxResults` number of backups, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_BKS_ListSearchJobs_ResponseSyntax) **
The next item following a partial list of returned backups included in a search job.
For example, if a request is made to return `MaxResults` number of backups, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
** [SearchJobs](#API_BKS_ListSearchJobs_ResponseSyntax) **
The search jobs among the list, with details of the returned search jobs.
Type: Array of [SearchJobSummary](API_BKS_SearchJobSummary.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You do not have sufficient access to perform this action.
** message **
User does not have sufficient access to perform this action.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
** message **
Unexpected error during processing of request.
** retryAfterSeconds **
Retry the call after number of seconds.
HTTP Status Code: 500
** ThrottlingException **
The request was denied due to request throttling.
** message **
Request was unsuccessful due to request throttling.
** quotaCode **
This is the code unique to the originating service with the quota.
** retryAfterSeconds **
Retry the call after number of seconds.
** serviceCode **
This is the code unique to the originating service.
HTTP Status Code: 429
** ValidationException **
The input fails to satisfy the constraints specified by a service.
** message **
The input fails to satisfy the constraints specified by an Amazon service.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This operation exports search results of a search job to a specified destination S3 bucket.
## Request Syntax
```
GET /export-search-jobs?MaxResults=MaxResults&NextToken=NextToken&SearchJobIdentifier=SearchJobIdentifier&Status=Status HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [MaxResults](#API_BKS_ListSearchResultExportJobs_RequestSyntax) **
The maximum number of resource list items to be returned.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [NextToken](#API_BKS_ListSearchResultExportJobs_RequestSyntax) **
The next item following a partial list of returned backups included in a search job.
For example, if a request is made to return `MaxResults` number of backups, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
** [SearchJobIdentifier](#API_BKS_ListSearchResultExportJobs_RequestSyntax) **
The unique string that specifies the search job.
** [Status](#API_BKS_ListSearchResultExportJobs_RequestSyntax) **
The search jobs to be included in the export job can be filtered by including this parameter.
Valid Values: `RUNNING | FAILED | COMPLETED`
## Request Body
The request does not have a request body.
## Response Syntax
```
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"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ExportJobs](#API_BKS_ListSearchResultExportJobs_ResponseSyntax) **
The operation returns the included export jobs.
Type: Array of [ExportJobSummary](API_BKS_ExportJobSummary.md) objects
** [NextToken](#API_BKS_ListSearchResultExportJobs_ResponseSyntax) **
The next item following a partial list of returned backups included in a search job.
For example, if a request is made to return `MaxResults` number of backups, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You do not have sufficient access to perform this action.
** message **
User does not have sufficient access to perform this action.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
** message **
Unexpected error during processing of request.
** retryAfterSeconds **
Retry the call after number of seconds.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource was not found for this request.
Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.
** message **
Request references a resource which does not exist.
** resourceId **
Hypothetical identifier of the resource affected.
** resourceType **
Hypothetical type of the resource affected.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The request denied due to exceeding the quota limits permitted.
** message **
This request was not successful due to a service quota exceeding limits.
** quotaCode **
This is the code specific to the quota type.
** resourceId **
Identifier of the resource.
** resourceType **
Type of resource.
** serviceCode **
This is the code unique to the originating service with the quota.
HTTP Status Code: 402
** ThrottlingException **
The request was denied due to request throttling.
** message **
Request was unsuccessful due to request throttling.
** quotaCode **
This is the code unique to the originating service with the quota.
** retryAfterSeconds **
Retry the call after number of seconds.
** serviceCode **
This is the code unique to the originating service.
HTTP Status Code: 429
** ValidationException **
The input fails to satisfy the constraints specified by a service.
** message **
The input fails to satisfy the constraints specified by an Amazon service.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This operation returns the tags for a resource type.
## Request Syntax
```
GET /tags/ResourceArn HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [ResourceArn](#API_BKS_ListTagsForResource_RequestSyntax) **
The Amazon Resource Name (ARN) that uniquely identifies the resource.>
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"Tags": {
"string" : "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Tags](#API_BKS_ListTagsForResource_ResponseSyntax) **
List of tags returned by the operation.
Type: String to string map
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You do not have sufficient access to perform this action.
** message **
User does not have sufficient access to perform this action.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
** message **
Unexpected error during processing of request.
** retryAfterSeconds **
Retry the call after number of seconds.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource was not found for this request.
Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.
** message **
Request references a resource which does not exist.
** resourceId **
Hypothetical identifier of the resource affected.
** resourceType **
Hypothetical type of the resource affected.
HTTP Status Code: 404
** ThrottlingException **
The request was denied due to request throttling.
** message **
Request was unsuccessful due to request throttling.
** quotaCode **
This is the code unique to the originating service with the quota.
** retryAfterSeconds **
Retry the call after number of seconds.
** serviceCode **
This is the code unique to the originating service.
HTTP Status Code: 429
** ValidationException **
The input fails to satisfy the constraints specified by a service.
** message **
The input fails to satisfy the constraints specified by an Amazon service.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This operation creates a search job which returns recovery points filtered by SearchScope and items filtered by ItemFilters.
You can optionally include ClientToken, EncryptionKeyArn, Name, and/or Tags.
## Request Syntax
```
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 Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [ClientToken](#API_BKS_StartSearchJob_RequestSyntax) **
Include this parameter to allow multiple identical calls for idempotency.
A client token is valid for 8 hours after the first request that uses it is completed. After this time, any request with the same token is treated as a new request.
Type: String
Required: No
** [EncryptionKeyArn](#API_BKS_StartSearchJob_RequestSyntax) **
The encryption key for the specified search job.
Type: String
Required: No
** [ItemFilters](#API_BKS_StartSearchJob_RequestSyntax) **
Item Filters represent all input item properties specified when the search was created.
Contains either EBSItemFilters or S3ItemFilters
Type: [ItemFilters](API_BKS_ItemFilters.md) object
Required: No
** [Name](#API_BKS_StartSearchJob_RequestSyntax) **
Include alphanumeric characters to create a name for this search job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
Required: No
** [SearchScope](#API_BKS_StartSearchJob_RequestSyntax) **
This object can contain BackupResourceTypes, BackupResourceArns, BackupResourceCreationTime, BackupResourceTags, and SourceResourceArns to filter the recovery points returned by the search job.
Type: [SearchScope](API_BKS_SearchScope.md) object
Required: Yes
** [Tags](#API_BKS_StartSearchJob_RequestSyntax) **
List of tags returned by the operation.
Type: String to string map
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"SearchJobArn": "string",
"SearchJobIdentifier": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [CreationTime](#API_BKS_StartSearchJob_ResponseSyntax) **
The date and time that a job was created, in Unix format and Coordinated Universal Time (UTC). The value of `CompletionTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
** [SearchJobArn](#API_BKS_StartSearchJob_ResponseSyntax) **
The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.
Type: String
** [SearchJobIdentifier](#API_BKS_StartSearchJob_ResponseSyntax) **
The unique string that specifies the search job.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You do not have sufficient access to perform this action.
** message **
User does not have sufficient access to perform this action.
HTTP Status Code: 403
** ConflictException **
This exception occurs when a conflict with a previous successful operation is detected. This generally occurs when the previous operation did not have time to propagate to the host serving the current request.
A retry (with appropriate backoff logic) is the recommended response to this exception.
** message **
Updating or deleting a resource can cause an inconsistent state.
** resourceId **
Identifier of the resource affected.
** resourceType **
Type of the resource affected.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
** message **
Unexpected error during processing of request.
** retryAfterSeconds **
Retry the call after number of seconds.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource was not found for this request.
Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.
** message **
Request references a resource which does not exist.
** resourceId **
Hypothetical identifier of the resource affected.
** resourceType **
Hypothetical type of the resource affected.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The request denied due to exceeding the quota limits permitted.
** message **
This request was not successful due to a service quota exceeding limits.
** quotaCode **
This is the code specific to the quota type.
** resourceId **
Identifier of the resource.
** resourceType **
Type of resource.
** serviceCode **
This is the code unique to the originating service with the quota.
HTTP Status Code: 402
** ThrottlingException **
The request was denied due to request throttling.
** message **
Request was unsuccessful due to request throttling.
** quotaCode **
This is the code unique to the originating service with the quota.
** retryAfterSeconds **
Retry the call after number of seconds.
** serviceCode **
This is the code unique to the originating service.
HTTP Status Code: 429
** ValidationException **
The input fails to satisfy the constraints specified by a service.
** message **
The input fails to satisfy the constraints specified by an Amazon service.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This operations starts a job to export the results of search job to a designated S3 bucket.
## Request Syntax
```
PUT /export-search-jobs HTTP/1.1
Content-type: application/json
{
"ClientToken": "string",
"ExportSpecification": { ... },
"RoleArn": "string",
"SearchJobIdentifier": "string",
"Tags": {
"string" : "string"
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [ClientToken](#API_BKS_StartSearchResultExportJob_RequestSyntax) **
Include this parameter to allow multiple identical calls for idempotency.
A client token is valid for 8 hours after the first request that uses it is completed. After this time, any request with the same token is treated as a new request.
Type: String
Required: No
** [ExportSpecification](#API_BKS_StartSearchResultExportJob_RequestSyntax) **
This specification contains a required string of the destination bucket; optionally, you can include the destination prefix.
Type: [ExportSpecification](API_BKS_ExportSpecification.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** [RoleArn](#API_BKS_StartSearchResultExportJob_RequestSyntax) **
This parameter specifies the role ARN used to start the search results export jobs.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: `arn:(?:aws|aws-cn|aws-us-gov):iam::[a-z0-9-]+:role/(.+)`
Required: No
** [SearchJobIdentifier](#API_BKS_StartSearchResultExportJob_RequestSyntax) **
The unique string that specifies the search job.
Type: String
Required: Yes
** [Tags](#API_BKS_StartSearchResultExportJob_RequestSyntax) **
Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: \$1 - = . \$1 : /.
Type: String to string map
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"ExportJobArn": "string",
"ExportJobIdentifier": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ExportJobArn](#API_BKS_StartSearchResultExportJob_ResponseSyntax) **
This is the unique ARN (Amazon Resource Name) that belongs to the new export job.
Type: String
** [ExportJobIdentifier](#API_BKS_StartSearchResultExportJob_ResponseSyntax) **
This is the unique identifier that specifies the new export job.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You do not have sufficient access to perform this action.
** message **
User does not have sufficient access to perform this action.
HTTP Status Code: 403
** ConflictException **
This exception occurs when a conflict with a previous successful operation is detected. This generally occurs when the previous operation did not have time to propagate to the host serving the current request.
A retry (with appropriate backoff logic) is the recommended response to this exception.
** message **
Updating or deleting a resource can cause an inconsistent state.
** resourceId **
Identifier of the resource affected.
** resourceType **
Type of the resource affected.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
** message **
Unexpected error during processing of request.
** retryAfterSeconds **
Retry the call after number of seconds.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource was not found for this request.
Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.
** message **
Request references a resource which does not exist.
** resourceId **
Hypothetical identifier of the resource affected.
** resourceType **
Hypothetical type of the resource affected.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The request denied due to exceeding the quota limits permitted.
** message **
This request was not successful due to a service quota exceeding limits.
** quotaCode **
This is the code specific to the quota type.
** resourceId **
Identifier of the resource.
** resourceType **
Type of resource.
** serviceCode **
This is the code unique to the originating service with the quota.
HTTP Status Code: 402
** ThrottlingException **
The request was denied due to request throttling.
** message **
Request was unsuccessful due to request throttling.
** quotaCode **
This is the code unique to the originating service with the quota.
** retryAfterSeconds **
Retry the call after number of seconds.
** serviceCode **
This is the code unique to the originating service.
HTTP Status Code: 429
** ValidationException **
The input fails to satisfy the constraints specified by a service.
** message **
The input fails to satisfy the constraints specified by an Amazon service.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This operations ends a search job.
Only a search job with a status of `RUNNING` can be stopped.
## Request Syntax
```
PUT /search-jobs/SearchJobIdentifier/actions/cancel HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [SearchJobIdentifier](#API_BKS_StopSearchJob_RequestSyntax) **
The unique string that specifies the search job.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You do not have sufficient access to perform this action.
** message **
User does not have sufficient access to perform this action.
HTTP Status Code: 403
** ConflictException **
This exception occurs when a conflict with a previous successful operation is detected. This generally occurs when the previous operation did not have time to propagate to the host serving the current request.
A retry (with appropriate backoff logic) is the recommended response to this exception.
** message **
Updating or deleting a resource can cause an inconsistent state.
** resourceId **
Identifier of the resource affected.
** resourceType **
Type of the resource affected.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
** message **
Unexpected error during processing of request.
** retryAfterSeconds **
Retry the call after number of seconds.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource was not found for this request.
Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.
** message **
Request references a resource which does not exist.
** resourceId **
Hypothetical identifier of the resource affected.
** resourceType **
Hypothetical type of the resource affected.
HTTP Status Code: 404
** ThrottlingException **
The request was denied due to request throttling.
** message **
Request was unsuccessful due to request throttling.
** quotaCode **
This is the code unique to the originating service with the quota.
** retryAfterSeconds **
Retry the call after number of seconds.
** serviceCode **
This is the code unique to the originating service.
HTTP Status Code: 429
** ValidationException **
The input fails to satisfy the constraints specified by a service.
** message **
The input fails to satisfy the constraints specified by an Amazon service.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This operation puts tags on the resource you indicate.
## Request Syntax
```
POST /tags/ResourceArn HTTP/1.1
Content-type: application/json
{
"Tags": {
"string" : "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [ResourceArn](#API_BKS_TagResource_RequestSyntax) **
The Amazon Resource Name (ARN) that uniquely identifies the resource.
This is the resource that will have the indicated tags.
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [Tags](#API_BKS_TagResource_RequestSyntax) **
Required tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: \$1 - = . \$1 : /.
Type: String to string map
Required: Yes
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You do not have sufficient access to perform this action.
** message **
User does not have sufficient access to perform this action.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
** message **
Unexpected error during processing of request.
** retryAfterSeconds **
Retry the call after number of seconds.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource was not found for this request.
Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.
** message **
Request references a resource which does not exist.
** resourceId **
Hypothetical identifier of the resource affected.
** resourceType **
Hypothetical type of the resource affected.
HTTP Status Code: 404
** ThrottlingException **
The request was denied due to request throttling.
** message **
Request was unsuccessful due to request throttling.
** quotaCode **
This is the code unique to the originating service with the quota.
** retryAfterSeconds **
Retry the call after number of seconds.
** serviceCode **
This is the code unique to the originating service.
HTTP Status Code: 429
** ValidationException **
The input fails to satisfy the constraints specified by a service.
** message **
The input fails to satisfy the constraints specified by an Amazon service.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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
This operation removes tags from the specified resource.
## Request Syntax
```
DELETE /tags/ResourceArn?tagKeys=TagKeys HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [ResourceArn](#API_BKS_UntagResource_RequestSyntax) **
The Amazon Resource Name (ARN) that uniquely identifies the resource where you want to remove tags.
Required: Yes
** [TagKeys](#API_BKS_UntagResource_RequestSyntax) **
This required parameter contains the tag keys you want to remove from the source.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You do not have sufficient access to perform this action.
** message **
User does not have sufficient access to perform this action.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
** message **
Unexpected error during processing of request.
** retryAfterSeconds **
Retry the call after number of seconds.
HTTP Status Code: 500
** ResourceNotFoundException **
The resource was not found for this request.
Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.
** message **
Request references a resource which does not exist.
** resourceId **
Hypothetical identifier of the resource affected.
** resourceType **
Hypothetical type of the resource affected.
HTTP Status Code: 404
** ThrottlingException **
The request was denied due to request throttling.
** message **
Request was unsuccessful due to request throttling.
** quotaCode **
This is the code unique to the originating service with the quota.
** retryAfterSeconds **
Retry the call after number of seconds.
** serviceCode **
This is the code unique to the originating service.
HTTP Status Code: 429
** ValidationException **
The input fails to satisfy the constraints specified by a service.
** message **
The input fails to satisfy the constraints specified by an Amazon service.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface 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)
# Data Types
The following data types are supported by 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)
The following data types are supported by 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)
The following data types are supported by AWS Backup search:
+ [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
The following data types are supported by 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
The backup options for each resource type.
## Contents
** BackupOptions **
Specifies the backup option for a selected resource. This option is available for Windows VSS backup jobs and S3 backups.
Valid values:
Set to `"WindowsVSS":"enabled"` to enable the `WindowsVSS` backup option and create a Windows VSS backup.
Set to `"WindowsVSS":"disabled"` to create a regular backup. The `WindowsVSS` option is not enabled by default.
For S3 backups, set to `"BackupACLs":"disabled"` to exclude ACLs from the backup, or `"BackupObjectTags":"disabled"` to exclude object tags from the backup. By default, both ACLs and object tags are included in S3 backups.
If you specify an invalid option, you get an `InvalidParameterValueException` exception.
For more information about Windows VSS backups, see [Creating a VSS-Enabled Windows Backup](https://docs.aws.amazon.com/aws-backup/latest/devguide/windows-backups.html).
Type: String to string map
Key Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Value Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Required: No
** ResourceType **
Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the [sample CloudFormation template to enable Windows VSS](https://docs.aws.amazon.com/aws-backup/latest/devguide/integrate-cloudformation-with-aws-backup.html) in the * AWS Backup User Guide*.
Valid values: `EC2`.
Type: String
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains aggregated scan results across multiple scan operations, providing a summary of scan status and findings.
## Contents
** FailedScan **
A Boolean value indicating whether any of the aggregated scans failed.
Type: Boolean
Required: No
** Findings **
An array of findings discovered across all aggregated scans.
Type: Array of strings
Valid Values: `MALWARE`
Required: No
** LastComputed **
The timestamp when the aggregated scan result was last computed, in Unix format and Coordinated Universal Time (UTC).
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains detailed information about a backup job.
## Contents
** AccountId **
The account ID that owns the backup job.
Type: String
Pattern: `^[0-9]{12}$`
Required: No
** BackupJobId **
Uniquely identifies a request to AWS Backup to back up a resource.
Type: String
Required: No
** BackupOptions **
Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
Valid values: Set to `"WindowsVSS":"enabled"` to enable the `WindowsVSS` backup option and create a Windows VSS backup. Set to `"WindowsVSS":"disabled"` to create a regular backup. If you specify an invalid option, you get an `InvalidParameterValueException` exception.
Type: String to string map
Key Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Value Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Required: No
** BackupSizeInBytes **
The size, in bytes, of a backup (recovery point).
This value can render differently depending on the resource type as AWS Backup pulls in data information from other AWS services. For example, the value returned may show a value of `0`, which may differ from the anticipated value.
The expected behavior for values by resource type are described as follows:
+ Amazon Aurora, Amazon DocumentDB, and Amazon Neptune do not have this value populate from the operation `GetBackupJobStatus`.
+ For Amazon DynamoDB with advanced features, this value refers to the size of the recovery point (backup).
+ Amazon EC2 and Amazon EBS show volume size (provisioned storage) returned as part of this value. Amazon EBS does not return backup size information; snapshot size will have the same value as the original resource that was backed up.
+ For Amazon EFS, this value refers to the delta bytes transferred during a backup.
+ For Amazon EKS, this value refers to the size of your nested EKS recovery point.
+ Amazon FSx does not populate this value from the operation `GetBackupJobStatus` for FSx file systems.
+ An Amazon RDS instance will show as `0`.
+ For virtual machines running VMware, this value is passed to AWS Backup through an asynchronous workflow, which can mean this displayed value can under-represent the actual backup size.
Type: Long
Required: No
** BackupType **
Represents the type of backup for a backup job.
Type: String
Required: No
** BackupVaultArn **
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
Type: String
Required: No
** BackupVaultName **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
Type: String
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: No
** BytesTransferred **
The size in bytes transferred to a backup vault at the time that the job status was queried.
Type: Long
Required: No
** CompletionDate **
The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of `CompletionDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** CreatedBy **
Contains identifying information about the creation of a backup job, including the `BackupPlanArn`, `BackupPlanId`, `BackupPlanVersion`, and `BackupRuleId` of the backup plan used to create it.
Type: [RecoveryPointCreator](API_RecoveryPointCreator.md) object
Required: No
** CreationDate **
The date and time a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** EncryptionKeyArn **
The Amazon Resource Name (ARN) of the KMS key used to encrypt the backup. This can be a customer-managed key or an AWS managed key, depending on the vault configuration.
Type: String
Required: No
** ExpectedCompletionDate **
The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of `ExpectedCompletionDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** IamRoleArn **
Specifies the IAM role ARN used to create the target recovery point. IAM roles other than the default role must include either `AWSBackup` or `AwsBackup` in the role name. For example, `arn:aws:iam::123456789012:role/AWSBackupRDSAccess`. Role names without those strings lack permissions to perform backup jobs.
Type: String
Required: No
** InitiationDate **
The date on which the backup job was initiated.
Type: Timestamp
Required: No
** IsEncrypted **
A boolean value indicating whether the backup is encrypted. All backups in AWS Backup are encrypted, but this field indicates the encryption status for transparency.
Type: Boolean
Required: No
** IsParent **
This is a boolean value indicating this is a parent (composite) backup job.
Type: Boolean
Required: No
** MessageCategory **
This parameter is the job count for the specified message category.
Example strings may include `AccessDenied`, `SUCCESS`, `AGGREGATE_ALL`, and `INVALIDPARAMETERS`. See [Monitoring](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html) for a list of MessageCategory strings.
The the value ANY returns count of all message categories.
`AGGREGATE_ALL` aggregates job counts for all message categories and returns the sum.
Type: String
Required: No
** ParentJobId **
This uniquely identifies a request to AWS Backup to back up a resource. The return will be the parent (composite) job ID.
Type: String
Required: No
** PercentDone **
Contains an estimated percentage complete of a job at the time the job status was queried.
Type: String
Required: No
** RecoveryPointArn **
An ARN that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Type: String
Required: No
** RecoveryPointLifecycle **
Specifies the time period, in days, before a recovery point transitions to cold storage or is deleted.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the retention setting must be 90 days greater than the transition to cold after days setting. The transition to cold after days setting can't be changed after a backup has been transitioned to cold.
Resource types that can transition to cold storage are listed in the [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.
To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, specify -1 for `MoveToColdStorageAfterDays` and `DeleteAfterDays`.
Type: [Lifecycle](API_Lifecycle.md) object
Required: No
** ResourceArn **
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
Type: String
Required: No
** ResourceName **
The non-unique name of the resource that belongs to the specified backup.
Type: String
Required: No
** ResourceType **
The type of AWS resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
Type: String
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Required: No
** StartBy **
Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the `StartBy` time would be 8:00 PM on the date specified. The value of `StartBy` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** State **
The current state of a backup job.
Type: String
Valid Values: `CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL`
Required: No
** StatusMessage **
A detailed message explaining the status of the job to back up a resource.
Type: String
Required: No
** VaultLockState **
The lock state of the backup vault. For logically air-gapped vaults, this indicates whether the vault is locked in compliance mode. Valid values include `LOCKED` and `UNLOCKED`.
Type: String
Required: No
** VaultType **
The type of backup vault where the recovery point is stored. Valid values are `BACKUP_VAULT` for standard backup vaults and `LOGICALLY_AIR_GAPPED_BACKUP_VAULT` for logically air-gapped vaults.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This is a summary of jobs created or running within the most recent 30 days.
The returned summary may contain the following: Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
## Contents
** AccountId **
The account ID that owns the jobs within the summary.
Type: String
Pattern: `^[0-9]{12}$`
Required: No
** Count **
The value as a number of jobs in a job summary.
Type: Integer
Required: No
** EndTime **
The value of time in number format of a job end time.
This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** MessageCategory **
This parameter is the job count for the specified message category.
Example strings include `AccessDenied`, `Success`, and `InvalidParameters`. See [Monitoring](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html) for a list of MessageCategory strings.
The the value ANY returns count of all message categories.
`AGGREGATE_ALL` aggregates job counts for all message categories and returns the sum.
Type: String
Required: No
** Region **
The AWS Regions within the job summary.
Type: String
Required: No
** ResourceType **
This value is the job count for the specified resource type. The request `GetSupportedResourceTypes` returns strings for supported resource types.
Type: String
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Required: No
** StartTime **
The value of time in number format of a job start time.
This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** State **
This value is job count for jobs with the specified state.
Type: String
Valid Values: `CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL | AGGREGATE_ALL | ANY`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains an optional backup plan display name and an array of `BackupRule` objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task and can back up a different selection of AWS resources.
## Contents
** BackupPlanName **
The display name of a backup plan. Must contain only alphanumeric or '-\$1.' special characters.
If this is set in the console, it can contain 1 to 50 characters; if this is set through CLI or API, it can contain 1 to 200 characters.
Type: String
Required: Yes
** Rules **
An array of `BackupRule` objects, each of which specifies a scheduled task that is used to back up a selection of resources.
Type: Array of [BackupRule](API_BackupRule.md) objects
Required: Yes
** AdvancedBackupSettings **
Contains a list of `BackupOptions` for each resource type.
Type: Array of [AdvancedBackupSetting](API_AdvancedBackupSetting.md) objects
Required: No
** ScanSettings **
Contains your scanning configuration for the backup plan and includes the Malware scanner, your selected resources, and scanner role.
Type: Array of [ScanSetting](API_ScanSetting.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains an optional backup plan display name and an array of `BackupRule` objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task.
## Contents
** BackupPlanName **
The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-\$1.' characters.
Type: String
Required: Yes
** Rules **
An array of `BackupRule` objects, each of which specifies a scheduled task that is used to back up a selection of resources.
Type: Array of [BackupRuleInput](API_BackupRuleInput.md) objects
Required: Yes
** AdvancedBackupSettings **
Specifies a list of `BackupOptions` for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
Type: Array of [AdvancedBackupSetting](API_AdvancedBackupSetting.md) objects
Required: No
** ScanSettings **
Contains your scanning configuration for the backup rule and includes the malware scanner, and scan mode of either full or incremental.
Type: Array of [ScanSetting](API_ScanSetting.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains metadata about a backup plan.
## Contents
** AdvancedBackupSettings **
Contains a list of `BackupOptions` for a resource type.
Type: Array of [AdvancedBackupSetting](API_AdvancedBackupSetting.md) objects
Required: No
** BackupPlanArn **
An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, `arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50`.
Type: String
Required: No
** BackupPlanId **
Uniquely identifies a backup plan.
Type: String
Required: No
** BackupPlanName **
The display name of a saved backup plan.
Type: String
Required: No
** CreationDate **
The date and time a resource backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** CreatorRequestId **
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-\$1.' characters.
Type: String
Required: No
** DeletionDate **
The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of `DeletionDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** LastExecutionDate **
The last time this backup plan was run. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of `LastExecutionDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** VersionId **
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
An object specifying metadata associated with a backup plan template.
## Contents
** BackupPlanTemplateId **
Uniquely identifies a stored backup plan template.
Type: String
Required: No
** BackupPlanTemplateName **
The optional display name of a backup plan template.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Specifies a scheduled task used to back up a selection of resources.
## Contents
** RuleName **
A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-\$1.' characters.
Type: String
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Required: Yes
** TargetBackupVaultName **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
Type: String
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
** CompletionWindowMinutes **
A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by AWS Backup. This value is optional.
Type: Long
Required: No
** CopyActions **
An array of `CopyAction` objects, which contains the details of the copy operation.
Type: Array of [CopyAction](API_CopyAction.md) objects
Required: No
** EnableContinuousBackup **
Specifies whether AWS Backup creates continuous backups. True causes AWS Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes AWS Backup to create snapshot backups.
Type: Boolean
Required: No
** IndexActions **
IndexActions is an array you use to specify how backup data should be indexed.
eEach BackupRule can have 0 or 1 IndexAction, as each backup can have up to one index associated with it.
Within the array is ResourceType. Only one will be accepted for each BackupRule.
Type: Array of [IndexAction](API_IndexAction.md) objects
Required: No
** Lifecycle **
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that can transition to cold storage are listed in the [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.
Type: [Lifecycle](API_Lifecycle.md) object
Required: No
** RecoveryPointTags **
The tags that are assigned to resources that are associated with this rule when restored from backup.
Type: String to string map
Required: No
** RuleId **
Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
Type: String
Required: No
** ScanActions **
Contains your scanning configuration for the backup rule and includes the malware scanner, and scan mode of either full or incremental.
Type: Array of [ScanAction](API_ScanAction.md) objects
Required: No
** ScheduleExpression **
A cron expression in UTC specifying when AWS Backup initiates a backup job. When no CRON expression is provided, AWS Backup will use the default expression `cron(0 5 ? * * *)`.
For more information about AWS cron expressions, see [Schedule Expressions for Rules](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html) in the *Amazon CloudWatch Events User Guide*.
Two examples of AWS cron expressions are ` 15 * ? * * *` (take a backup every hour at 15 minutes past the hour) and `0 12 * * ? *` (take a backup every day at 12 noon UTC).
For a table of examples, click the preceding link and scroll down the page.
Type: String
Required: No
** ScheduleExpressionTimezone **
The timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
Type: String
Required: No
** StartWindowMinutes **
A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, it must be at least 60 minutes to avoid errors.
During the start window, the backup job status remains in `CREATED` status until it has successfully begun or until the start window time has run out. If within the start window time AWS Backup receives an error that allows the job to be retried, AWS Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to `RUNNING`) or until the job status changes to `EXPIRED` (which is expected to occur when the start window time is over).
Type: Long
Required: No
** TargetLogicallyAirGappedBackupVaultArn **
The ARN of a logically air-gapped vault. ARN must be in the same account and Region. If provided, supported fully managed resources back up directly to logically air-gapped vault, while other supported resources create a temporary (billable) snapshot in backup vault, then copy it to logically air-gapped vault. Unsupported resources only back up to the specified backup vault.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Specifies a scheduled task used to back up a selection of resources.
## Contents
** RuleName **
A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-\$1.' characters.
Type: String
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Required: Yes
** TargetBackupVaultName **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
Type: String
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: Yes
** CompletionWindowMinutes **
A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by AWS Backup. This value is optional.
Type: Long
Required: No
** CopyActions **
An array of `CopyAction` objects, which contains the details of the copy operation.
Type: Array of [CopyAction](API_CopyAction.md) objects
Required: No
** EnableContinuousBackup **
Specifies whether AWS Backup creates continuous backups. True causes AWS Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes AWS Backup to create snapshot backups.
Type: Boolean
Required: No
** IndexActions **
There can up to one IndexAction in each BackupRule, as each backup can have 0 or 1 backup index associated with it.
Within the array is ResourceTypes. Only 1 resource type will be accepted for each BackupRule. Valid values:
+ `EBS` for Amazon Elastic Block Store
+ `S3` for Amazon Simple Storage Service (Amazon S3)
Type: Array of [IndexAction](API_IndexAction.md) objects
Required: No
** Lifecycle **
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup will transition and expire backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold storage.
Resource types that can transition to cold storage are listed in the [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.
This parameter has a maximum value of 100 years (36,500 days).
Type: [Lifecycle](API_Lifecycle.md) object
Required: No
** RecoveryPointTags **
The tags to assign to the resources.
Type: String to string map
Required: No
** ScanActions **
Contains your scanning configuration for the backup rule and includes the malware scanner, and scan mode of either full or incremental.
Type: Array of [ScanAction](API_ScanAction.md) objects
Required: No
** ScheduleExpression **
A CRON expression in UTC specifying when AWS Backup initiates a backup job. When no CRON expression is provided, AWS Backup will use the default expression `cron(0 5 ? * * *)`.
Type: String
Required: No
** ScheduleExpressionTimezone **
The timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
Type: String
Required: No
** StartWindowMinutes **
A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, it must be at least 60 minutes to avoid errors.
This parameter has a maximum value of 100 years (52,560,000 minutes).
During the start window, the backup job status remains in `CREATED` status until it has successfully begun or until the start window time has run out. If within the start window time AWS Backup receives an error that allows the job to be retried, AWS Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to `RUNNING`) or until the job status changes to `EXPIRED` (which is expected to occur when the start window time is over).
Type: Long
Required: No
** TargetLogicallyAirGappedBackupVaultArn **
The ARN of a logically air-gapped vault. ARN must be in the same account and Region. If provided, supported fully managed resources back up directly to logically air-gapped vault, while other supported resources create a temporary (billable) snapshot in backup vault, then copy it to logically air-gapped vault. Unsupported resources only back up to the specified backup vault.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Used to specify a set of resources to a backup plan.
We recommend that you specify conditions, tags, or resources to include or exclude. Otherwise, Backup attempts to select all supported and opted-in storage resources, which could have unintended cost implications.
For more information, see [Assigning resources programmatically](https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-json).
## Contents
** IamRoleArn **
The ARN of the IAM role that AWS Backup uses to authenticate when backing up the target resource; for example, `arn:aws:iam::123456789012:role/S3Access`.
Type: String
Required: Yes
** SelectionName **
The display name of a resource selection document. Must contain 1 to 50 alphanumeric or '-\$1.' characters.
Type: String
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Required: Yes
** Conditions **
The conditions that you define to assign resources to your backup plans using tags. For example, `"StringEquals": { "ConditionKey": "aws:ResourceTag/backup", "ConditionValue": "daily" }`.
`Conditions` supports `StringEquals`, `StringLike`, `StringNotEquals`, and `StringNotLike`. Condition operators are case sensitive.
If you specify multiple conditions, the resources much match all conditions (AND logic).
Type: [Conditions](API_Conditions.md) object
Required: No
** ListOfTags **
We recommend that you use the `Conditions` parameter instead of this parameter.
The conditions that you define to assign resources to your backup plans using tags. For example, `"StringEquals": { "ConditionKey": "backup", "ConditionValue": "daily"}`.
`ListOfTags` supports only `StringEquals`. Condition operators are case sensitive.
If you specify multiple conditions, the resources much match any of the conditions (OR logic).
Type: Array of [Condition](API_Condition.md) objects
Required: No
** NotResources **
The Amazon Resource Names (ARNs) of the resources to exclude from a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.
If you need to exclude many resources from a backup plan, consider a different resource selection strategy, such as assigning only one or a few resource types or refining your resource selection using tags.
Type: Array of strings
Required: No
** Resources **
The Amazon Resource Names (ARNs) of the resources to assign to a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.
If you need to assign many resources to a backup plan, consider a different resource selection strategy, such as assigning all resources of a resource type or refining your resource selection using tags.
If you specify multiple ARNs, the resources much match any of the ARNs (OR logic).
When using wildcards in ARN patterns for backup selections, the asterisk (\$1) must appear at the end of the ARN string (prefix pattern). For example, `arn:aws:s3:::my-bucket-*` is valid, but `arn:aws:s3:::*-logs` is not supported.
Type: Array of strings
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains metadata about a `BackupSelection` object.
## Contents
** BackupPlanId **
Uniquely identifies a backup plan.
Type: String
Required: No
** CreationDate **
The date and time a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** CreatorRequestId **
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-\$1.' characters.
Type: String
Required: No
** IamRoleArn **
Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery point; for example, `arn:aws:iam::123456789012:role/S3Access`.
Type: String
Required: No
** SelectionId **
Uniquely identifies a request to assign a set of resources to a backup plan.
Type: String
Required: No
** SelectionName **
The display name of a resource selection document.
Type: String
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains metadata about a backup vault.
## Contents
** BackupVaultArn **
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
Type: String
Required: No
** BackupVaultName **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
Type: String
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: No
** CreationDate **
The date and time a resource backup is created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** CreatorRequestId **
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-\$1.' characters.
Type: String
Required: No
** EncryptionKeyArn **
A server-side encryption key you can specify to encrypt your backups from services that support full AWS Backup management; for example, `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`. If you specify a key, you must specify its ARN, not its alias. If you do not specify a key, AWS Backup creates a KMS key for you by default.
To learn which AWS Backup services support full AWS Backup management and how AWS Backup handles encryption for backups from services that do not yet support full AWS Backup, see [ Encryption for backups in AWS Backup](https://docs.aws.amazon.com/aws-backup/latest/devguide/encryption.html)
Type: String
Required: No
** EncryptionKeyType **
The type of encryption key used for the backup vault. Valid values are CUSTOMER\$1MANAGED\$1KMS\$1KEY for customer-managed keys or AWS\$1OWNED\$1KMS\$1KEY for AWS-owned keys.
Type: String
Valid Values: `AWS_OWNED_KMS_KEY | CUSTOMER_MANAGED_KMS_KEY`
Required: No
** LockDate **
The date and time when AWS Backup Vault Lock configuration becomes immutable, meaning it cannot be changed or deleted.
If you applied Vault Lock to your vault without specifying a lock date, you can change your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.
This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** Locked **
A Boolean value that indicates whether AWS Backup Vault Lock applies to the selected backup vault. If `true`, Vault Lock prevents delete and update operations on the recovery points in the selected vault.
Type: Boolean
Required: No
** MaxRetentionDays **
The AWS Backup Vault Lock setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).
If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.
Type: Long
Required: No
** MinRetentionDays **
The AWS Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a minimum retention period.
If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.
Type: Long
Required: No
** NumberOfRecoveryPoints **
The number of recovery points that are stored in a backup vault. Recovery point count value displayed in the console can be an approximation.
Type: Long
Required: No
** VaultState **
The current state of the vault.
Type: String
Valid Values: `CREATING | AVAILABLE | FAILED`
Required: No
** VaultType **
The type of vault in which the described recovery point is stored.
Type: String
Valid Values: `BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT | RESTORE_ACCESS_BACKUP_VAULT`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains `DeleteAt` and `MoveToColdStorageAt` timestamps, which are used to specify a lifecycle for a recovery point.
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that can transition to cold storage are listed in the [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.
## Contents
** DeleteAt **
A timestamp that specifies when to delete a recovery point.
Type: Timestamp
Required: No
** MoveToColdStorageAt **
A timestamp that specifies when to transition a recovery point to cold storage.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains an array of triplets made up of a condition type (such as `StringEquals`), a key, and a value. Used to filter resources using their tags and assign them to a backup plan. Case sensitive.
## Contents
** ConditionKey **
The key in a key-value pair. For example, in the tag `Department: Accounting`, `Department` is the key.
Type: String
Required: Yes
** ConditionType **
An operation applied to a key-value pair used to assign resources to your backup plan. Condition only supports `StringEquals`. For more flexible assignment options, including `StringLike` and the ability to exclude resources from your backup plan, use `Conditions` (with an "s" on the end) for your [https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BackupSelection.html](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BackupSelection.html).
Type: String
Valid Values: `STRINGEQUALS`
Required: Yes
** ConditionValue **
The value in a key-value pair. For example, in the tag `Department: Accounting`, `Accounting` is the value.
Type: String
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Includes information about tags you define to assign tagged resources to a backup plan.
Include the prefix `aws:ResourceTag` in your tags. For example, `"aws:ResourceTag/TagKey1": "Value1"`.
## Contents
** ConditionKey **
The key in a key-value pair. For example, in the tag `Department: Accounting`, `Department` is the key.
Type: String
Required: No
** ConditionValue **
The value in a key-value pair. For example, in the tag `Department: Accounting`, `Accounting` is the value.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains information about which resources to include or exclude from a backup plan using their tags. Conditions are case sensitive.
## Contents
** StringEquals **
Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called "exact matching."
Type: Array of [ConditionParameter](API_ConditionParameter.md) objects
Required: No
** StringLike **
Filters the values of your tagged resources for matching tag values with the use of a wildcard character (\$1) anywhere in the string. For example, "prod\$1" or "\$1rod\$1" matches the tag value "production".
Type: Array of [ConditionParameter](API_ConditionParameter.md) objects
Required: No
** StringNotEquals **
Filters the values of your tagged resources for only those resources that you tagged that do not have the same value. Also called "negated matching."
Type: Array of [ConditionParameter](API_ConditionParameter.md) objects
Required: No
** StringNotLike **
Filters the values of your tagged resources for non-matching tag values with the use of a wildcard character (\$1) anywhere in the string.
Type: Array of [ConditionParameter](API_ConditionParameter.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
The parameters for a control. A control can have zero, one, or more than one parameter. An example of a control with two parameters is: "backup plan frequency is at least `daily` and the retention period is at least `1 year`". The first parameter is `daily`. The second parameter is `1 year`.
## Contents
** ParameterName **
The name of a parameter, for example, `BackupPlanFrequency`.
Type: String
Required: No
** ParameterValue **
The value of parameter, for example, `hourly`.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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 framework consists of one or more controls. Each control has its own control scope. The control scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. If no scope is specified, evaluations for the rule are triggered when any resource in your recording group changes in configuration.
**Note**
To set a control scope that includes all of a particular resource, leave the `ControlScope` empty or do not pass it when calling `CreateFramework`.
## Contents
** ComplianceResourceIds **
The ID of the only AWS resource that you want your control scope to contain.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** ComplianceResourceTypes **
Describes whether the control scope includes one or more types of resources, such as `EFS` or `RDS`.
Type: Array of strings
Required: No
** Tags **
The tag key-value pair applied to those AWS resources that you want to trigger an evaluation for a rule. A maximum of one key-value pair can be provided. The tag value is optional, but it cannot be an empty string if you are creating or editing a framework from the console (though the value can be an empty string when included in a CloudFormation template).
The structure to assign a tag is: `[{"Key":"string","Value":"string"}]`.
Type: String to string map
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
The details of the copy operation.
## Contents
** DestinationBackupVaultArn **
An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup. For example, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
Type: String
Required: Yes
** Lifecycle **
Specifies the time period, in days, before a recovery point transitions to cold storage or is deleted.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the retention setting must be 90 days greater than the transition to cold after days setting. The transition to cold after days setting can't be changed after a backup has been transitioned to cold.
Resource types that can transition to cold storage are listed in the [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.
To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, specify -1 for `MoveToColdStorageAfterDays` and `DeleteAfterDays`.
Type: [Lifecycle](API_Lifecycle.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains detailed information about a copy job.
## Contents
** AccountId **
The account ID that owns the copy job.
Type: String
Pattern: `^[0-9]{12}$`
Required: No
** BackupSizeInBytes **
The size, in bytes, of a copy job.
Type: Long
Required: No
** ChildJobsInState **
This returns the statistics of the included child (nested) copy jobs.
Type: String to long map
Valid Keys: `CREATED | RUNNING | COMPLETED | FAILED | PARTIAL`
Required: No
** CompletionDate **
The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC). The value of `CompletionDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** CompositeMemberIdentifier **
The identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the [ logical ID](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax) within a stack.
Type: String
Required: No
** CopyJobId **
Uniquely identifies a copy job.
Type: String
Required: No
** CreatedBy **
Contains information about the backup plan and rule that AWS Backup used to initiate the recovery point backup.
Type: [RecoveryPointCreator](API_RecoveryPointCreator.md) object
Required: No
** CreatedByBackupJobId **
The backup job ID that initiated this copy job. Only applicable to scheduled copy jobs and automatic copy jobs to logically air-gapped vault.
Type: String
Required: No
** CreationDate **
The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** DestinationBackupVaultArn **
An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
Type: String
Required: No
** DestinationEncryptionKeyArn **
The Amazon Resource Name (ARN) of the KMS key used to encrypt the copied backup in the destination vault. This can be a customer-managed key or an AWS managed key.
Type: String
Required: No
** DestinationRecoveryPointArn **
An ARN that uniquely identifies a destination recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Type: String
Required: No
** DestinationRecoveryPointLifecycle **
Specifies the time period, in days, before a recovery point transitions to cold storage or is deleted.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the retention setting must be 90 days greater than the transition to cold after days setting. The transition to cold after days setting can't be changed after a backup has been transitioned to cold.
Resource types that can transition to cold storage are listed in the [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.
To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, specify -1 for `MoveToColdStorageAfterDays` and `DeleteAfterDays`.
Type: [Lifecycle](API_Lifecycle.md) object
Required: No
** DestinationVaultLockState **
The lock state of the destination backup vault. For logically air-gapped vaults, this indicates whether the vault is locked in compliance mode. Valid values include `LOCKED` and `UNLOCKED`.
Type: String
Required: No
** DestinationVaultType **
The type of destination backup vault where the copied recovery point is stored. Valid values are `BACKUP_VAULT` for standard backup vaults and `LOGICALLY_AIR_GAPPED_BACKUP_VAULT` for logically air-gapped vaults.
Type: String
Required: No
** IamRoleArn **
Specifies the IAM role ARN used to copy the target recovery point; for example, `arn:aws:iam::123456789012:role/S3Access`.
Type: String
Required: No
** IsParent **
This is a boolean value indicating this is a parent (composite) copy job.
Type: Boolean
Required: No
** MessageCategory **
This parameter is the job count for the specified message category.
Example strings may include `AccessDenied`, `SUCCESS`, `AGGREGATE_ALL`, and `InvalidParameters`. See [Monitoring](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html) for a list of MessageCategory strings.
The the value ANY returns count of all message categories.
`AGGREGATE_ALL` aggregates job counts for all message categories and returns the sum
Type: String
Required: No
** NumberOfChildJobs **
The number of child (nested) copy jobs.
Type: Long
Required: No
** ParentJobId **
This uniquely identifies a request to AWS Backup to copy a resource. The return will be the parent (composite) job ID.
Type: String
Required: No
** ResourceArn **
The AWS resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
Type: String
Required: No
** ResourceName **
The non-unique name of the resource that belongs to the specified backup.
Type: String
Required: No
** ResourceType **
The type of AWS resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
Type: String
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Required: No
** SourceBackupVaultArn **
An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
Type: String
Required: No
** SourceRecoveryPointArn **
An ARN that uniquely identifies a source recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Type: String
Required: No
** State **
The current state of a copy job.
Type: String
Valid Values: `CREATED | RUNNING | COMPLETED | FAILED | PARTIAL`
Required: No
** StatusMessage **
A detailed message explaining the status of the job to copy a resource.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This is a summary of copy jobs created or running within the most recent 30 days.
The returned summary may contain the following: Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
## Contents
** AccountId **
The account ID that owns the jobs within the summary.
Type: String
Pattern: `^[0-9]{12}$`
Required: No
** Count **
The value as a number of jobs in a job summary.
Type: Integer
Required: No
** EndTime **
The value of time in number format of a job end time.
This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** MessageCategory **
This parameter is the job count for the specified message category.
Example strings include `AccessDenied`, `Success`, and `InvalidParameters`. See [Monitoring](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html) for a list of MessageCategory strings.
The the value ANY returns count of all message categories.
`AGGREGATE_ALL` aggregates job counts for all message categories and returns the sum.
Type: String
Required: No
** Region **
The AWS Regions within the job summary.
Type: String
Required: No
** ResourceType **
This value is the job count for the specified resource type. The request `GetSupportedResourceTypes` returns strings for supported resource types
Type: String
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Required: No
** StartTime **
The value of time in number format of a job start time.
This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** State **
This value is job count for jobs with the specified state.
Type: String
Valid Values: `CREATED | RUNNING | ABORTING | ABORTED | COMPLETING | COMPLETED | FAILING | FAILED | PARTIAL | AGGREGATE_ALL | ANY`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This is a resource filter containing FromDate: DateTime and ToDate: DateTime. Both values are required. Future DateTime values are not permitted.
The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds ((milliseconds are optional). For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
## Contents
** FromDate **
This value is the beginning date, inclusive.
The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).
Type: Timestamp
Required: Yes
** ToDate **
This value is the end date, inclusive.
The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).
Type: Timestamp
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains detailed information about a framework. Frameworks contain controls, which evaluate and report on your backup events and resources. Frameworks generate daily compliance results.
## Contents
** CreationTime **
The date and time that a framework is created, in ISO 8601 representation. The value of `CreationTime` is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.
Type: Timestamp
Required: No
** DeploymentStatus **
The deployment status of a framework. The statuses are:
`CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED`
Type: String
Required: No
** FrameworkArn **
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
Type: String
Required: No
** FrameworkDescription **
An optional description of the framework with a maximum 1,024 characters.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: `.*\S.*`
Required: No
** FrameworkName **
The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (\$1).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z][_a-zA-Z0-9]*`
Required: No
** NumberOfControls **
The number of controls contained by the framework.
Type: Integer
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains detailed information about all of the controls of a framework. Each framework must contain at least one control.
## Contents
** ControlName **
The name of a control. This name is between 1 and 256 characters.
Type: String
Required: Yes
** ControlInputParameters **
The name/value pairs.
Type: Array of [ControlInputParameter](API_ControlInputParameter.md) objects
Required: No
** ControlScope **
The scope of a control. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans.
For more information, see [`ControlScope`.](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ControlScope.html)
Type: [ControlScope](API_ControlScope.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This is an optional array within a BackupRule.
IndexAction consists of one ResourceTypes.
## Contents
** ResourceTypes **
0 or 1 index action will be accepted for each BackupRule.
Valid values:
+ `EBS` for Amazon Elastic Block Store
+ `S3` for Amazon Simple Storage Service (Amazon S3)
Type: Array of strings
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This is a recovery point that has an associated backup index.
Only recovery points with a backup index can be included in a search.
## Contents
** BackupCreationDate **
The date and time that a backup was created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** BackupVaultArn **
An ARN that uniquely identifies the backup vault where the recovery point index is stored.
For example, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
Type: String
Required: No
** IamRoleArn **
This specifies the IAM role ARN used for this operation.
For example, arn:aws:iam::123456789012:role/S3Access
Type: String
Required: No
** IndexCreationDate **
The date and time that a backup index was created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** IndexStatus **
This is the current status for the backup index associated with the specified recovery point.
Statuses are: `PENDING` \$1 `ACTIVE` \$1 `FAILED` \$1 `DELETING`
A recovery point with an index that has the status of `ACTIVE` can be included in a search.
Type: String
Valid Values: `PENDING | ACTIVE | FAILED | DELETING`
Required: No
** IndexStatusMessage **
A string in the form of a detailed message explaining the status of a backup index associated with the recovery point.
Type: String
Required: No
** RecoveryPointArn **
An ARN that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`
Type: String
Required: No
** ResourceType **
The resource type of the indexed recovery point.
+ `EBS` for Amazon Elastic Block Store
+ `S3` for Amazon Simple Storage Service (Amazon S3)
Type: String
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Required: No
** SourceResourceArn **
A string of the Amazon Resource Name (ARN) that uniquely identifies the source resource.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Pair of two related strings. Allowed characters are letters, white space, and numbers that can be represented in UTF-8 and the following characters: ` + - = . _ : /`
## Contents
** Key **
The tag key (String). The key can't start with `aws:`.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `^(?![aA]{1}[wW]{1}[sS]{1}:)([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$`
Type: String
Required: Yes
** Value **
The value of the key.
Length Constraints: Maximum length of 256.
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`
Type: String
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains information about the latest update to an MPA approval team association.
## Contents
** ExpiryDate **
The date and time when the MPA approval team update will expire.
Type: Timestamp
Required: No
** InitiationDate **
The date and time when the MPA approval team update was initiated.
Type: Timestamp
Required: No
** MpaSessionArn **
The ARN of the MPA session associated with this update.
Type: String
Required: No
** Status **
The current status of the MPA approval team update.
Type: String
Valid Values: `PENDING | APPROVED | FAILED`
Required: No
** StatusMessage **
A message describing the current status of the MPA approval team update.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains information about the latest request to revoke access to a backup vault.
## Contents
** ExpiryDate **
The date and time when the revoke request will expire.
Type: Timestamp
Required: No
** InitiationDate **
The date and time when the revoke request was initiated.
Type: Timestamp
Required: No
** MpaSessionArn **
The ARN of the MPA session associated with this revoke request.
Type: String
Required: No
** Status **
The current status of the revoke request.
Type: String
Valid Values: `PENDING | FAILED`
Required: No
** StatusMessage **
A message describing the current status of the revoke request.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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 legal hold is an administrative tool that helps prevent backups from being deleted while under a hold. While the hold is in place, backups under a hold cannot be deleted and lifecycle policies that would alter the backup status (such as transition to cold storage) are delayed until the legal hold is removed. A backup can have more than one legal hold. Legal holds are applied to one or more backups (also known as recovery points). These backups can be filtered by resource types and by resource IDs.
## Contents
** CancellationDate **
The time when the legal hold was cancelled.
Type: Timestamp
Required: No
** CreationDate **
The time when the legal hold was created.
Type: Timestamp
Required: No
** Description **
The description of a legal hold.
Type: String
Required: No
** LegalHoldArn **
The Amazon Resource Name (ARN) of the legal hold; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Type: String
Required: No
** LegalHoldId **
The ID of the legal hold.
Type: String
Required: No
** Status **
The status of the legal hold.
Type: String
Valid Values: `CREATING | ACTIVE | CANCELING | CANCELED`
Required: No
** Title **
The title of a legal hold.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Specifies the time period, in days, before a recovery point transitions to cold storage or is deleted.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the retention setting must be 90 days greater than the transition to cold after days setting. The transition to cold after days setting can't be changed after a backup has been transitioned to cold.
Resource types that can transition to cold storage are listed in the [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.
To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, specify -1 for `MoveToColdStorageAfterDays` and `DeleteAfterDays`.
## Contents
** DeleteAfterDays **
The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in `MoveToColdStorageAfterDays`.
Type: Long
Required: No
** DeleteAfterEvent **
The event after which a recovery point is deleted. A recovery point with both `DeleteAfterDays` and `DeleteAfterEvent` will delete after whichever condition is satisfied first. Not valid as an input.
Type: String
Valid Values: `DELETE_AFTER_COPY`
Required: No
** MoveToColdStorageAfterDays **
The number of days after creation that a recovery point is moved to cold storage.
Type: Long
Required: No
** OptInToArchiveForSupportedResources **
If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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 structure that contains information about a backed-up resource.
## Contents
** LastBackupTime **
The date and time a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of `LastBackupTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** LastBackupVaultArn **
The ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point.
Type: String
Required: No
** LastRecoveryPointArn **
The ARN (Amazon Resource Name) of the most recent recovery point.
Type: String
Required: No
** ResourceArn **
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
Type: String
Required: No
** ResourceName **
The non-unique name of the resource that belongs to the specified backup.
Type: String
Required: No
** ResourceType **
The type of AWS resource; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
Type: String
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
The conditions that you define for resources in your restore testing plan using tags.
## Contents
** StringEquals **
Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called "exact matching."
Type: Array of [KeyValue](API_KeyValue.md) objects
Required: No
** StringNotEquals **
Filters the values of your tagged resources for only those resources that you tagged that do not have the same value. Also called "negated matching."
Type: Array of [KeyValue](API_KeyValue.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains detailed information about the recovery points stored in a backup vault.
## Contents
** AggregatedScanResult **
Contains the latest scanning results against the recovery point and currently include `FailedScan`, `Findings`, `LastComputed`.
Type: [AggregatedScanResult](API_AggregatedScanResult.md) object
Required: No
** BackupSizeInBytes **
The size, in bytes, of a backup.
Type: Long
Required: No
** BackupVaultArn **
An ARN that uniquely identifies a backup vault; for example, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
Type: String
Required: No
** BackupVaultName **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
Type: String
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: No
** CalculatedLifecycle **
A `CalculatedLifecycle` object containing `DeleteAt` and `MoveToColdStorageAt` timestamps.
Type: [CalculatedLifecycle](API_CalculatedLifecycle.md) object
Required: No
** CompletionDate **
The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of `CompletionDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** CompositeMemberIdentifier **
The identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the [ logical ID](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax) within a stack.
Type: String
Required: No
** CreatedBy **
Contains identifying information about the creation of a recovery point, including the `BackupPlanArn`, `BackupPlanId`, `BackupPlanVersion`, and `BackupRuleId` of the backup plan that is used to create it.
Type: [RecoveryPointCreator](API_RecoveryPointCreator.md) object
Required: No
** CreationDate **
The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** EncryptionKeyArn **
The server-side encryption key that is used to protect your backups; for example, `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
Type: String
Required: No
** EncryptionKeyType **
The type of encryption key used for the recovery point. Valid values are CUSTOMER\$1MANAGED\$1KMS\$1KEY for customer-managed keys or AWS\$1OWNED\$1KMS\$1KEY for AWS-owned keys.
Type: String
Valid Values: `AWS_OWNED_KMS_KEY | CUSTOMER_MANAGED_KMS_KEY`
Required: No
** IamRoleArn **
Specifies the IAM role ARN used to create the target recovery point; for example, `arn:aws:iam::123456789012:role/S3Access`.
Type: String
Required: No
** IndexStatus **
This is the current status for the backup index associated with the specified recovery point.
Statuses are: `PENDING` \$1 `ACTIVE` \$1 `FAILED` \$1 `DELETING`
A recovery point with an index that has the status of `ACTIVE` can be included in a search.
Type: String
Valid Values: `PENDING | ACTIVE | FAILED | DELETING`
Required: No
** IndexStatusMessage **
A string in the form of a detailed message explaining the status of a backup index associated with the recovery point.
Type: String
Required: No
** InitiationDate **
The date and time when the backup job that created this recovery point was initiated, in Unix format and Coordinated Universal Time (UTC).
Type: Timestamp
Required: No
** IsEncrypted **
A Boolean value that is returned as `TRUE` if the specified recovery point is encrypted, or `FALSE` if the recovery point is not encrypted.
Type: Boolean
Required: No
** IsParent **
This is a boolean value indicating this is a parent (composite) recovery point.
Type: Boolean
Required: No
** LastRestoreTime **
The date and time a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of `LastRestoreTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** Lifecycle **
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that can transition to cold storage are listed in the [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.
Type: [Lifecycle](API_Lifecycle.md) object
Required: No
** ParentRecoveryPointArn **
The Amazon Resource Name (ARN) of the parent (composite) recovery point.
Type: String
Required: No
** RecoveryPointArn **
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Type: String
Required: No
** ResourceArn **
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
Type: String
Required: No
** ResourceName **
The non-unique name of the resource that belongs to the specified backup.
Type: String
Required: No
** ResourceType **
The type of AWS resource saved as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
Type: String
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Required: No
** SourceBackupVaultArn **
The backup vault where the recovery point was originally copied from. If the recovery point is restored to the same account this value will be `null`.
Type: String
Required: No
** Status **
A status code specifying the state of the recovery point.
Type: String
Valid Values: `COMPLETED | PARTIAL | DELETING | EXPIRED | AVAILABLE | STOPPED | CREATING`
Required: No
** StatusMessage **
A message explaining the current status of the recovery point.
Type: String
Required: No
** VaultType **
The type of vault in which the described recovery point is stored.
Type: String
Valid Values: `BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT | RESTORE_ACCESS_BACKUP_VAULT`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains detailed information about a saved recovery point.
## Contents
** AggregatedScanResult **
Contains the latest scanning results against the recovery point and currently include `FailedScan`, `Findings`, `LastComputed`.
Type: [AggregatedScanResult](API_AggregatedScanResult.md) object
Required: No
** BackupSizeBytes **
The size, in bytes, of a backup.
Type: Long
Required: No
** BackupVaultName **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
Type: String
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: No
** CreationDate **
The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** EncryptionKeyArn **
The server-side encryption key that is used to protect your backups; for example, `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
Type: String
Required: No
** EncryptionKeyType **
The type of encryption key used for the recovery point. Valid values are CUSTOMER\$1MANAGED\$1KMS\$1KEY for customer-managed keys or AWS\$1OWNED\$1KMS\$1KEY for AWS-owned keys.
Type: String
Valid Values: `AWS_OWNED_KMS_KEY | CUSTOMER_MANAGED_KMS_KEY`
Required: No
** IndexStatus **
This is the current status for the backup index associated with the specified recovery point.
Statuses are: `PENDING` \$1 `ACTIVE` \$1 `FAILED` \$1 `DELETING`
A recovery point with an index that has the status of `ACTIVE` can be included in a search.
Type: String
Valid Values: `PENDING | ACTIVE | FAILED | DELETING`
Required: No
** IndexStatusMessage **
A string in the form of a detailed message explaining the status of a backup index associated with the recovery point.
Type: String
Required: No
** IsParent **
This is a boolean value indicating this is a parent (composite) recovery point.
Type: Boolean
Required: No
** ParentRecoveryPointArn **
The Amazon Resource Name (ARN) of the parent (composite) recovery point.
Type: String
Required: No
** RecoveryPointArn **
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Type: String
Required: No
** ResourceName **
The non-unique name of the resource that belongs to the specified backup.
Type: String
Required: No
** Status **
A status code specifying the state of the recovery point.
Type: String
Valid Values: `COMPLETED | PARTIAL | DELETING | EXPIRED | AVAILABLE | STOPPED | CREATING`
Required: No
** StatusMessage **
A message explaining the current status of the recovery point.
Type: String
Required: No
** VaultType **
The type of vault in which the described recovery point is stored.
Type: String
Valid Values: `BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT | RESTORE_ACCESS_BACKUP_VAULT`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains information about the backup plan and rule that AWS Backup used to initiate the recovery point backup.
## Contents
** BackupPlanArn **
An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, `arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50`.
Type: String
Required: No
** BackupPlanId **
Uniquely identifies a backup plan.
Type: String
Required: No
** BackupPlanName **
The name of the backup plan that created this recovery point. This provides human-readable context about which backup plan was responsible for the backup job.
Type: String
Required: No
** BackupPlanVersion **
Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.
Type: String
Required: No
** BackupRuleCron **
The cron expression that defines the schedule for the backup rule. This shows the frequency and timing of when backups are automatically triggered.
Type: String
Required: No
** BackupRuleId **
Uniquely identifies a rule used to schedule the backup of a selection of resources.
Type: String
Required: No
** BackupRuleName **
The name of the backup rule within the backup plan that created this recovery point. This helps identify which specific rule triggered the backup job.
Type: String
Required: No
** BackupRuleTimezone **
The timezone used for the backup rule schedule. This provides context for when backups are scheduled to run in the specified timezone.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This is a recovery point which is a child (nested) recovery point of a parent (composite) recovery point. These recovery points can be disassociated from their parent (composite) recovery point, in which case they will no longer be a member.
## Contents
** BackupVaultName **
The name of the backup vault (the logical container in which backups are stored).
Type: String
Pattern: `^[a-zA-Z0-9\-\_]{2,50}$`
Required: No
** RecoveryPointArn **
The Amazon Resource Name (ARN) of the parent (composite) recovery point.
Type: String
Required: No
** ResourceArn **
The Amazon Resource Name (ARN) that uniquely identifies a saved resource.
Type: String
Required: No
** ResourceType **
The AWS resource type that is saved as a recovery point.
Type: String
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This specifies criteria to assign a set of resources, such as resource types or backup vaults.
## Contents
** DateRange **
This is a resource filter containing FromDate: DateTime and ToDate: DateTime. Both values are required. Future DateTime values are not permitted.
The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds ((milliseconds are optional). For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: [DateRange](API_DateRange.md) object
Required: No
** ResourceIdentifiers **
These are the resources included in the resource selection (including type of resources and vaults).
Type: Array of strings
Required: No
** VaultNames **
These are the names of the vaults in which the selected recovery points are contained.
Type: Array of strings
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains information from your report plan about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
## Contents
** S3BucketName **
The unique name of the S3 bucket that receives your reports.
Type: String
Required: Yes
** Formats **
The format of your reports: `CSV`, `JSON`, or both. If not specified, the default format is `CSV`.
Type: Array of strings
Required: No
** S3KeyPrefix **
The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/`prefix`/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains information from your report job about your report destination.
## Contents
** S3BucketName **
The unique name of the Amazon S3 bucket that receives your reports.
Type: String
Required: No
** S3Keys **
The object key that uniquely identifies your reports in your S3 bucket.
Type: Array of strings
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains detailed information about a report job. A report job compiles a report based on a report plan and publishes it to Amazon S3.
## Contents
** CompletionTime **
The date and time that a report job is completed, in Unix format and Coordinated Universal Time (UTC). The value of `CompletionTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** CreationTime **
The date and time that a report job is created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** ReportDestination **
The S3 bucket name and S3 keys for the destination where the report job publishes the report.
Type: [ReportDestination](API_ReportDestination.md) object
Required: No
** ReportJobId **
The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. Report job IDs cannot be edited.
Type: String
Required: No
** ReportPlanArn **
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
Type: String
Required: No
** ReportTemplate **
Identifies the report template for the report. Reports are built using a report template. The report templates are:
`RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT`
Type: String
Required: No
** Status **
The status of a report job. The statuses are:
`CREATED | RUNNING | COMPLETED | FAILED`
`COMPLETED` means that the report is available for your review at your designated destination. If the status is `FAILED`, review the `StatusMessage` for the reason.
Type: String
Required: No
** StatusMessage **
A message explaining the status of the report job.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains detailed information about a report plan.
## Contents
** CreationTime **
The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** DeploymentStatus **
The deployment status of a report plan. The statuses are:
`CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED`
Type: String
Required: No
** LastAttemptedExecutionTime **
The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC). The value of `LastAttemptedExecutionTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** LastSuccessfulExecutionTime **
The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC). The value of `LastSuccessfulExecutionTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** ReportDeliveryChannel **
Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
Type: [ReportDeliveryChannel](API_ReportDeliveryChannel.md) object
Required: No
** ReportPlanArn **
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
Type: String
Required: No
** ReportPlanDescription **
An optional description of the report plan with a maximum 1,024 characters.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: `.*\S.*`
Required: No
** ReportPlanName **
The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (\$1).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z][_a-zA-Z0-9]*`
Required: No
** ReportSetting **
Identifies the report template for the report. Reports are built using a report template. The report templates are:
`RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT`
If the report template is `RESOURCE_COMPLIANCE_REPORT` or `CONTROL_COMPLIANCE_REPORT`, this API resource also describes the report coverage by AWS Regions and frameworks.
Type: [ReportSetting](API_ReportSetting.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains detailed information about a report setting.
## Contents
** ReportTemplate **
Identifies the report template for the report. Reports are built using a report template. The report templates are:
`RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT | SCAN_JOB_REPORT`
Type: String
Required: Yes
** Accounts **
These are the accounts to be included in the report.
Use string value of `ROOT` to include all organizational units.
Type: Array of strings
Required: No
** FrameworkArns **
The Amazon Resource Names (ARNs) of the frameworks a report covers.
Type: Array of strings
Required: No
** NumberOfFrameworks **
The number of frameworks a report covers.
Type: Integer
Required: No
** OrganizationUnits **
These are the Organizational Units to be included in the report.
Type: Array of strings
Required: No
** Regions **
These are the Regions to be included in the report.
Use the wildcard as the string value to include all Regions.
Type: Array of strings
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This contains metadata about resource selection for tiering configurations.
You can specify up to 5 different resource selections per tiering configuration. Data moved to lower-cost tier remains there until deletion (one-way transition).
## Contents
** Resources **
An array of strings that either contains ARNs of the associated resources or contains a wildcard `*` to specify all resources. You can specify up to 100 specific resources per tiering configuration.
Type: Array of strings
Required: Yes
** ResourceType **
The type of AWS resource; for example, `S3` for Amazon S3. For tiering configurations, this is currently limited to `S3`.
Type: String
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Required: Yes
** TieringDownSettingsInDays **
The number of days after creation within a backup vault that an object can transition to the low cost warm storage tier. Must be a positive integer between 60 and 36500 days.
Type: Integer
Valid Range: Minimum value of 60. Maximum value of 36500.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains information about a restore access backup vault.
## Contents
** ApprovalDate **
The date and time when the restore access backup vault was approved.
Type: Timestamp
Required: No
** CreationDate **
The date and time when the restore access backup vault was created.
Type: Timestamp
Required: No
** LatestRevokeRequest **
Information about the latest request to revoke access to this backup vault.
Type: [LatestRevokeRequest](API_LatestRevokeRequest.md) object
Required: No
** RestoreAccessBackupVaultArn **
The ARN of the restore access backup vault.
Type: String
Required: No
** VaultState **
The current state of the restore access backup vault.
Type: String
Valid Values: `CREATING | AVAILABLE | FAILED`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains information about the restore testing plan that AWS Backup used to initiate the restore job.
## Contents
** RestoreTestingPlanArn **
An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains metadata about a restore job.
## Contents
** AccountId **
The account ID that owns the restore job.
Type: String
Pattern: `^[0-9]{12}$`
Required: No
** BackupSizeInBytes **
The size, in bytes, of the restored resource.
Type: Long
Required: No
** BackupVaultArn **
The Amazon Resource Name (ARN) of the backup vault containing the recovery point being restored. This helps identify vault access policies and permissions.
Type: String
Required: No
** CompletionDate **
The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of `CompletionDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** CreatedBy **
Contains identifying information about the creation of a restore job.
Type: [RestoreJobCreator](API_RestoreJobCreator.md) object
Required: No
** CreatedResourceArn **
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
Type: String
Required: No
** CreationDate **
The date and time a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** DeletionStatus **
This notes the status of the data generated by the restore test. The status may be `Deleting`, `Failed`, or `Successful`.
Type: String
Valid Values: `DELETING | FAILED | SUCCESSFUL`
Required: No
** DeletionStatusMessage **
This describes the restore job deletion status.
Type: String
Required: No
** ExpectedCompletionTimeMinutes **
The amount of time in minutes that a job restoring a recovery point is expected to take.
Type: Long
Required: No
** IamRoleArn **
The IAM role ARN used to create the target recovery point; for example, `arn:aws:iam::123456789012:role/S3Access`.
Type: String
Required: No
** IsParent **
This is a boolean value indicating whether the restore job is a parent (composite) restore job.
Type: Boolean
Required: No
** ParentJobId **
This is the unique identifier of the parent restore job for the selected restore job.
Type: String
Required: No
** PercentDone **
Contains an estimated percentage complete of a job at the time the job status was queried.
Type: String
Required: No
** RecoveryPointArn **
An ARN that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Type: String
Required: No
** RecoveryPointCreationDate **
The date on which a recovery point was created.
Type: Timestamp
Required: No
** ResourceType **
The resource type of the listed restore jobs; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
Type: String
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Required: No
** RestoreJobId **
Uniquely identifies the job that restores a recovery point.
Type: String
Required: No
** SourceResourceArn **
The Amazon Resource Name (ARN) of the original resource that was backed up. This provides context about what resource is being restored.
Type: String
Required: No
** Status **
A status code specifying the state of the job initiated by AWS Backup to restore a recovery point.
Type: String
Valid Values: `PENDING | RUNNING | COMPLETED | ABORTED | FAILED`
Required: No
** StatusMessage **
A detailed message explaining the status of the job to restore a recovery point.
Type: String
Required: No
** ValidationStatus **
The status of validation run on the indicated restore job.
Type: String
Valid Values: `FAILED | SUCCESSFUL | TIMED_OUT | VALIDATING`
Required: No
** ValidationStatusMessage **
This describes the status of validation run on the indicated restore job.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This is a summary of restore jobs created or running within the most recent 30 days.
The returned summary may contain the following: Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
## Contents
** AccountId **
The account ID that owns the jobs within the summary.
Type: String
Pattern: `^[0-9]{12}$`
Required: No
** Count **
The value as a number of jobs in a job summary.
Type: Integer
Required: No
** EndTime **
The value of time in number format of a job end time.
This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** Region **
The AWS Regions within the job summary.
Type: String
Required: No
** ResourceType **
This value is the job count for the specified resource type. The request `GetSupportedResourceTypes` returns strings for supported resource types.
Type: String
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Required: No
** StartTime **
The value of time in number format of a job start time.
This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** State **
This value is job count for jobs with the specified state.
Type: String
Valid Values: `CREATED | PENDING | RUNNING | ABORTED | COMPLETED | FAILED | AGGREGATE_ALL | ANY`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This contains metadata about a restore testing plan.
## Contents
** RecoveryPointSelection **
`RecoveryPointSelection` has five parameters (three required and two optional). The values you specify determine which recovery point is included in the restore test. You must indicate with `Algorithm` if you want the latest recovery point within your `SelectionWindowDays` or if you want a random recovery point, and you must indicate through `IncludeVaults` from which vaults the recovery points can be chosen.
`Algorithm` (*required*) Valid values: "`LATEST_WITHIN_WINDOW`" or "`RANDOM_WITHIN_WINDOW`".
`Recovery point types` (*required*) Valid values: "`SNAPSHOT`" and/or "`CONTINUOUS`". Include `SNAPSHOT` to restore only snapshot recovery points; include `CONTINUOUS` to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for `Algorithm`.
`IncludeVaults` (*required*). You must include one or more backup vaults. Use the wildcard ["\$1"] or specific ARNs.
`SelectionWindowDays` (*optional*) Value must be an integer (in days) from 1 to 365. If not included, the value defaults to `30`.
`ExcludeVaults` (*optional*). You can choose to input one or more specific backup vault ARNs to exclude those vaults' contents from restore eligibility. Or, you can include a list of selectors. If this parameter and its value are not included, it defaults to empty list.
Type: [RestoreTestingRecoveryPointSelection](API_RestoreTestingRecoveryPointSelection.md) object
Required: Yes
** RestoreTestingPlanName **
The RestoreTestingPlanName is a unique string that is the name of the restore testing plan. This cannot be changed after creation, and it must consist of only alphanumeric characters and underscores.
Type: String
Required: Yes
** ScheduleExpression **
A CRON expression in specified timezone when a restore testing plan is executed. When no CRON expression is provided, AWS Backup will use the default expression `cron(0 5 ? * * *)`.
Type: String
Required: Yes
** ScheduleExpressionTimezone **
Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
Type: String
Required: No
** StartWindowHours **
Defaults to 24 hours.
A value in hours after a restore test is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, this parameter has a maximum value of 168 hours (one week).
Type: Integer
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This contains metadata about a restore testing plan.
## Contents
** CreationTime **
The date and time that a restore testing plan was created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: Yes
** RecoveryPointSelection **
The specified criteria to assign a set of resources, such as recovery point types or backup vaults.
Type: [RestoreTestingRecoveryPointSelection](API_RestoreTestingRecoveryPointSelection.md) object
Required: Yes
** RestoreTestingPlanArn **
An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.
Type: String
Required: Yes
** RestoreTestingPlanName **
The restore testing plan name.
Type: String
Required: Yes
** ScheduleExpression **
A CRON expression in specified timezone when a restore testing plan is executed. When no CRON expression is provided, AWS Backup will use the default expression `cron(0 5 ? * * *)`.
Type: String
Required: Yes
** CreatorRequestId **
This identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a `CreatorRequestId` that matches an existing backup plan, that plan is returned. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-\$1.' characters.
Type: String
Required: No
** LastExecutionTime **
The last time a restore test was run with the specified restore testing plan. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of `LastExecutionDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** LastUpdateTime **
The date and time that the restore testing plan was updated. This update is in Unix format and Coordinated Universal Time (UTC). The value of `LastUpdateTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** ScheduleExpressionTimezone **
Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
Type: String
Required: No
** StartWindowHours **
Defaults to 24 hours.
A value in hours after a restore test is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, this parameter has a maximum value of 168 hours (one week).
Type: Integer
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This contains metadata about a restore testing plan.
## Contents
** CreationTime **
The date and time that a restore testing plan was created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: Yes
** RestoreTestingPlanArn **
An Amazon Resource Name (ARN) that uniquely identifiesa restore testing plan.
Type: String
Required: Yes
** RestoreTestingPlanName **
The restore testing plan name.
Type: String
Required: Yes
** ScheduleExpression **
A CRON expression in specified timezone when a restore testing plan is executed. When no CRON expression is provided, AWS Backup will use the default expression `cron(0 5 ? * * *)`.
Type: String
Required: Yes
** LastExecutionTime **
The last time a restore test was run with the specified restore testing plan. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of `LastExecutionDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** LastUpdateTime **
The date and time that the restore testing plan was updated. This update is in Unix format and Coordinated Universal Time (UTC). The value of `LastUpdateTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** ScheduleExpressionTimezone **
Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
Type: String
Required: No
** StartWindowHours **
Defaults to 24 hours.
A value in hours after a restore test is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, this parameter has a maximum value of 168 hours (one week).
Type: Integer
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This contains metadata about a restore testing plan.
## Contents
** RecoveryPointSelection **
Required: `Algorithm`; `RecoveryPointTypes`; `IncludeVaults` (*one or more*).
Optional: *SelectionWindowDays* (*'30' if not specified*); `ExcludeVaults` (defaults to empty list if not listed).
Type: [RestoreTestingRecoveryPointSelection](API_RestoreTestingRecoveryPointSelection.md) object
Required: No
** ScheduleExpression **
A CRON expression in specified timezone when a restore testing plan is executed. When no CRON expression is provided, AWS Backup will use the default expression `cron(0 5 ? * * *)`.
Type: String
Required: No
** ScheduleExpressionTimezone **
Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
Type: String
Required: No
** StartWindowHours **
Defaults to 24 hours.
A value in hours after a restore test is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, this parameter has a maximum value of 168 hours (one week).
Type: Integer
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
`RecoveryPointSelection` has five parameters (three required and two optional). The values you specify determine which recovery point is included in the restore test. You must indicate with `Algorithm` if you want the latest recovery point within your `SelectionWindowDays` or if you want a random recovery point, and you must indicate through `IncludeVaults` from which vaults the recovery points can be chosen.
`Algorithm` (*required*) Valid values: "`LATEST_WITHIN_WINDOW`" or "`RANDOM_WITHIN_WINDOW`".
`Recovery point types` (*required*) Valid values: "`SNAPSHOT`" and/or "`CONTINUOUS`". Include `SNAPSHOT` to restore only snapshot recovery points; include `CONTINUOUS` to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for `Algorithm`.
`IncludeVaults` (*required*). You must include one or more backup vaults. Use the wildcard ["\$1"] or specific ARNs.
`SelectionWindowDays` (*optional*) Value must be an integer (in days) from 1 to 365. If not included, the value defaults to `30`.
`ExcludeVaults` (*optional*). You can choose to input one or more specific backup vault ARNs to exclude those vaults' contents from restore eligibility. Or, you can include a list of selectors. If this parameter and its value are not included, it defaults to empty list.
## Contents
** Algorithm **
Acceptable values include "LATEST\$1WITHIN\$1WINDOW" or "RANDOM\$1WITHIN\$1WINDOW"
Type: String
Valid Values: `LATEST_WITHIN_WINDOW | RANDOM_WITHIN_WINDOW`
Required: No
** ExcludeVaults **
Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed.
Type: Array of strings
Required: No
** IncludeVaults **
Accepted values include wildcard ["\$1"] or by specific ARNs or ARN wilcard replacement ["arn:aws:backup:us-west-2:123456789012:backup-vault:asdf", ...] ["arn:aws:backup:\$1:\$1:backup-vault:asdf-\$1", ...]
Type: Array of strings
Required: No
** RecoveryPointTypes **
These are the types of recovery points.
Include `SNAPSHOT` to restore only snapshot recovery points; include `CONTINUOUS` to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for `Algorithm`.
Type: Array of strings
Valid Values: `CONTINUOUS | SNAPSHOT`
Required: No
** SelectionWindowDays **
Accepted values are integers from 1 to 365.
Type: Integer
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This contains metadata about a specific restore testing selection.
ProtectedResourceType is required, such as Amazon EBS or Amazon EC2.
This consists of `RestoreTestingSelectionName`, `ProtectedResourceType`, and one of the following:
+ `ProtectedResourceArns`
+ `ProtectedResourceConditions`
Each protected resource type can have one single value.
A restore testing selection can include a wildcard value ("\$1") for `ProtectedResourceArns` along with `ProtectedResourceConditions`. Alternatively, you can include up to 30 specific protected resource ARNs in `ProtectedResourceArns`.
`ProtectedResourceConditions` examples include as `StringEquals` and `StringNotEquals`.
## Contents
** IamRoleArn **
The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create the target resource; for example: `arn:aws:iam::123456789012:role/S3Access`.
Type: String
Required: Yes
** ProtectedResourceType **
The type of AWS resource included in a restore testing selection; for example, an Amazon EBS volume or an Amazon RDS database.
Supported resource types accepted include:
+ `Aurora` for Amazon Aurora
+ `DocumentDB` for Amazon DocumentDB (with MongoDB compatibility)
+ `DynamoDB` for Amazon DynamoDB
+ `EBS` for Amazon Elastic Block Store
+ `EC2` for Amazon Elastic Compute Cloud
+ `EFS` for Amazon Elastic File System
+ `FSx` for Amazon FSx
+ `Neptune` for Amazon Neptune
+ `RDS` for Amazon Relational Database Service
+ `S3` for Amazon S3
Type: String
Required: Yes
** RestoreTestingSelectionName **
The unique name of the restore testing selection that belongs to the related restore testing plan.
The name consists of only alphanumeric characters and underscores. Maximum length is 50.
Type: String
Required: Yes
** ProtectedResourceArns **
Each protected resource can be filtered by its specific ARNs, such as `ProtectedResourceArns: ["arn:aws:...", "arn:aws:..."]` or by a wildcard: `ProtectedResourceArns: ["*"]`, but not both.
Type: Array of strings
Required: No
** ProtectedResourceConditions **
If you have included the wildcard in ProtectedResourceArns, you can include resource conditions, such as `ProtectedResourceConditions: { StringEquals: [{ key: "XXXX", value: "YYYY" }]`.
Type: [ProtectedResourceConditions](API_ProtectedResourceConditions.md) object
Required: No
** RestoreMetadataOverrides **
You can override certain restore metadata keys by including the parameter `RestoreMetadataOverrides` in the body of `RestoreTestingSelection`. Key values are not case sensitive.
See the complete list of [restore testing inferred metadata](https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-testing-inferred-metadata.html).
Type: String to string map
Required: No
** ValidationWindowHours **
This is amount of hours (0 to 168) available to run a validation script on the data. The data will be deleted upon the completion of the validation script or the end of the specified retention period, whichever comes first.
Type: Integer
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This contains metadata about a restore testing selection.
## Contents
** CreationTime **
The date and time that a restore testing selection was created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 201812:11:30.087 AM.
Type: Timestamp
Required: Yes
** IamRoleArn **
The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create the target resource; for example:`arn:aws:iam::123456789012:role/S3Access`.
Type: String
Required: Yes
** ProtectedResourceType **
The type of AWS resource included in a resource testing selection; for example, an Amazon EBS volume or an Amazon RDS database.
Type: String
Required: Yes
** RestoreTestingPlanName **
The RestoreTestingPlanName is a unique string that is the name of the restore testing plan.
Type: String
Required: Yes
** RestoreTestingSelectionName **
The unique name of the restore testing selection that belongs to the related restore testing plan.
The name consists of only alphanumeric characters and underscores. Maximum length is 50.
Type: String
Required: Yes
** CreatorRequestId **
This identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a `CreatorRequestId` that matches an existing backup plan, that plan is returned. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-\$1.' characters.
Type: String
Required: No
** ProtectedResourceArns **
You can include specific ARNs, such as `ProtectedResourceArns: ["arn:aws:...", "arn:aws:..."]` or you can include a wildcard: `ProtectedResourceArns: ["*"]`, but not both.
Type: Array of strings
Required: No
** ProtectedResourceConditions **
In a resource testing selection, this parameter filters by specific conditions such as `StringEquals` or `StringNotEquals`.
Type: [ProtectedResourceConditions](API_ProtectedResourceConditions.md) object
Required: No
** RestoreMetadataOverrides **
You can override certain restore metadata keys by including the parameter `RestoreMetadataOverrides` in the body of `RestoreTestingSelection`. Key values are not case sensitive.
See the complete list of [restore testing inferred metadata](https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-testing-inferred-metadata.html).
Type: String to string map
Required: No
** ValidationWindowHours **
This is amount of hours (1 to 168) available to run a validation script on the data. The data will be deleted upon the completion of the validation script or the end of the specified retention period, whichever comes first.
Type: Integer
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This contains metadata about a restore testing selection.
## Contents
** CreationTime **
The date and time that a restore testing selection was created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26,2018 12:11:30.087 AM.
Type: Timestamp
Required: Yes
** IamRoleArn **
The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create the target resource; for example: `arn:aws:iam::123456789012:role/S3Access`.
Type: String
Required: Yes
** ProtectedResourceType **
The type of AWS resource included in a restore testing selection; for example, an Amazon EBS volume or an Amazon RDS database.
Type: String
Required: Yes
** RestoreTestingPlanName **
Unique string that is the name of the restore testing plan.
The name cannot be changed after creation. The name must consist of only alphanumeric characters and underscores. Maximum length is 50.
Type: String
Required: Yes
** RestoreTestingSelectionName **
Unique name of a restore testing selection.
The name consists of only alphanumeric characters and underscores. Maximum length is 50.
Type: String
Required: Yes
** ValidationWindowHours **
This value represents the time, in hours, data is retained after a restore test so that optional validation can be completed.
Accepted value is an integer between 0 and 168 (the hourly equivalent of seven days).
Type: Integer
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This contains metadata about a restore testing selection.
## Contents
** IamRoleArn **
The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create the target resource; for example: `arn:aws:iam::123456789012:role/S3Access`.
Type: String
Required: No
** ProtectedResourceArns **
You can include a list of specific ARNs, such as `ProtectedResourceArns: ["arn:aws:...", "arn:aws:..."]` or you can include a wildcard: `ProtectedResourceArns: ["*"]`, but not both.
Type: Array of strings
Required: No
** ProtectedResourceConditions **
The conditions that you define for resources in your restore testing plan using tags.
Type: [ProtectedResourceConditions](API_ProtectedResourceConditions.md) object
Required: No
** RestoreMetadataOverrides **
You can override certain restore metadata keys by including the parameter `RestoreMetadataOverrides` in the body of `RestoreTestingSelection`. Key values are not case sensitive.
See the complete list of [restore testing inferred metadata](https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-testing-inferred-metadata.html).
Type: String to string map
Required: No
** ValidationWindowHours **
This value represents the time, in hours, data is retained after a restore test so that optional validation can be completed.
Accepted value is an integer between 0 and 168 (the hourly equivalent of seven days).
Type: Integer
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Defines a scanning action that specifies the malware scanner and scan mode to use.
## Contents
** MalwareScanner **
The malware scanner to use for the scan action. Currently only `GUARDDUTY` is supported.
Type: String
Valid Values: `GUARDDUTY`
Required: No
** ScanMode **
The scanning mode to use for the scan action.
Valid values: `FULL_SCAN` \$1 `INCREMENTAL_SCAN`.
Type: String
Valid Values: `FULL_SCAN | INCREMENTAL_SCAN`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains metadata about a scan job, including information about the scanning process, results, and associated resources.
## Contents
** AccountId **
The account ID that owns the scan job.
Type: String
Required: Yes
** BackupVaultArn **
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
Type: String
Required: Yes
** BackupVaultName **
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
Type: String
Required: Yes
** CreatedBy **
Contains identifying information about the creation of a scan job.
Type: [ScanJobCreator](API_ScanJobCreator.md) object
Required: Yes
** CreationDate **
The date and time that a scan job is created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: Yes
** IamRoleArn **
Specifies the IAM role ARN used to create the scan job; for example, `arn:aws:iam::123456789012:role/S3Access`.
Type: String
Required: Yes
** MalwareScanner **
The scanning engine used for the scan job. Currently only `GUARDDUTY` is supported.
Type: String
Valid Values: `GUARDDUTY`
Required: Yes
** RecoveryPointArn **
An ARN that uniquely identifies the recovery point being scanned; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Type: String
Required: Yes
** ResourceArn **
An ARN that uniquely identifies the source resource of the recovery point being scanned.
Type: String
Required: Yes
** ResourceName **
The non-unique name of the resource that belongs to the specified backup.
Type: String
Required: Yes
** ResourceType **
The type of AWS resource being scanned; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
Type: String
Valid Values: `EBS | EC2 | S3`
Required: Yes
** ScanJobId **
The unique identifier that identifies the scan job request to AWS Backup.
Type: String
Required: Yes
** ScanMode **
Specifies the scan type use for the scan job.
Includes:
`FULL_SCAN` will scan the entire data lineage within the backup.
`INCREMENTAL_SCAN` will scan the data difference between the target recovery point and base recovery point ARN.
Type: String
Valid Values: `FULL_SCAN | INCREMENTAL_SCAN`
Required: Yes
** ScannerRoleArn **
Specifies the scanner IAM role ARN used for the scan job.
Type: String
Required: Yes
** CompletionDate **
The date and time that a scan job is completed, in Unix format and Coordinated Universal Time (UTC). The value of `CompletionDate` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** ScanBaseRecoveryPointArn **
An ARN that uniquely identifies the base recovery point for scanning. This field is populated when an incremental scan job has taken place.
Type: String
Required: No
** ScanId **
The scan ID generated by the malware scanner for the corresponding scan job.
Type: String
Required: No
** ScanResult **
Contains the scan results information, including the status of threats found during scanning.
Type: [ScanResultInfo](API_ScanResultInfo.md) object
Required: No
** State **
The current state of the scan job.
Valid values: `CREATED` \$1 `RUNNING` \$1 `COMPLETED` \$1 `COMPLETED_WITH_ISSUES` \$1 `FAILED` \$1 `CANCELED`.
Type: String
Valid Values: `CANCELED | COMPLETED | COMPLETED_WITH_ISSUES | CREATED | FAILED | RUNNING`
Required: No
** StatusMessage **
A detailed message explaining the status of the scan job.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains identifying information about the creation of a scan job, including the backup plan and rule that initiated the scan.
## Contents
** BackupPlanArn **
An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, `arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50`.
Type: String
Required: Yes
** BackupPlanId **
The ID of the backup plan.
Type: String
Required: Yes
** BackupPlanVersion **
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
Type: String
Required: Yes
** BackupRuleId **
Uniquely identifies the backup rule that initiated the scan job.
Type: String
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains summary information about scan jobs, including counts and metadata for a specific time period and criteria.
## Contents
** AccountId **
The account ID that owns the scan jobs included in this summary.
Type: String
Pattern: `^[0-9]{12}$`
Required: No
** Count **
The number of scan jobs that match the specified criteria.
Type: Integer
Required: No
** EndTime **
The value of time in number format of a job end time.
This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** MalwareScanner **
Specifies the malware scanner used during the scan job. Currently only supports `GUARDDUTY`.
Type: String
Valid Values: `GUARDDUTY`
Required: No
** Region **
The AWS Region where the scan jobs were executed.
Type: String
Required: No
** ResourceType **
The type of AWS resource for the scan jobs included in this summary.
Type: String
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Required: No
** ScanResultStatus **
The scan result status for the scan jobs included in this summary.
Valid values: `THREATS_FOUND` \$1 `NO_THREATS_FOUND`.
Type: String
Valid Values: `NO_THREATS_FOUND | THREATS_FOUND`
Required: No
** StartTime **
The value of time in number format of a job start time.
This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Type: Timestamp
Required: No
** State **
The state of the scan jobs included in this summary.
Valid values: `CREATED` \$1 `RUNNING` \$1 `COMPLETED` \$1 `COMPLETED_WITH_ISSUES` \$1 `FAILED` \$1 `CANCELED`.
Type: String
Valid Values: `CREATED | COMPLETED | COMPLETED_WITH_ISSUES | RUNNING | FAILED | CANCELED | AGGREGATE_ALL | ANY`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains the results of a security scan, including scanner information, scan state, and any findings discovered.
## Contents
** Findings **
An array of findings discovered during the scan.
Type: Array of strings
Valid Values: `MALWARE`
Required: No
** LastScanTimestamp **
The timestamp of when the last scan was performed, in Unix format and Coordinated Universal Time (UTC).
Type: Timestamp
Required: No
** MalwareScanner **
The malware scanner used to perform the scan. Currently only `GUARDDUTY` is supported.
Type: String
Valid Values: `GUARDDUTY`
Required: No
** ScanJobState **
The final state of the scan job.
Valid values: `COMPLETED` \$1 `FAILED` \$1 `CANCELED`.
Type: String
Valid Values: `COMPLETED | COMPLETED_WITH_ISSUES | FAILED | CANCELED`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains information about the results of a scan job.
## Contents
** ScanResultStatus **
The status of the scan results.
Valid values: `THREATS_FOUND` \$1 `NO_THREATS_FOUND`.
Type: String
Valid Values: `NO_THREATS_FOUND | THREATS_FOUND`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains configuration settings for malware scanning, including the scanner type, target resource types, and scanner role.
## Contents
** MalwareScanner **
The malware scanner to use for scanning. Currently only `GUARDDUTY` is supported.
Type: String
Valid Values: `GUARDDUTY`
Required: No
** ResourceTypes **
An array of resource types to be scanned for malware.
Type: Array of strings
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Required: No
** ScannerRoleArn **
The Amazon Resource Name (ARN) of the IAM role that the scanner uses to access resources; for example, `arn:aws:iam::123456789012:role/ScannerRole`.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Contains information about a scheduled backup plan execution, including the execution time, rule type, and associated rule identifier.
## Contents
** ExecutionTime **
The timestamp when the backup is scheduled to run, in Unix format and Coordinated Universal Time (UTC). The value is accurate to milliseconds.
Type: Timestamp
Required: No
** RuleExecutionType **
The type of backup rule execution. Valid values are `CONTINUOUS` (point-in-time recovery), `SNAPSHOTS` (snapshot backups), or `CONTINUOUS_AND_SNAPSHOTS` (both types combined).
Type: String
Valid Values: `CONTINUOUS | SNAPSHOTS | CONTINUOUS_AND_SNAPSHOTS`
Required: No
** RuleId **
The unique identifier of the backup rule that will execute at the scheduled time.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This contains metadata about a tiering configuration.
## Contents
** BackupVaultName **
The name of the backup vault where the tiering configuration applies. Use `*` to apply to all backup vaults.
Type: String
Pattern: `^(\*|[a-zA-Z0-9\-\_]{2,50})$`
Required: Yes
** ResourceSelection **
An array of resource selection objects that specify which resources are included in the tiering configuration and their tiering settings.
Type: Array of [ResourceSelection](API_ResourceSelection.md) objects
Required: Yes
** TieringConfigurationName **
The unique name of the tiering configuration. This cannot be changed after creation, and it must consist of only alphanumeric characters and underscores.
Type: String
Pattern: `^[a-zA-Z0-9_]{1,200}$`
Required: Yes
** CreationTime **
The date and time a tiering configuration was created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.
Type: Timestamp
Required: No
** CreatorRequestId **
This is a unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
Type: String
Required: No
** LastUpdatedTime **
The date and time a tiering configuration was updated, in Unix format and Coordinated Universal Time (UTC). The value of `LastUpdatedTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.
Type: Timestamp
Required: No
** TieringConfigurationArn **
An Amazon Resource Name (ARN) that uniquely identifies the tiering configuration.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This contains metadata about a tiering configuration for create operations.
## Contents
** BackupVaultName **
The name of the backup vault where the tiering configuration applies. Use `*` to apply to all backup vaults.
Type: String
Pattern: `^(\*|[a-zA-Z0-9\-\_]{2,50})$`
Required: Yes
** ResourceSelection **
An array of resource selection objects that specify which resources are included in the tiering configuration and their tiering settings.
Type: Array of [ResourceSelection](API_ResourceSelection.md) objects
Required: Yes
** TieringConfigurationName **
The unique name of the tiering configuration. This cannot be changed after creation, and it must consist of only alphanumeric characters and underscores.
Type: String
Pattern: `^[a-zA-Z0-9_]{1,200}$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This contains metadata about a tiering configuration for update operations.
## Contents
** BackupVaultName **
The name of the backup vault where the tiering configuration applies. Use `*` to apply to all backup vaults.
Type: String
Pattern: `^(\*|[a-zA-Z0-9\-\_]{2,50})$`
Required: Yes
** ResourceSelection **
An array of resource selection objects that specify which resources are included in the tiering configuration and their tiering settings.
Type: Array of [ResourceSelection](API_ResourceSelection.md) objects
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This contains metadata about a tiering configuration returned in a list.
## Contents
** BackupVaultName **
The name of the backup vault where the tiering configuration applies. Use `*` to apply to all backup vaults.
Type: String
Pattern: `^(\*|[a-zA-Z0-9\-\_]{2,50})$`
Required: No
** CreationTime **
The date and time a tiering configuration was created, in Unix format and Coordinated Universal Time (UTC). The value of `CreationTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.
Type: Timestamp
Required: No
** LastUpdatedTime **
The date and time a tiering configuration was updated, in Unix format and Coordinated Universal Time (UTC). The value of `LastUpdatedTime` is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.
Type: Timestamp
Required: No
** TieringConfigurationArn **
An Amazon Resource Name (ARN) that uniquely identifies the tiering configuration.
Type: String
Required: No
** TieringConfigurationName **
The unique name of the tiering configuration.
Type: String
Pattern: `^[a-zA-Z0-9_]{1,200}$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
The following data types are supported by 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
Describes a bandwidth rate limit interval for a gateway. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading.
## Contents
** DaysOfWeek **
The days of the week component of the bandwidth rate limit interval, represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 represents Saturday.
Type: Array of integers
Array Members: Minimum number of 1 item. Maximum number of 7 items.
Valid Range: Minimum value of 0. Maximum value of 6.
Required: Yes
** EndHourOfDay **
The hour of the day to end the bandwidth rate limit interval.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 23.
Required: Yes
** EndMinuteOfHour **
The minute of the hour to end the bandwidth rate limit interval.
The bandwidth rate limit interval ends at the end of the minute. To end an interval at the end of an hour, use the value `59`.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 59.
Required: Yes
** StartHourOfDay **
The hour of the day to start the bandwidth rate limit interval.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 23.
Required: Yes
** StartMinuteOfHour **
The minute of the hour to start the bandwidth rate limit interval. The interval begins at the start of that minute. To begin an interval exactly at the start of the hour, use the value `0`.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 59.
Required: Yes
** AverageUploadRateLimitInBitsPerSec **
The average upload rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the upload rate limit is not set.
Type: Long
Valid Range: Minimum value of 51200. Maximum value of 8000000000000.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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 gateway is an AWS Backup Gateway appliance that runs on the customer's network to provide seamless connectivity to backup storage in the AWS Cloud.
## Contents
** GatewayArn **
The Amazon Resource Name (ARN) of the gateway. Use the `ListGateways` operation to return a list of gateways for your account and AWS Region.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 180.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: No
** GatewayDisplayName **
The display name of the gateway.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9-]*`
Required: No
** GatewayType **
The type of the gateway.
Type: String
Valid Values: `BACKUP_VM`
Required: No
** HypervisorId **
The hypervisor ID of the gateway.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
** LastSeenTime **
The last time AWS Backup gateway communicated with the gateway, in Unix format and UTC time.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
The details of gateway.
## Contents
** DeprecationDate **
Date after which this gateway will not receive software updates for new features and bug fixes.
Type: Timestamp
Required: No
** GatewayArn **
The Amazon Resource Name (ARN) of the gateway. Use the `ListGateways` operation to return a list of gateways for your account and AWS Region.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 180.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: No
** GatewayDisplayName **
The display name of the gateway.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9-]*`
Required: No
** GatewayType **
The type of the gateway type.
Type: String
Valid Values: `BACKUP_VM`
Required: No
** HypervisorId **
The hypervisor ID of the gateway.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
** LastSeenTime **
Details showing the last time AWS Backup gateway communicated with the cloud, in Unix format and UTC time.
Type: Timestamp
Required: No
** MaintenanceStartTime **
Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone. Can be weekly or monthly.
Type: [MaintenanceStartTime](API_BGW_MaintenanceStartTime.md) object
Required: No
** NextUpdateAvailabilityTime **
Details showing the next update availability time of the gateway.
Type: Timestamp
Required: No
** SoftwareVersion **
The version number of the software running on the gateway appliance.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9-]*`
Required: No
** VpcEndpoint **
The DNS name for the virtual private cloud (VPC) endpoint the gateway uses to connect to the cloud for backup gateway.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Represents the hypervisor's permissions to which the gateway will connect.
A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.
## Contents
** Host **
The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
Type: String
Length Constraints: Minimum length of 3. Maximum length of 128.
Pattern: `.+`
Required: No
** HypervisorArn **
The Amazon Resource Name (ARN) of the hypervisor.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: No
** KmsKeyArn **
The Amazon Resource Name (ARN) of the AWS Key Management Service used to encrypt the hypervisor.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `(^arn:(aws|aws-cn|aws-us-gov):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)`
Required: No
** Name **
The name of the hypervisor.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9-]*`
Required: No
** State **
The state of the hypervisor.
Type: String
Valid Values: `PENDING | ONLINE | OFFLINE | ERROR`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
These are the details of the specified hypervisor. A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.
## Contents
** Host **
The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
Type: String
Length Constraints: Minimum length of 3. Maximum length of 128.
Pattern: `.+`
Required: No
** HypervisorArn **
The Amazon Resource Name (ARN) of the hypervisor.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: No
** KmsKeyArn **
The Amazon Resource Name (ARN) of the AWS KMS used to encrypt the hypervisor.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `(^arn:(aws|aws-cn|aws-us-gov):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)`
Required: No
** LastSuccessfulMetadataSyncTime **
This is the time when the most recent successful sync of metadata occurred.
Type: Timestamp
Required: No
** LatestMetadataSyncStatus **
This is the most recent status for the indicated metadata sync.
Type: String
Valid Values: `CREATED | RUNNING | FAILED | PARTIALLY_FAILED | SUCCEEDED`
Required: No
** LatestMetadataSyncStatusMessage **
This is the most recent status for the indicated metadata sync.
Type: String
Required: No
** LogGroupArn **
The Amazon Resource Name (ARN) of the group of gateways within the requested log.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `$|^arn:(aws|aws-cn|aws-us-gov):logs:([a-zA-Z0-9-]+):([0-9]+):log-group:[a-zA-Z0-9_\-\/\.]+:\*`
Required: No
** Name **
This is the name of the specified hypervisor.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9-]*`
Required: No
** State **
This is the current state of the specified hypervisor.
The possible states are `PENDING`, `ONLINE`, `OFFLINE`, or `ERROR`.
Type: String
Valid Values: `PENDING | ONLINE | OFFLINE | ERROR`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This is your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone. Can be weekly or monthly.
## Contents
** HourOfDay **
The hour component of the maintenance start time represented as *hh*, where *hh* is the hour (0 to 23). The hour of the day is in the time zone of the gateway.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 23.
Required: Yes
** MinuteOfHour **
The minute component of the maintenance start time represented as *mm*, where *mm* is the minute (0 to 59). The minute of the hour is in the time zone of the gateway.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 59.
Required: Yes
** DayOfMonth **
The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 31.
Required: No
** DayOfWeek **
An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday and 6 represents Saturday. The day of week is in the time zone of the gateway.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 6.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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 key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, and the following characters: \$1 - = . \$1 : /. Spaces are not allowed in tag values.
## Contents
** Key **
The key part of a tag's key-value pair. The key can't start with `aws:`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`
Required: Yes
** Value **
The value part of a tag's key-value pair.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern: `[^\x00]*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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 virtual machine that is on a hypervisor.
## Contents
** HostName **
The host name of the virtual machine.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9-]*`
Required: No
** HypervisorId **
The ID of the virtual machine's hypervisor.
Type: String
Required: No
** LastBackupDate **
The most recent date a virtual machine was backed up, in Unix format and UTC time.
Type: Timestamp
Required: No
** Name **
The name of the virtual machine.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9-]*`
Required: No
** Path **
The path of the virtual machine.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Pattern: `[^\x00]+`
Required: No
** ResourceArn **
The Amazon Resource Name (ARN) of the virtual machine. For example, `arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL`.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Your `VirtualMachine` objects, ordered by their Amazon Resource Names (ARNs).
## Contents
** HostName **
The host name of the virtual machine.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9-]*`
Required: No
** HypervisorId **
The ID of the virtual machine's hypervisor.
Type: String
Required: No
** LastBackupDate **
The most recent date a virtual machine was backed up, in Unix format and UTC time.
Type: Timestamp
Required: No
** Name **
The name of the virtual machine.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9-]*`
Required: No
** Path **
The path of the virtual machine.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Pattern: `[^\x00]+`
Required: No
** ResourceArn **
The Amazon Resource Name (ARN) of the virtual machine. For example, `arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL`.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Required: No
** VmwareTags **
These are the details of the VMware tags associated with the specified virtual machine.
Type: Array of [VmwareTag](API_BGW_VmwareTag.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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 VMware tag is a tag attached to a specific virtual machine. A [tag](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_Tag.html) is a key-value pair you can use to manage, filter, and search for your resources.
The content of VMware tags can be matched to AWS tags.
## Contents
** VmwareCategory **
The is the category of VMware.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 80.
Required: No
** VmwareTagDescription **
This is a user-defined description of a VMware tag.
Type: String
Required: No
** VmwareTagName **
This is the user-defined name of a VMware tag.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 80.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This displays the mapping of VMware tags to the corresponding AWS tags.
## Contents
** AwsTagKey **
The key part of the AWS tag's key-value pair.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`
Required: Yes
** AwsTagValue **
The value part of the AWS tag's key-value pair.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern: `[^\x00]*`
Required: Yes
** VmwareCategory **
The is the category of VMware.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 80.
Required: Yes
** VmwareTagName **
This is the user-defined name of a VMware tag.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 80.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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 search
The following data types are supported by AWS Backup search:
+ [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
This filters by recovery points within the CreatedAfter and CreatedBefore timestamps.
## Contents
** CreatedAfter **
This timestamp includes recovery points only created after the specified time.
Type: Timestamp
Required: No
** CreatedBefore **
This timestamp includes recovery points only created before the specified time.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This contains information results retrieved from a search job that may not have completed.
## Contents
** ItemsMatchedCount **
This number is the sum of all items that match the item filters in a search job in progress.
Type: Long
Required: No
** ItemsScannedCount **
This number is the sum of all items that have been scanned so far during a search job.
Type: Long
Required: No
** RecoveryPointsScannedCount **
This number is the sum of all backups that have been scanned so far during a search job.
Type: Integer
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This contains arrays of objects, which may include CreationTimes time condition objects, FilePaths string objects, LastModificationTimes time condition objects,
## Contents
** CreationTimes **
You can include 1 to 10 values.
If one is included, the results will return only items that match.
If more than one is included, the results will return all items that match any of the included values.
Type: Array of [TimeCondition](API_BKS_TimeCondition.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
** FilePaths **
You can include 1 to 10 values.
If one file path is included, the results will return only items that match the file path.
If more than one file path is included, the results will return all items that match any of the file paths.
Type: Array of [StringCondition](API_BKS_StringCondition.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
** LastModificationTimes **
You can include 1 to 10 values.
If one is included, the results will return only items that match.
If more than one is included, the results will return all items that match any of the included values.
Type: Array of [TimeCondition](API_BKS_TimeCondition.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
** Sizes **
You can include 1 to 10 values.
If one is included, the results will return only items that match.
If more than one is included, the results will return all items that match any of the included values.
Type: Array of [LongCondition](API_BKS_LongCondition.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
These are the items returned in the results of a search of Amazon EBS backup metadata.
## Contents
** BackupResourceArn **
These are one or more items in the results that match values for the Amazon Resource Name (ARN) of recovery points returned in a search of Amazon EBS backup metadata.
Type: String
Required: No
** BackupVaultName **
The name of the backup vault.
Type: String
Required: No
** CreationTime **
These are one or more items in the results that match values for creation times returned in a search of Amazon EBS backup metadata.
Type: Timestamp
Required: No
** FilePath **
These are one or more items in the results that match values for file paths returned in a search of Amazon EBS backup metadata.
Type: String
Required: No
** FileSize **
These are one or more items in the results that match values for file sizes returned in a search of Amazon EBS backup metadata.
Type: Long
Required: No
** FileSystemIdentifier **
These are one or more items in the results that match values for file systems returned in a search of Amazon EBS backup metadata.
Type: String
Required: No
** LastModifiedTime **
These are one or more items in the results that match values for Last Modified Time returned in a search of Amazon EBS backup metadata.
Type: Timestamp
Required: No
** SourceResourceArn **
These are one or more items in the results that match values for the Amazon Resource Name (ARN) of source resources returned in a search of Amazon EBS backup metadata.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This is the summary of an export job.
## Contents
** ExportJobIdentifier **
This is the unique string that identifies a specific export job.
Type: String
Required: Yes
** CompletionTime **
This is a timestamp of the time the export job compeleted.
Type: Timestamp
Required: No
** CreationTime **
This is a timestamp of the time the export job was created.
Type: Timestamp
Required: No
** ExportJobArn **
This is the unique ARN (Amazon Resource Name) that belongs to the new export job.
Type: String
Required: No
** SearchJobArn **
The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.
Type: String
Required: No
** Status **
The status of the export job is one of the following:
`CREATED`; `RUNNING`; `FAILED`; or `COMPLETED`.
Type: String
Valid Values: `RUNNING | FAILED | COMPLETED`
Required: No
** StatusMessage **
A status message is a string that is returned for an export job.
A status message is included for any status other than `COMPLETED` without issues.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This contains the export specification object.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** s3ExportSpecification **
This specifies the destination Amazon S3 bucket for the export job. And, if included, it also specifies the destination prefix.
Type: [S3ExportSpecification](API_BKS_S3ExportSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
Item Filters represent all input item properties specified when the search was created.
Contains either EBSItemFilters or S3ItemFilters
## Contents
** EBSItemFilters **
This array can contain CreationTimes, FilePaths, LastModificationTimes, or Sizes objects.
Type: Array of [EBSItemFilter](API_BKS_EBSItemFilter.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No
** S3ItemFilters **
This array can contain CreationTimes, ETags, ObjectKeys, Sizes, or VersionIds objects.
Type: Array of [S3ItemFilter](API_BKS_S3ItemFilter.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
The long condition contains a `Value` and can optionally contain an `Operator`.
## Contents
** Value **
The value of an item included in one of the search item filters.
Type: Long
Required: Yes
** Operator **
A string that defines what values will be returned.
If this is included, avoid combinations of operators that will return all possible values. For example, including both `EQUALS_TO` and `NOT_EQUALS_TO` with a value of `4` will return all values.
Type: String
Valid Values: `EQUALS_TO | NOT_EQUALS_TO | LESS_THAN_EQUAL_TO | GREATER_THAN_EQUAL_TO`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This is an object representing the item returned in the results of a search for a specific resource type.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** EBSResultItem **
These are items returned in the search results of an Amazon EBS search.
Type: [EBSResultItem](API_BKS_EBSResultItem.md) object
Required: No
** S3ResultItem **
These are items returned in the search results of an Amazon S3 search.
Type: [S3ResultItem](API_BKS_S3ResultItem.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This specification contains a required string of the destination bucket; optionally, you can include the destination prefix.
## Contents
** DestinationBucket **
This specifies the destination Amazon S3 bucket for the export job.
Type: String
Required: Yes
** DestinationPrefix **
This specifies the prefix for the destination Amazon S3 bucket for the export job.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This contains arrays of objects, which may include ObjectKeys, Sizes, CreationTimes, VersionIds, and/or Etags.
## Contents
** CreationTimes **
You can include 1 to 10 values.
If one value is included, the results will return only items that match the value.
If more than one value is included, the results will return all items that match any of the values.
Type: Array of [TimeCondition](API_BKS_TimeCondition.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
** ETags **
You can include 1 to 10 values.
If one value is included, the results will return only items that match the value.
If more than one value is included, the results will return all items that match any of the values.
Type: Array of [StringCondition](API_BKS_StringCondition.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
** ObjectKeys **
You can include 1 to 10 values.
If one value is included, the results will return only items that match the value.
If more than one value is included, the results will return all items that match any of the values.
Type: Array of [StringCondition](API_BKS_StringCondition.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
** Sizes **
You can include 1 to 10 values.
If one value is included, the results will return only items that match the value.
If more than one value is included, the results will return all items that match any of the values.
Type: Array of [LongCondition](API_BKS_LongCondition.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
** VersionIds **
You can include 1 to 10 values.
If one value is included, the results will return only items that match the value.
If more than one value is included, the results will return all items that match any of the values.
Type: Array of [StringCondition](API_BKS_StringCondition.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
These are the items returned in the results of a search of Amazon S3 backup metadata.
## Contents
** BackupResourceArn **
These are items in the returned results that match recovery point Amazon Resource Names (ARN) input during a search of Amazon S3 backup metadata.
Type: String
Required: No
** BackupVaultName **
The name of the backup vault.
Type: String
Required: No
** CreationTime **
These are one or more items in the returned results that match values for item creation time input during a search of Amazon S3 backup metadata.
Type: Timestamp
Required: No
** ETag **
These are one or more items in the returned results that match values for ETags input during a search of Amazon S3 backup metadata.
Type: String
Required: No
** ObjectKey **
This is one or more items returned in the results of a search of Amazon S3 backup metadata that match the values input for object key.
Type: String
Required: No
** ObjectSize **
These are items in the returned results that match values for object size(s) input during a search of Amazon S3 backup metadata.
Type: Long
Required: No
** SourceResourceArn **
These are items in the returned results that match source Amazon Resource Names (ARN) input during a search of Amazon S3 backup metadata.
Type: String
Required: No
** VersionId **
These are one or more items in the returned results that match values for version IDs input during a search of Amazon S3 backup metadata.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This contains the information about recovery points returned in results of a search job.
## Contents
** BackupCreationTime **
This is the creation time of the backup (recovery point).
Type: Timestamp
Required: No
** BackupResourceArn **
The Amazon Resource Name (ARN) that uniquely identifies the backup resources.
Type: String
Required: No
** IndexCreationTime **
This is the creation time of the backup index.
Type: Timestamp
Required: No
** ResourceType **
This is the resource type of the search.
Type: String
Valid Values: `S3 | EBS`
Required: No
** SourceResourceArn **
The Amazon Resource Name (ARN) that uniquely identifies the source resources.
Type: String
Required: No
** Status **
This is the status of the search job backup result.
Type: String
Valid Values: `RUNNING | COMPLETED | STOPPING | STOPPED | FAILED`
Required: No
** StatusMessage **
This is the status message included with the results.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This is information pertaining to a search job.
## Contents
** CompletionTime **
This is the completion time of the search job.
Type: Timestamp
Required: No
** CreationTime **
This is the creation time of the search job.
Type: Timestamp
Required: No
** Name **
This is the name of the search job.
Type: String
Required: No
** SearchJobArn **
The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.
Type: String
Required: No
** SearchJobIdentifier **
The unique string that specifies the search job.
Type: String
Required: No
** SearchScopeSummary **
Returned summary of the specified search job scope, including:
+ TotalBackupsToScanCount, the number of recovery points returned by the search.
+ TotalItemsToScanCount, the number of items returned by the search.
Type: [SearchScopeSummary](API_BKS_SearchScopeSummary.md) object
Required: No
** Status **
This is the status of the search job.
Type: String
Valid Values: `RUNNING | COMPLETED | STOPPING | STOPPED | FAILED`
Required: No
** StatusMessage **
A status message will be returned for either a earch job with a status of `ERRORED` or a status of `COMPLETED` jobs with issues.
For example, a message may say that a search contained recovery points unable to be scanned because of a permissions issue.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
The search scope is all backup properties input into a search.
## Contents
** BackupResourceTypes **
The resource types included in a search.
Eligible resource types include S3 and EBS.
Type: Array of strings
Array Members: Fixed number of 1 item.
Valid Values: `S3 | EBS`
Required: Yes
** BackupResourceArns **
The Amazon Resource Name (ARN) that uniquely identifies the backup resources.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
** BackupResourceCreationTime **
This is the time a backup resource was created.
Type: [BackupCreationTimeFilter](API_BKS_BackupCreationTimeFilter.md) object
Required: No
** BackupResourceTags **
These are one or more tags on the backup (recovery point).
Type: String to string map
Required: No
** SourceResourceArns **
The Amazon Resource Name (ARN) that uniquely identifies the source resources.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
The summary of the specified search job scope, including:
+ TotalBackupsToScanCount, the number of recovery points returned by the search.
+ TotalItemsToScanCount, the number of items returned by the search.
## Contents
** TotalItemsToScanCount **
This is the count of the total number of items that will be scanned in a search.
Type: Long
Required: No
** TotalRecoveryPointsToScanCount **
This is the count of the total number of backups that will be scanned in a search.
Type: Integer
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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
This contains the value of the string and can contain one or more operators.
## Contents
** Value **
The value of the string.
Type: String
Required: Yes
** Operator **
A string that defines what values will be returned.
If this is included, avoid combinations of operators that will return all possible values. For example, including both `EQUALS_TO` and `NOT_EQUALS_TO` with a value of `4` will return all values.
Type: String
Valid Values: `EQUALS_TO | NOT_EQUALS_TO | CONTAINS | DOES_NOT_CONTAIN | BEGINS_WITH | ENDS_WITH | DOES_NOT_BEGIN_WITH | DOES_NOT_END_WITH`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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 time condition denotes a creation time, last modification time, or other time.
## Contents
** Value **
This is the timestamp value of the time condition.
Type: Timestamp
Required: Yes
** Operator **
A string that defines what values will be returned.
If this is included, avoid combinations of operators that will return all possible values. For example, including both `EQUALS_TO` and `NOT_EQUALS_TO` with a value of `4` will return all values.
Type: String
Valid Values: `EQUALS_TO | NOT_EQUALS_TO | LESS_THAN_EQUAL_TO | GREATER_THAN_EQUAL_TO`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [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)
# Common Parameters
The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-specific parameters are listed in the topic for that action. For more information about Signature Version 4, see [Signing AWS API requests](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) in the *IAM User Guide*.
**X-Amz-Algorithm**
The hash algorithm that you used to create the request signature.
Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header.
Type: string
Valid Values: `AWS4-HMAC-SHA256`
Required: Conditional
**X-Amz-Credential**
The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4\$1request"). The value is expressed in the following format: *access\$1key*/*YYYYMMDD*/*region*/*service*/aws4\$1request.
For more information, see [Create a signed AWS API request](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) in the *IAM User Guide*.
Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header.
Type: string
Required: Conditional
**X-Amz-Date**
The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: `20120325T120000Z`.
Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see [Elements of an AWS API request signature](https://docs.aws.amazon.com/IAM/latest/UserGuide/signing-elements.html) in the *IAM User Guide*.
Type: string
Required: Conditional
**X-Amz-Security-Token**
The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see [AWS services that work with IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html) in the *IAM User Guide*.
Condition: If you're using temporary security credentials from AWS STS, you must include the security token.
Type: string
Required: Conditional
**X-Amz-Signature**
Specifies the hex-encoded signature that was calculated from the string to sign and the derived signing key.
Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header.
Type: string
Required: Conditional
**X-Amz-SignedHeaders**
Specifies all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see [Create a signed AWS API request](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) in the *IAM User Guide*.
Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header.
Type: string
Required: Conditional
# Common Error Types
This section lists common error types that this AWS service may return. Not all services return all error types listed here. For errors specific to an API action for this service, see the topic for that API action.
**AccessDeniedException**
You don't have permission to perform this action. Verify that your IAM policy includes the required permissions.
HTTP Status Code: 403
**ExpiredTokenException**
The security token included in the request has expired. Request a new security token and try again.
HTTP Status Code: 403
**IncompleteSignature**
The request signature doesn't conform to AWS standards. Verify that you're using valid AWS credentials and that your request is properly formatted. If you're using an SDK, ensure it's up to date.
HTTP Status Code: 403
**InternalFailure**
The request can't be processed right now because of an internal server issue. Try again later. If the problem persists, contact AWS Support.
HTTP Status Code: 500
**MalformedHttpRequestException**
The request body can't be processed. This typically happens when the request body can't be decompressed using the specified content encoding algorithm. Verify that the content encoding header matches the compression format used.
HTTP Status Code: 400
**NotAuthorized**
You don't have permissions to perform this action. Verify that your IAM policy includes the required permissions.
HTTP Status Code: 401
**OptInRequired**
Your AWS account needs a subscription for this service. Verify that you've enabled the service in your account.
HTTP Status Code: 403
**RequestAbortedException**
The request was aborted before a response could be returned. This typically happens when the client closes the connection.
HTTP Status Code: 400
**RequestEntityTooLargeException**
The request entity is too large. Reduce the size of the request body and try again.
HTTP Status Code: 413
**RequestTimeoutException**
The request timed out. The server didn't receive the complete request within the expected time frame. Try again.
HTTP Status Code: 408
**ServiceUnavailable**
The service is temporarily unavailable. Try again later.
HTTP Status Code: 503
**ThrottlingException**
Your request rate is too high. The AWS SDKs automatically retry requests that receive this exception. Reduce the frequency of requests.
HTTP Status Code: 400
**UnknownOperationException**
The action or operation isn't recognized. Verify that the action name is spelled correctly and that it's supported by the API version you're using.
HTTP Status Code: 404
**UnrecognizedClientException**
The X.509 certificate or AWS access key ID you provided doesn't exist in our records. Verify that you're using valid credentials and that they haven't expired.
HTTP Status Code: 403
**ValidationError**
The input doesn't meet the required format or constraints. Check that all required parameters are included and that values are valid.
HTTP Status Code: 400