# Data Types
<a name="API_Types"></a>

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
<a name="API_Types_AWS_Backup"></a>

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
<a name="API_AdvancedBackupSetting"></a>

The backup options for each resource type.

## Contents
<a name="API_AdvancedBackupSetting_Contents"></a>

 ** BackupOptions **   <a name="Backup-Type-AdvancedBackupSetting-BackupOptions"></a>
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 **   <a name="Backup-Type-AdvancedBackupSetting-ResourceType"></a>
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
<a name="API_AdvancedBackupSetting_SeeAlso"></a>

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
<a name="API_AggregatedScanResult"></a>

Contains aggregated scan results across multiple scan operations, providing a summary of scan status and findings.

## Contents
<a name="API_AggregatedScanResult_Contents"></a>

 ** FailedScan **   <a name="Backup-Type-AggregatedScanResult-FailedScan"></a>
A Boolean value indicating whether any of the aggregated scans failed.  
Type: Boolean  
Required: No

 ** Findings **   <a name="Backup-Type-AggregatedScanResult-Findings"></a>
An array of findings discovered across all aggregated scans.  
Type: Array of strings  
Valid Values: `MALWARE`   
Required: No

 ** LastComputed **   <a name="Backup-Type-AggregatedScanResult-LastComputed"></a>
The timestamp when the aggregated scan result was last computed, in Unix format and Coordinated Universal Time (UTC).  
Type: Timestamp  
Required: No

## See Also
<a name="API_AggregatedScanResult_SeeAlso"></a>

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
<a name="API_BackupJob"></a>

Contains detailed information about a backup job.

## Contents
<a name="API_BackupJob_Contents"></a>

 ** AccountId **   <a name="Backup-Type-BackupJob-AccountId"></a>
The account ID that owns the backup job.  
Type: String  
Pattern: `^[0-9]{12}$`   
Required: No

 ** BackupJobId **   <a name="Backup-Type-BackupJob-BackupJobId"></a>
Uniquely identifies a request to AWS Backup to back up a resource.  
Type: String  
Required: No

 ** BackupOptions **   <a name="Backup-Type-BackupJob-BackupOptions"></a>
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 **   <a name="Backup-Type-BackupJob-BackupSizeInBytes"></a>
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 **   <a name="Backup-Type-BackupJob-BackupType"></a>
Represents the type of backup for a backup job.  
Type: String  
Required: No

 ** BackupVaultArn **   <a name="Backup-Type-BackupJob-BackupVaultArn"></a>
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 **   <a name="Backup-Type-BackupJob-BackupVaultName"></a>
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 **   <a name="Backup-Type-BackupJob-BytesTransferred"></a>
The size in bytes transferred to a backup vault at the time that the job status was queried.  
Type: Long  
Required: No

 ** CompletionDate **   <a name="Backup-Type-BackupJob-CompletionDate"></a>
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 **   <a name="Backup-Type-BackupJob-CreatedBy"></a>
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 **   <a name="Backup-Type-BackupJob-CreationDate"></a>
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 **   <a name="Backup-Type-BackupJob-EncryptionKeyArn"></a>
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 **   <a name="Backup-Type-BackupJob-ExpectedCompletionDate"></a>
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 **   <a name="Backup-Type-BackupJob-IamRoleArn"></a>
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 **   <a name="Backup-Type-BackupJob-InitiationDate"></a>
The date on which the backup job was initiated.  
Type: Timestamp  
Required: No

 ** IsEncrypted **   <a name="Backup-Type-BackupJob-IsEncrypted"></a>
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 **   <a name="Backup-Type-BackupJob-IsParent"></a>
This is a boolean value indicating this is a parent (composite) backup job.  
Type: Boolean  
Required: No

 ** MessageCategory **   <a name="Backup-Type-BackupJob-MessageCategory"></a>
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 **   <a name="Backup-Type-BackupJob-ParentJobId"></a>
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 **   <a name="Backup-Type-BackupJob-PercentDone"></a>
Contains an estimated percentage complete of a job at the time the job status was queried.  
Type: String  
Required: No

 ** RecoveryPointArn **   <a name="Backup-Type-BackupJob-RecoveryPointArn"></a>
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 **   <a name="Backup-Type-BackupJob-RecoveryPointLifecycle"></a>
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 **   <a name="Backup-Type-BackupJob-ResourceArn"></a>
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.  
Type: String  
Required: No

 ** ResourceName **   <a name="Backup-Type-BackupJob-ResourceName"></a>
The non-unique name of the resource that belongs to the specified backup.  
Type: String  
Required: No

 ** ResourceType **   <a name="Backup-Type-BackupJob-ResourceType"></a>
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 **   <a name="Backup-Type-BackupJob-StartBy"></a>
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 **   <a name="Backup-Type-BackupJob-State"></a>
The current state of a backup job.  
Type: String  
Valid Values: `CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL`   
Required: No

 ** StatusMessage **   <a name="Backup-Type-BackupJob-StatusMessage"></a>
A detailed message explaining the status of the job to back up a resource.  
Type: String  
Required: No

 ** VaultLockState **   <a name="Backup-Type-BackupJob-VaultLockState"></a>
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 **   <a name="Backup-Type-BackupJob-VaultType"></a>
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
<a name="API_BackupJob_SeeAlso"></a>

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
<a name="API_BackupJobSummary"></a>

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
<a name="API_BackupJobSummary_Contents"></a>

 ** AccountId **   <a name="Backup-Type-BackupJobSummary-AccountId"></a>
The account ID that owns the jobs within the summary.  
Type: String  
Pattern: `^[0-9]{12}$`   
Required: No

 ** Count **   <a name="Backup-Type-BackupJobSummary-Count"></a>
The value as a number of jobs in a job summary.  
Type: Integer  
Required: No

 ** EndTime **   <a name="Backup-Type-BackupJobSummary-EndTime"></a>
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 **   <a name="Backup-Type-BackupJobSummary-MessageCategory"></a>
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 **   <a name="Backup-Type-BackupJobSummary-Region"></a>
The AWS Regions within the job summary.  
Type: String  
Required: No

 ** ResourceType **   <a name="Backup-Type-BackupJobSummary-ResourceType"></a>
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 **   <a name="Backup-Type-BackupJobSummary-StartTime"></a>
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 **   <a name="Backup-Type-BackupJobSummary-State"></a>
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
<a name="API_BackupJobSummary_SeeAlso"></a>

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
<a name="API_BackupPlan"></a>

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
<a name="API_BackupPlan_Contents"></a>

 ** BackupPlanName **   <a name="Backup-Type-BackupPlan-BackupPlanName"></a>
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 **   <a name="Backup-Type-BackupPlan-Rules"></a>
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 **   <a name="Backup-Type-BackupPlan-AdvancedBackupSettings"></a>
Contains a list of `BackupOptions` for each resource type.  
Type: Array of [AdvancedBackupSetting](API_AdvancedBackupSetting.md) objects  
Required: No

 ** ScanSettings **   <a name="Backup-Type-BackupPlan-ScanSettings"></a>
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
<a name="API_BackupPlan_SeeAlso"></a>

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
<a name="API_BackupPlanInput"></a>

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
<a name="API_BackupPlanInput_Contents"></a>

 ** BackupPlanName **   <a name="Backup-Type-BackupPlanInput-BackupPlanName"></a>
The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-\$1.' characters.  
Type: String  
Required: Yes

 ** Rules **   <a name="Backup-Type-BackupPlanInput-Rules"></a>
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 **   <a name="Backup-Type-BackupPlanInput-AdvancedBackupSettings"></a>
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 **   <a name="Backup-Type-BackupPlanInput-ScanSettings"></a>
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
<a name="API_BackupPlanInput_SeeAlso"></a>

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
<a name="API_BackupPlansListMember"></a>

Contains metadata about a backup plan.

## Contents
<a name="API_BackupPlansListMember_Contents"></a>

 ** AdvancedBackupSettings **   <a name="Backup-Type-BackupPlansListMember-AdvancedBackupSettings"></a>
Contains a list of `BackupOptions` for a resource type.  
Type: Array of [AdvancedBackupSetting](API_AdvancedBackupSetting.md) objects  
Required: No

 ** BackupPlanArn **   <a name="Backup-Type-BackupPlansListMember-BackupPlanArn"></a>
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 **   <a name="Backup-Type-BackupPlansListMember-BackupPlanId"></a>
Uniquely identifies a backup plan.  
Type: String  
Required: No

 ** BackupPlanName **   <a name="Backup-Type-BackupPlansListMember-BackupPlanName"></a>
The display name of a saved backup plan.  
Type: String  
Required: No

 ** CreationDate **   <a name="Backup-Type-BackupPlansListMember-CreationDate"></a>
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 name="Backup-Type-BackupPlansListMember-CreatorRequestId"></a>
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 **   <a name="Backup-Type-BackupPlansListMember-DeletionDate"></a>
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 **   <a name="Backup-Type-BackupPlansListMember-LastExecutionDate"></a>
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 **   <a name="Backup-Type-BackupPlansListMember-VersionId"></a>
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
<a name="API_BackupPlansListMember_SeeAlso"></a>

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
<a name="API_BackupPlanTemplatesListMember"></a>

An object specifying metadata associated with a backup plan template.

## Contents
<a name="API_BackupPlanTemplatesListMember_Contents"></a>

 ** BackupPlanTemplateId **   <a name="Backup-Type-BackupPlanTemplatesListMember-BackupPlanTemplateId"></a>
Uniquely identifies a stored backup plan template.  
Type: String  
Required: No

 ** BackupPlanTemplateName **   <a name="Backup-Type-BackupPlanTemplatesListMember-BackupPlanTemplateName"></a>
The optional display name of a backup plan template.  
Type: String  
Required: No

## See Also
<a name="API_BackupPlanTemplatesListMember_SeeAlso"></a>

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
<a name="API_BackupRule"></a>

Specifies a scheduled task used to back up a selection of resources.

## Contents
<a name="API_BackupRule_Contents"></a>

 ** RuleName **   <a name="Backup-Type-BackupRule-RuleName"></a>
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 **   <a name="Backup-Type-BackupRule-TargetBackupVaultName"></a>
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 name="Backup-Type-BackupRule-CompletionWindowMinutes"></a>
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 **   <a name="Backup-Type-BackupRule-CopyActions"></a>
An array of `CopyAction` objects, which contains the details of the copy operation.  
Type: Array of [CopyAction](API_CopyAction.md) objects  
Required: No

 ** EnableContinuousBackup **   <a name="Backup-Type-BackupRule-EnableContinuousBackup"></a>
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 **   <a name="Backup-Type-BackupRule-IndexActions"></a>
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 **   <a name="Backup-Type-BackupRule-Lifecycle"></a>
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 **   <a name="Backup-Type-BackupRule-RecoveryPointTags"></a>
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 **   <a name="Backup-Type-BackupRule-RuleId"></a>
Uniquely identifies a rule that is used to schedule the backup of a selection of resources.  
Type: String  
Required: No

 ** ScanActions **   <a name="Backup-Type-BackupRule-ScanActions"></a>
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 name="Backup-Type-BackupRule-ScheduleExpression"></a>
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 **   <a name="Backup-Type-BackupRule-ScheduleExpressionTimezone"></a>
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 name="Backup-Type-BackupRule-StartWindowMinutes"></a>
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 **   <a name="Backup-Type-BackupRule-TargetLogicallyAirGappedBackupVaultArn"></a>
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
<a name="API_BackupRule_SeeAlso"></a>

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
<a name="API_BackupRuleInput"></a>

Specifies a scheduled task used to back up a selection of resources.

## Contents
<a name="API_BackupRuleInput_Contents"></a>

 ** RuleName **   <a name="Backup-Type-BackupRuleInput-RuleName"></a>
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 **   <a name="Backup-Type-BackupRuleInput-TargetBackupVaultName"></a>
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 name="Backup-Type-BackupRuleInput-CompletionWindowMinutes"></a>
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 **   <a name="Backup-Type-BackupRuleInput-CopyActions"></a>
An array of `CopyAction` objects, which contains the details of the copy operation.  
Type: Array of [CopyAction](API_CopyAction.md) objects  
Required: No

 ** EnableContinuousBackup **   <a name="Backup-Type-BackupRuleInput-EnableContinuousBackup"></a>
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 **   <a name="Backup-Type-BackupRuleInput-IndexActions"></a>
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 **   <a name="Backup-Type-BackupRuleInput-Lifecycle"></a>
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 **   <a name="Backup-Type-BackupRuleInput-RecoveryPointTags"></a>
The tags to assign to the resources.  
Type: String to string map  
Required: No

 ** ScanActions **   <a name="Backup-Type-BackupRuleInput-ScanActions"></a>
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 name="Backup-Type-BackupRuleInput-ScheduleExpression"></a>
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 **   <a name="Backup-Type-BackupRuleInput-ScheduleExpressionTimezone"></a>
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 name="Backup-Type-BackupRuleInput-StartWindowMinutes"></a>
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 **   <a name="Backup-Type-BackupRuleInput-TargetLogicallyAirGappedBackupVaultArn"></a>
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
<a name="API_BackupRuleInput_SeeAlso"></a>

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
<a name="API_BackupSelection"></a>

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
<a name="API_BackupSelection_Contents"></a>

 ** IamRoleArn **   <a name="Backup-Type-BackupSelection-IamRoleArn"></a>
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 **   <a name="Backup-Type-BackupSelection-SelectionName"></a>
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 **   <a name="Backup-Type-BackupSelection-Conditions"></a>
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 **   <a name="Backup-Type-BackupSelection-ListOfTags"></a>
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 **   <a name="Backup-Type-BackupSelection-NotResources"></a>
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 **   <a name="Backup-Type-BackupSelection-Resources"></a>
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
<a name="API_BackupSelection_SeeAlso"></a>

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
<a name="API_BackupSelectionsListMember"></a>

Contains metadata about a `BackupSelection` object.

## Contents
<a name="API_BackupSelectionsListMember_Contents"></a>

 ** BackupPlanId **   <a name="Backup-Type-BackupSelectionsListMember-BackupPlanId"></a>
Uniquely identifies a backup plan.  
Type: String  
Required: No

 ** CreationDate **   <a name="Backup-Type-BackupSelectionsListMember-CreationDate"></a>
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 name="Backup-Type-BackupSelectionsListMember-CreatorRequestId"></a>
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 **   <a name="Backup-Type-BackupSelectionsListMember-IamRoleArn"></a>
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 **   <a name="Backup-Type-BackupSelectionsListMember-SelectionId"></a>
Uniquely identifies a request to assign a set of resources to a backup plan.  
Type: String  
Required: No

 ** SelectionName **   <a name="Backup-Type-BackupSelectionsListMember-SelectionName"></a>
The display name of a resource selection document.  
Type: String  
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`   
Required: No

## See Also
<a name="API_BackupSelectionsListMember_SeeAlso"></a>

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
<a name="API_BackupVaultListMember"></a>

Contains metadata about a backup vault.

## Contents
<a name="API_BackupVaultListMember_Contents"></a>

 ** BackupVaultArn **   <a name="Backup-Type-BackupVaultListMember-BackupVaultArn"></a>
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 **   <a name="Backup-Type-BackupVaultListMember-BackupVaultName"></a>
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 **   <a name="Backup-Type-BackupVaultListMember-CreationDate"></a>
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 name="Backup-Type-BackupVaultListMember-CreatorRequestId"></a>
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 name="Backup-Type-BackupVaultListMember-EncryptionKeyArn"></a>
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 **   <a name="Backup-Type-BackupVaultListMember-EncryptionKeyType"></a>
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 **   <a name="Backup-Type-BackupVaultListMember-LockDate"></a>
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 name="Backup-Type-BackupVaultListMember-Locked"></a>
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 **   <a name="Backup-Type-BackupVaultListMember-MaxRetentionDays"></a>
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 **   <a name="Backup-Type-BackupVaultListMember-MinRetentionDays"></a>
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 **   <a name="Backup-Type-BackupVaultListMember-NumberOfRecoveryPoints"></a>
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 **   <a name="Backup-Type-BackupVaultListMember-VaultState"></a>
The current state of the vault.  
Type: String  
Valid Values: `CREATING | AVAILABLE | FAILED`   
Required: No

 ** VaultType **   <a name="Backup-Type-BackupVaultListMember-VaultType"></a>
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
<a name="API_BackupVaultListMember_SeeAlso"></a>

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
<a name="API_CalculatedLifecycle"></a>

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
<a name="API_CalculatedLifecycle_Contents"></a>

 ** DeleteAt **   <a name="Backup-Type-CalculatedLifecycle-DeleteAt"></a>
A timestamp that specifies when to delete a recovery point.  
Type: Timestamp  
Required: No

 ** MoveToColdStorageAt **   <a name="Backup-Type-CalculatedLifecycle-MoveToColdStorageAt"></a>
A timestamp that specifies when to transition a recovery point to cold storage.  
Type: Timestamp  
Required: No

## See Also
<a name="API_CalculatedLifecycle_SeeAlso"></a>

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
<a name="API_Condition"></a>

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
<a name="API_Condition_Contents"></a>

 ** ConditionKey **   <a name="Backup-Type-Condition-ConditionKey"></a>
The key in a key-value pair. For example, in the tag `Department: Accounting`, `Department` is the key.  
Type: String  
Required: Yes

 ** ConditionType **   <a name="Backup-Type-Condition-ConditionType"></a>
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 **   <a name="Backup-Type-Condition-ConditionValue"></a>
The value in a key-value pair. For example, in the tag `Department: Accounting`, `Accounting` is the value.  
Type: String  
Required: Yes

## See Also
<a name="API_Condition_SeeAlso"></a>

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
<a name="API_ConditionParameter"></a>

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
<a name="API_ConditionParameter_Contents"></a>

 ** ConditionKey **   <a name="Backup-Type-ConditionParameter-ConditionKey"></a>
The key in a key-value pair. For example, in the tag `Department: Accounting`, `Department` is the key.  
Type: String  
Required: No

 ** ConditionValue **   <a name="Backup-Type-ConditionParameter-ConditionValue"></a>
The value in a key-value pair. For example, in the tag `Department: Accounting`, `Accounting` is the value.  
Type: String  
Required: No

## See Also
<a name="API_ConditionParameter_SeeAlso"></a>

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
<a name="API_Conditions"></a>

Contains information about which resources to include or exclude from a backup plan using their tags. Conditions are case sensitive.

## Contents
<a name="API_Conditions_Contents"></a>

 ** StringEquals **   <a name="Backup-Type-Conditions-StringEquals"></a>
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 **   <a name="Backup-Type-Conditions-StringLike"></a>
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 **   <a name="Backup-Type-Conditions-StringNotEquals"></a>
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 **   <a name="Backup-Type-Conditions-StringNotLike"></a>
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
<a name="API_Conditions_SeeAlso"></a>

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
<a name="API_ControlInputParameter"></a>

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
<a name="API_ControlInputParameter_Contents"></a>

 ** ParameterName **   <a name="Backup-Type-ControlInputParameter-ParameterName"></a>
The name of a parameter, for example, `BackupPlanFrequency`.  
Type: String  
Required: No

 ** ParameterValue **   <a name="Backup-Type-ControlInputParameter-ParameterValue"></a>
The value of parameter, for example, `hourly`.  
Type: String  
Required: No

## See Also
<a name="API_ControlInputParameter_SeeAlso"></a>

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 name="API_ControlScope"></a>

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
<a name="API_ControlScope_Contents"></a>

 ** ComplianceResourceIds **   <a name="Backup-Type-ControlScope-ComplianceResourceIds"></a>
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 **   <a name="Backup-Type-ControlScope-ComplianceResourceTypes"></a>
Describes whether the control scope includes one or more types of resources, such as `EFS` or `RDS`.  
Type: Array of strings  
Required: No

 ** Tags **   <a name="Backup-Type-ControlScope-Tags"></a>
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
<a name="API_ControlScope_SeeAlso"></a>

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
<a name="API_CopyAction"></a>

The details of the copy operation.

## Contents
<a name="API_CopyAction_Contents"></a>

 ** DestinationBackupVaultArn **   <a name="Backup-Type-CopyAction-DestinationBackupVaultArn"></a>
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 **   <a name="Backup-Type-CopyAction-Lifecycle"></a>
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
<a name="API_CopyAction_SeeAlso"></a>

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
<a name="API_CopyJob"></a>

Contains detailed information about a copy job.

## Contents
<a name="API_CopyJob_Contents"></a>

 ** AccountId **   <a name="Backup-Type-CopyJob-AccountId"></a>
The account ID that owns the copy job.  
Type: String  
Pattern: `^[0-9]{12}$`   
Required: No

 ** BackupSizeInBytes **   <a name="Backup-Type-CopyJob-BackupSizeInBytes"></a>
The size, in bytes, of a copy job.  
Type: Long  
Required: No

 ** ChildJobsInState **   <a name="Backup-Type-CopyJob-ChildJobsInState"></a>
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 **   <a name="Backup-Type-CopyJob-CompletionDate"></a>
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 **   <a name="Backup-Type-CopyJob-CompositeMemberIdentifier"></a>
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 **   <a name="Backup-Type-CopyJob-CopyJobId"></a>
Uniquely identifies a copy job.  
Type: String  
Required: No

 ** CreatedBy **   <a name="Backup-Type-CopyJob-CreatedBy"></a>
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 **   <a name="Backup-Type-CopyJob-CreatedByBackupJobId"></a>
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 **   <a name="Backup-Type-CopyJob-CreationDate"></a>
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 **   <a name="Backup-Type-CopyJob-DestinationBackupVaultArn"></a>
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 **   <a name="Backup-Type-CopyJob-DestinationEncryptionKeyArn"></a>
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 **   <a name="Backup-Type-CopyJob-DestinationRecoveryPointArn"></a>
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 **   <a name="Backup-Type-CopyJob-DestinationRecoveryPointLifecycle"></a>
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 **   <a name="Backup-Type-CopyJob-DestinationVaultLockState"></a>
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 **   <a name="Backup-Type-CopyJob-DestinationVaultType"></a>
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 **   <a name="Backup-Type-CopyJob-IamRoleArn"></a>
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 **   <a name="Backup-Type-CopyJob-IsParent"></a>
This is a boolean value indicating this is a parent (composite) copy job.  
Type: Boolean  
Required: No

 ** MessageCategory **   <a name="Backup-Type-CopyJob-MessageCategory"></a>
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 **   <a name="Backup-Type-CopyJob-NumberOfChildJobs"></a>
The number of child (nested) copy jobs.  
Type: Long  
Required: No

 ** ParentJobId **   <a name="Backup-Type-CopyJob-ParentJobId"></a>
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 **   <a name="Backup-Type-CopyJob-ResourceArn"></a>
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 **   <a name="Backup-Type-CopyJob-ResourceName"></a>
The non-unique name of the resource that belongs to the specified backup.  
Type: String  
Required: No

 ** ResourceType **   <a name="Backup-Type-CopyJob-ResourceType"></a>
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 **   <a name="Backup-Type-CopyJob-SourceBackupVaultArn"></a>
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 **   <a name="Backup-Type-CopyJob-SourceRecoveryPointArn"></a>
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 **   <a name="Backup-Type-CopyJob-State"></a>
The current state of a copy job.  
Type: String  
Valid Values: `CREATED | RUNNING | COMPLETED | FAILED | PARTIAL`   
Required: No

 ** StatusMessage **   <a name="Backup-Type-CopyJob-StatusMessage"></a>
A detailed message explaining the status of the job to copy a resource.  
Type: String  
Required: No

## See Also
<a name="API_CopyJob_SeeAlso"></a>

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
<a name="API_CopyJobSummary"></a>

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
<a name="API_CopyJobSummary_Contents"></a>

 ** AccountId **   <a name="Backup-Type-CopyJobSummary-AccountId"></a>
The account ID that owns the jobs within the summary.  
Type: String  
Pattern: `^[0-9]{12}$`   
Required: No

 ** Count **   <a name="Backup-Type-CopyJobSummary-Count"></a>
The value as a number of jobs in a job summary.  
Type: Integer  
Required: No

 ** EndTime **   <a name="Backup-Type-CopyJobSummary-EndTime"></a>
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 **   <a name="Backup-Type-CopyJobSummary-MessageCategory"></a>
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 **   <a name="Backup-Type-CopyJobSummary-Region"></a>
The AWS Regions within the job summary.  
Type: String  
Required: No

 ** ResourceType **   <a name="Backup-Type-CopyJobSummary-ResourceType"></a>
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 **   <a name="Backup-Type-CopyJobSummary-StartTime"></a>
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 **   <a name="Backup-Type-CopyJobSummary-State"></a>
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
<a name="API_CopyJobSummary_SeeAlso"></a>

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
<a name="API_DateRange"></a>

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
<a name="API_DateRange_Contents"></a>

 ** FromDate **   <a name="Backup-Type-DateRange-FromDate"></a>
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 **   <a name="Backup-Type-DateRange-ToDate"></a>
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
<a name="API_DateRange_SeeAlso"></a>

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
<a name="API_Framework"></a>

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
<a name="API_Framework_Contents"></a>

 ** CreationTime **   <a name="Backup-Type-Framework-CreationTime"></a>
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 **   <a name="Backup-Type-Framework-DeploymentStatus"></a>
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 **   <a name="Backup-Type-Framework-FrameworkArn"></a>
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 **   <a name="Backup-Type-Framework-FrameworkDescription"></a>
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 **   <a name="Backup-Type-Framework-FrameworkName"></a>
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 **   <a name="Backup-Type-Framework-NumberOfControls"></a>
The number of controls contained by the framework.  
Type: Integer  
Required: No

## See Also
<a name="API_Framework_SeeAlso"></a>

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
<a name="API_FrameworkControl"></a>

Contains detailed information about all of the controls of a framework. Each framework must contain at least one control.

## Contents
<a name="API_FrameworkControl_Contents"></a>

 ** ControlName **   <a name="Backup-Type-FrameworkControl-ControlName"></a>
The name of a control. This name is between 1 and 256 characters.  
Type: String  
Required: Yes

 ** ControlInputParameters **   <a name="Backup-Type-FrameworkControl-ControlInputParameters"></a>
The name/value pairs.  
Type: Array of [ControlInputParameter](API_ControlInputParameter.md) objects  
Required: No

 ** ControlScope **   <a name="Backup-Type-FrameworkControl-ControlScope"></a>
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
<a name="API_FrameworkControl_SeeAlso"></a>

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
<a name="API_IndexAction"></a>

This is an optional array within a BackupRule.

IndexAction consists of one ResourceTypes.

## Contents
<a name="API_IndexAction_Contents"></a>

 ** ResourceTypes **   <a name="Backup-Type-IndexAction-ResourceTypes"></a>
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
<a name="API_IndexAction_SeeAlso"></a>

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
<a name="API_IndexedRecoveryPoint"></a>

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
<a name="API_IndexedRecoveryPoint_Contents"></a>

 ** BackupCreationDate **   <a name="Backup-Type-IndexedRecoveryPoint-BackupCreationDate"></a>
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 **   <a name="Backup-Type-IndexedRecoveryPoint-BackupVaultArn"></a>
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 **   <a name="Backup-Type-IndexedRecoveryPoint-IamRoleArn"></a>
This specifies the IAM role ARN used for this operation.  
For example, arn:aws:iam::123456789012:role/S3Access  
Type: String  
Required: No

 ** IndexCreationDate **   <a name="Backup-Type-IndexedRecoveryPoint-IndexCreationDate"></a>
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 **   <a name="Backup-Type-IndexedRecoveryPoint-IndexStatus"></a>
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 name="Backup-Type-IndexedRecoveryPoint-IndexStatusMessage"></a>
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 **   <a name="Backup-Type-IndexedRecoveryPoint-RecoveryPointArn"></a>
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 **   <a name="Backup-Type-IndexedRecoveryPoint-ResourceType"></a>
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 name="Backup-Type-IndexedRecoveryPoint-SourceResourceArn"></a>
A string of the Amazon Resource Name (ARN) that uniquely identifies the source resource.  
Type: String  
Required: No

## See Also
<a name="API_IndexedRecoveryPoint_SeeAlso"></a>

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
<a name="API_KeyValue"></a>

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
<a name="API_KeyValue_Contents"></a>

 ** Key **   <a name="Backup-Type-KeyValue-Key"></a>
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 **   <a name="Backup-Type-KeyValue-Value"></a>
The value of the key.  
Length Constraints: Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Type: String  
Required: Yes

## See Also
<a name="API_KeyValue_SeeAlso"></a>

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
<a name="API_LatestMpaApprovalTeamUpdate"></a>

Contains information about the latest update to an MPA approval team association.

## Contents
<a name="API_LatestMpaApprovalTeamUpdate_Contents"></a>

 ** ExpiryDate **   <a name="Backup-Type-LatestMpaApprovalTeamUpdate-ExpiryDate"></a>
The date and time when the MPA approval team update will expire.  
Type: Timestamp  
Required: No

 ** InitiationDate **   <a name="Backup-Type-LatestMpaApprovalTeamUpdate-InitiationDate"></a>
The date and time when the MPA approval team update was initiated.  
Type: Timestamp  
Required: No

 ** MpaSessionArn **   <a name="Backup-Type-LatestMpaApprovalTeamUpdate-MpaSessionArn"></a>
The ARN of the MPA session associated with this update.  
Type: String  
Required: No

 ** Status **   <a name="Backup-Type-LatestMpaApprovalTeamUpdate-Status"></a>
The current status of the MPA approval team update.  
Type: String  
Valid Values: `PENDING | APPROVED | FAILED`   
Required: No

 ** StatusMessage **   <a name="Backup-Type-LatestMpaApprovalTeamUpdate-StatusMessage"></a>
A message describing the current status of the MPA approval team update.  
Type: String  
Required: No

## See Also
<a name="API_LatestMpaApprovalTeamUpdate_SeeAlso"></a>

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
<a name="API_LatestRevokeRequest"></a>

Contains information about the latest request to revoke access to a backup vault.

## Contents
<a name="API_LatestRevokeRequest_Contents"></a>

 ** ExpiryDate **   <a name="Backup-Type-LatestRevokeRequest-ExpiryDate"></a>
The date and time when the revoke request will expire.  
Type: Timestamp  
Required: No

 ** InitiationDate **   <a name="Backup-Type-LatestRevokeRequest-InitiationDate"></a>
The date and time when the revoke request was initiated.  
Type: Timestamp  
Required: No

 ** MpaSessionArn **   <a name="Backup-Type-LatestRevokeRequest-MpaSessionArn"></a>
The ARN of the MPA session associated with this revoke request.  
Type: String  
Required: No

 ** Status **   <a name="Backup-Type-LatestRevokeRequest-Status"></a>
The current status of the revoke request.  
Type: String  
Valid Values: `PENDING | FAILED`   
Required: No

 ** StatusMessage **   <a name="Backup-Type-LatestRevokeRequest-StatusMessage"></a>
A message describing the current status of the revoke request.  
Type: String  
Required: No

## See Also
<a name="API_LatestRevokeRequest_SeeAlso"></a>

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 name="API_LegalHold"></a>

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
<a name="API_LegalHold_Contents"></a>

 ** CancellationDate **   <a name="Backup-Type-LegalHold-CancellationDate"></a>
The time when the legal hold was cancelled.  
Type: Timestamp  
Required: No

 ** CreationDate **   <a name="Backup-Type-LegalHold-CreationDate"></a>
The time when the legal hold was created.  
Type: Timestamp  
Required: No

 ** Description **   <a name="Backup-Type-LegalHold-Description"></a>
The description of a legal hold.  
Type: String  
Required: No

 ** LegalHoldArn **   <a name="Backup-Type-LegalHold-LegalHoldArn"></a>
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 **   <a name="Backup-Type-LegalHold-LegalHoldId"></a>
The ID of the legal hold.  
Type: String  
Required: No

 ** Status **   <a name="Backup-Type-LegalHold-Status"></a>
The status of the legal hold.  
Type: String  
Valid Values: `CREATING | ACTIVE | CANCELING | CANCELED`   
Required: No

 ** Title **   <a name="Backup-Type-LegalHold-Title"></a>
The title of a legal hold.  
Type: String  
Required: No

## See Also
<a name="API_LegalHold_SeeAlso"></a>

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
<a name="API_Lifecycle"></a>

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
<a name="API_Lifecycle_Contents"></a>

 ** DeleteAfterDays **   <a name="Backup-Type-Lifecycle-DeleteAfterDays"></a>
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 **   <a name="Backup-Type-Lifecycle-DeleteAfterEvent"></a>
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 **   <a name="Backup-Type-Lifecycle-MoveToColdStorageAfterDays"></a>
The number of days after creation that a recovery point is moved to cold storage.  
Type: Long  
Required: No

 ** OptInToArchiveForSupportedResources **   <a name="Backup-Type-Lifecycle-OptInToArchiveForSupportedResources"></a>
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
<a name="API_Lifecycle_SeeAlso"></a>

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 name="API_ProtectedResource"></a>

A structure that contains information about a backed-up resource.

## Contents
<a name="API_ProtectedResource_Contents"></a>

 ** LastBackupTime **   <a name="Backup-Type-ProtectedResource-LastBackupTime"></a>
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 **   <a name="Backup-Type-ProtectedResource-LastBackupVaultArn"></a>
The ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point.  
Type: String  
Required: No

 ** LastRecoveryPointArn **   <a name="Backup-Type-ProtectedResource-LastRecoveryPointArn"></a>
The ARN (Amazon Resource Name) of the most recent recovery point.  
Type: String  
Required: No

 ** ResourceArn **   <a name="Backup-Type-ProtectedResource-ResourceArn"></a>
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 **   <a name="Backup-Type-ProtectedResource-ResourceName"></a>
The non-unique name of the resource that belongs to the specified backup.  
Type: String  
Required: No

 ** ResourceType **   <a name="Backup-Type-ProtectedResource-ResourceType"></a>
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
<a name="API_ProtectedResource_SeeAlso"></a>

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
<a name="API_ProtectedResourceConditions"></a>

The conditions that you define for resources in your restore testing plan using tags.

## Contents
<a name="API_ProtectedResourceConditions_Contents"></a>

 ** StringEquals **   <a name="Backup-Type-ProtectedResourceConditions-StringEquals"></a>
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 **   <a name="Backup-Type-ProtectedResourceConditions-StringNotEquals"></a>
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
<a name="API_ProtectedResourceConditions_SeeAlso"></a>

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
<a name="API_RecoveryPointByBackupVault"></a>

Contains detailed information about the recovery points stored in a backup vault.

## Contents
<a name="API_RecoveryPointByBackupVault_Contents"></a>

 ** AggregatedScanResult **   <a name="Backup-Type-RecoveryPointByBackupVault-AggregatedScanResult"></a>
Contains the latest scanning results against the recovery point and currently include `FailedScan`, `Findings`, `LastComputed`.  
Type: [AggregatedScanResult](API_AggregatedScanResult.md) object  
Required: No

 ** BackupSizeInBytes **   <a name="Backup-Type-RecoveryPointByBackupVault-BackupSizeInBytes"></a>
The size, in bytes, of a backup.  
Type: Long  
Required: No

 ** BackupVaultArn **   <a name="Backup-Type-RecoveryPointByBackupVault-BackupVaultArn"></a>
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 **   <a name="Backup-Type-RecoveryPointByBackupVault-BackupVaultName"></a>
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 name="Backup-Type-RecoveryPointByBackupVault-CalculatedLifecycle"></a>
A `CalculatedLifecycle` object containing `DeleteAt` and `MoveToColdStorageAt` timestamps.  
Type: [CalculatedLifecycle](API_CalculatedLifecycle.md) object  
Required: No

 ** CompletionDate **   <a name="Backup-Type-RecoveryPointByBackupVault-CompletionDate"></a>
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 **   <a name="Backup-Type-RecoveryPointByBackupVault-CompositeMemberIdentifier"></a>
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 **   <a name="Backup-Type-RecoveryPointByBackupVault-CreatedBy"></a>
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 **   <a name="Backup-Type-RecoveryPointByBackupVault-CreationDate"></a>
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 **   <a name="Backup-Type-RecoveryPointByBackupVault-EncryptionKeyArn"></a>
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 **   <a name="Backup-Type-RecoveryPointByBackupVault-EncryptionKeyType"></a>
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 **   <a name="Backup-Type-RecoveryPointByBackupVault-IamRoleArn"></a>
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 **   <a name="Backup-Type-RecoveryPointByBackupVault-IndexStatus"></a>
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 name="Backup-Type-RecoveryPointByBackupVault-IndexStatusMessage"></a>
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 **   <a name="Backup-Type-RecoveryPointByBackupVault-InitiationDate"></a>
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 name="Backup-Type-RecoveryPointByBackupVault-IsEncrypted"></a>
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 **   <a name="Backup-Type-RecoveryPointByBackupVault-IsParent"></a>
This is a boolean value indicating this is a parent (composite) recovery point.  
Type: Boolean  
Required: No

 ** LastRestoreTime **   <a name="Backup-Type-RecoveryPointByBackupVault-LastRestoreTime"></a>
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 **   <a name="Backup-Type-RecoveryPointByBackupVault-Lifecycle"></a>
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 **   <a name="Backup-Type-RecoveryPointByBackupVault-ParentRecoveryPointArn"></a>
The Amazon Resource Name (ARN) of the parent (composite) recovery point.  
Type: String  
Required: No

 ** RecoveryPointArn **   <a name="Backup-Type-RecoveryPointByBackupVault-RecoveryPointArn"></a>
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 **   <a name="Backup-Type-RecoveryPointByBackupVault-ResourceArn"></a>
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.  
Type: String  
Required: No

 ** ResourceName **   <a name="Backup-Type-RecoveryPointByBackupVault-ResourceName"></a>
The non-unique name of the resource that belongs to the specified backup.  
Type: String  
Required: No

 ** ResourceType **   <a name="Backup-Type-RecoveryPointByBackupVault-ResourceType"></a>
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 **   <a name="Backup-Type-RecoveryPointByBackupVault-SourceBackupVaultArn"></a>
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 name="Backup-Type-RecoveryPointByBackupVault-Status"></a>
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 name="Backup-Type-RecoveryPointByBackupVault-StatusMessage"></a>
A message explaining the current status of the recovery point.  
Type: String  
Required: No

 ** VaultType **   <a name="Backup-Type-RecoveryPointByBackupVault-VaultType"></a>
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
<a name="API_RecoveryPointByBackupVault_SeeAlso"></a>

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
<a name="API_RecoveryPointByResource"></a>

Contains detailed information about a saved recovery point.

## Contents
<a name="API_RecoveryPointByResource_Contents"></a>

 ** AggregatedScanResult **   <a name="Backup-Type-RecoveryPointByResource-AggregatedScanResult"></a>
Contains the latest scanning results against the recovery point and currently include `FailedScan`, `Findings`, `LastComputed`.  
Type: [AggregatedScanResult](API_AggregatedScanResult.md) object  
Required: No

 ** BackupSizeBytes **   <a name="Backup-Type-RecoveryPointByResource-BackupSizeBytes"></a>
The size, in bytes, of a backup.  
Type: Long  
Required: No

 ** BackupVaultName **   <a name="Backup-Type-RecoveryPointByResource-BackupVaultName"></a>
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 **   <a name="Backup-Type-RecoveryPointByResource-CreationDate"></a>
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 **   <a name="Backup-Type-RecoveryPointByResource-EncryptionKeyArn"></a>
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 **   <a name="Backup-Type-RecoveryPointByResource-EncryptionKeyType"></a>
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 **   <a name="Backup-Type-RecoveryPointByResource-IndexStatus"></a>
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 name="Backup-Type-RecoveryPointByResource-IndexStatusMessage"></a>
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 **   <a name="Backup-Type-RecoveryPointByResource-IsParent"></a>
This is a boolean value indicating this is a parent (composite) recovery point.  
Type: Boolean  
Required: No

 ** ParentRecoveryPointArn **   <a name="Backup-Type-RecoveryPointByResource-ParentRecoveryPointArn"></a>
The Amazon Resource Name (ARN) of the parent (composite) recovery point.  
Type: String  
Required: No

 ** RecoveryPointArn **   <a name="Backup-Type-RecoveryPointByResource-RecoveryPointArn"></a>
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 **   <a name="Backup-Type-RecoveryPointByResource-ResourceName"></a>
The non-unique name of the resource that belongs to the specified backup.  
Type: String  
Required: No

 ** Status **   <a name="Backup-Type-RecoveryPointByResource-Status"></a>
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 name="Backup-Type-RecoveryPointByResource-StatusMessage"></a>
A message explaining the current status of the recovery point.  
Type: String  
Required: No

 ** VaultType **   <a name="Backup-Type-RecoveryPointByResource-VaultType"></a>
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
<a name="API_RecoveryPointByResource_SeeAlso"></a>

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
<a name="API_RecoveryPointCreator"></a>

Contains information about the backup plan and rule that AWS Backup used to initiate the recovery point backup.

## Contents
<a name="API_RecoveryPointCreator_Contents"></a>

 ** BackupPlanArn **   <a name="Backup-Type-RecoveryPointCreator-BackupPlanArn"></a>
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 **   <a name="Backup-Type-RecoveryPointCreator-BackupPlanId"></a>
Uniquely identifies a backup plan.  
Type: String  
Required: No

 ** BackupPlanName **   <a name="Backup-Type-RecoveryPointCreator-BackupPlanName"></a>
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 **   <a name="Backup-Type-RecoveryPointCreator-BackupPlanVersion"></a>
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 **   <a name="Backup-Type-RecoveryPointCreator-BackupRuleCron"></a>
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 **   <a name="Backup-Type-RecoveryPointCreator-BackupRuleId"></a>
Uniquely identifies a rule used to schedule the backup of a selection of resources.  
Type: String  
Required: No

 ** BackupRuleName **   <a name="Backup-Type-RecoveryPointCreator-BackupRuleName"></a>
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 **   <a name="Backup-Type-RecoveryPointCreator-BackupRuleTimezone"></a>
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
<a name="API_RecoveryPointCreator_SeeAlso"></a>

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
<a name="API_RecoveryPointMember"></a>

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
<a name="API_RecoveryPointMember_Contents"></a>

 ** BackupVaultName **   <a name="Backup-Type-RecoveryPointMember-BackupVaultName"></a>
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 **   <a name="Backup-Type-RecoveryPointMember-RecoveryPointArn"></a>
The Amazon Resource Name (ARN) of the parent (composite) recovery point.  
Type: String  
Required: No

 ** ResourceArn **   <a name="Backup-Type-RecoveryPointMember-ResourceArn"></a>
The Amazon Resource Name (ARN) that uniquely identifies a saved resource.  
Type: String  
Required: No

 ** ResourceType **   <a name="Backup-Type-RecoveryPointMember-ResourceType"></a>
The AWS resource type that is saved as a recovery point.  
Type: String  
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`   
Required: No

## See Also
<a name="API_RecoveryPointMember_SeeAlso"></a>

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
<a name="API_RecoveryPointSelection"></a>

This specifies criteria to assign a set of resources, such as resource types or backup vaults.

## Contents
<a name="API_RecoveryPointSelection_Contents"></a>

 ** DateRange **   <a name="Backup-Type-RecoveryPointSelection-DateRange"></a>
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 **   <a name="Backup-Type-RecoveryPointSelection-ResourceIdentifiers"></a>
These are the resources included in the resource selection (including type of resources and vaults).  
Type: Array of strings  
Required: No

 ** VaultNames **   <a name="Backup-Type-RecoveryPointSelection-VaultNames"></a>
These are the names of the vaults in which the selected recovery points are contained.  
Type: Array of strings  
Required: No

## See Also
<a name="API_RecoveryPointSelection_SeeAlso"></a>

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
<a name="API_ReportDeliveryChannel"></a>

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
<a name="API_ReportDeliveryChannel_Contents"></a>

 ** S3BucketName **   <a name="Backup-Type-ReportDeliveryChannel-S3BucketName"></a>
The unique name of the S3 bucket that receives your reports.  
Type: String  
Required: Yes

 ** Formats **   <a name="Backup-Type-ReportDeliveryChannel-Formats"></a>
The format of your reports: `CSV`, `JSON`, or both. If not specified, the default format is `CSV`.  
Type: Array of strings  
Required: No

 ** S3KeyPrefix **   <a name="Backup-Type-ReportDeliveryChannel-S3KeyPrefix"></a>
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
<a name="API_ReportDeliveryChannel_SeeAlso"></a>

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
<a name="API_ReportDestination"></a>

Contains information from your report job about your report destination.

## Contents
<a name="API_ReportDestination_Contents"></a>

 ** S3BucketName **   <a name="Backup-Type-ReportDestination-S3BucketName"></a>
The unique name of the Amazon S3 bucket that receives your reports.  
Type: String  
Required: No

 ** S3Keys **   <a name="Backup-Type-ReportDestination-S3Keys"></a>
The object key that uniquely identifies your reports in your S3 bucket.  
Type: Array of strings  
Required: No

## See Also
<a name="API_ReportDestination_SeeAlso"></a>

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
<a name="API_ReportJob"></a>

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
<a name="API_ReportJob_Contents"></a>

 ** CompletionTime **   <a name="Backup-Type-ReportJob-CompletionTime"></a>
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 **   <a name="Backup-Type-ReportJob-CreationTime"></a>
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 **   <a name="Backup-Type-ReportJob-ReportDestination"></a>
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 **   <a name="Backup-Type-ReportJob-ReportJobId"></a>
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 **   <a name="Backup-Type-ReportJob-ReportPlanArn"></a>
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 **   <a name="Backup-Type-ReportJob-ReportTemplate"></a>
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 **   <a name="Backup-Type-ReportJob-Status"></a>
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 name="Backup-Type-ReportJob-StatusMessage"></a>
A message explaining the status of the report job.  
Type: String  
Required: No

## See Also
<a name="API_ReportJob_SeeAlso"></a>

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
<a name="API_ReportPlan"></a>

Contains detailed information about a report plan.

## Contents
<a name="API_ReportPlan_Contents"></a>

 ** CreationTime **   <a name="Backup-Type-ReportPlan-CreationTime"></a>
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 **   <a name="Backup-Type-ReportPlan-DeploymentStatus"></a>
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 **   <a name="Backup-Type-ReportPlan-LastAttemptedExecutionTime"></a>
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 **   <a name="Backup-Type-ReportPlan-LastSuccessfulExecutionTime"></a>
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 **   <a name="Backup-Type-ReportPlan-ReportDeliveryChannel"></a>
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 **   <a name="Backup-Type-ReportPlan-ReportPlanArn"></a>
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 **   <a name="Backup-Type-ReportPlan-ReportPlanDescription"></a>
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 **   <a name="Backup-Type-ReportPlan-ReportPlanName"></a>
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 **   <a name="Backup-Type-ReportPlan-ReportSetting"></a>
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
<a name="API_ReportPlan_SeeAlso"></a>

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
<a name="API_ReportSetting"></a>

Contains detailed information about a report setting.

## Contents
<a name="API_ReportSetting_Contents"></a>

 ** ReportTemplate **   <a name="Backup-Type-ReportSetting-ReportTemplate"></a>
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 **   <a name="Backup-Type-ReportSetting-Accounts"></a>
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 **   <a name="Backup-Type-ReportSetting-FrameworkArns"></a>
The Amazon Resource Names (ARNs) of the frameworks a report covers.  
Type: Array of strings  
Required: No

 ** NumberOfFrameworks **   <a name="Backup-Type-ReportSetting-NumberOfFrameworks"></a>
The number of frameworks a report covers.  
Type: Integer  
Required: No

 ** OrganizationUnits **   <a name="Backup-Type-ReportSetting-OrganizationUnits"></a>
These are the Organizational Units to be included in the report.  
Type: Array of strings  
Required: No

 ** Regions **   <a name="Backup-Type-ReportSetting-Regions"></a>
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
<a name="API_ReportSetting_SeeAlso"></a>

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
<a name="API_ResourceSelection"></a>

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
<a name="API_ResourceSelection_Contents"></a>

 ** Resources **   <a name="Backup-Type-ResourceSelection-Resources"></a>
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 **   <a name="Backup-Type-ResourceSelection-ResourceType"></a>
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 **   <a name="Backup-Type-ResourceSelection-TieringDownSettingsInDays"></a>
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
<a name="API_ResourceSelection_SeeAlso"></a>

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
<a name="API_RestoreAccessBackupVaultListMember"></a>

Contains information about a restore access backup vault.

## Contents
<a name="API_RestoreAccessBackupVaultListMember_Contents"></a>

 ** ApprovalDate **   <a name="Backup-Type-RestoreAccessBackupVaultListMember-ApprovalDate"></a>
The date and time when the restore access backup vault was approved.  
Type: Timestamp  
Required: No

 ** CreationDate **   <a name="Backup-Type-RestoreAccessBackupVaultListMember-CreationDate"></a>
The date and time when the restore access backup vault was created.  
Type: Timestamp  
Required: No

 ** LatestRevokeRequest **   <a name="Backup-Type-RestoreAccessBackupVaultListMember-LatestRevokeRequest"></a>
Information about the latest request to revoke access to this backup vault.  
Type: [LatestRevokeRequest](API_LatestRevokeRequest.md) object  
Required: No

 ** RestoreAccessBackupVaultArn **   <a name="Backup-Type-RestoreAccessBackupVaultListMember-RestoreAccessBackupVaultArn"></a>
The ARN of the restore access backup vault.  
Type: String  
Required: No

 ** VaultState **   <a name="Backup-Type-RestoreAccessBackupVaultListMember-VaultState"></a>
The current state of the restore access backup vault.  
Type: String  
Valid Values: `CREATING | AVAILABLE | FAILED`   
Required: No

## See Also
<a name="API_RestoreAccessBackupVaultListMember_SeeAlso"></a>

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
<a name="API_RestoreJobCreator"></a>

Contains information about the restore testing plan that AWS Backup used to initiate the restore job.

## Contents
<a name="API_RestoreJobCreator_Contents"></a>

 ** RestoreTestingPlanArn **   <a name="Backup-Type-RestoreJobCreator-RestoreTestingPlanArn"></a>
An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.  
Type: String  
Required: No

## See Also
<a name="API_RestoreJobCreator_SeeAlso"></a>

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
<a name="API_RestoreJobsListMember"></a>

Contains metadata about a restore job.

## Contents
<a name="API_RestoreJobsListMember_Contents"></a>

 ** AccountId **   <a name="Backup-Type-RestoreJobsListMember-AccountId"></a>
The account ID that owns the restore job.  
Type: String  
Pattern: `^[0-9]{12}$`   
Required: No

 ** BackupSizeInBytes **   <a name="Backup-Type-RestoreJobsListMember-BackupSizeInBytes"></a>
The size, in bytes, of the restored resource.  
Type: Long  
Required: No

 ** BackupVaultArn **   <a name="Backup-Type-RestoreJobsListMember-BackupVaultArn"></a>
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 **   <a name="Backup-Type-RestoreJobsListMember-CompletionDate"></a>
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 **   <a name="Backup-Type-RestoreJobsListMember-CreatedBy"></a>
Contains identifying information about the creation of a restore job.  
Type: [RestoreJobCreator](API_RestoreJobCreator.md) object  
Required: No

 ** CreatedResourceArn **   <a name="Backup-Type-RestoreJobsListMember-CreatedResourceArn"></a>
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 **   <a name="Backup-Type-RestoreJobsListMember-CreationDate"></a>
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 **   <a name="Backup-Type-RestoreJobsListMember-DeletionStatus"></a>
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 **   <a name="Backup-Type-RestoreJobsListMember-DeletionStatusMessage"></a>
This describes the restore job deletion status.  
Type: String  
Required: No

 ** ExpectedCompletionTimeMinutes **   <a name="Backup-Type-RestoreJobsListMember-ExpectedCompletionTimeMinutes"></a>
The amount of time in minutes that a job restoring a recovery point is expected to take.  
Type: Long  
Required: No

 ** IamRoleArn **   <a name="Backup-Type-RestoreJobsListMember-IamRoleArn"></a>
The IAM role ARN used to create the target recovery point; for example, `arn:aws:iam::123456789012:role/S3Access`.  
Type: String  
Required: No

 ** IsParent **   <a name="Backup-Type-RestoreJobsListMember-IsParent"></a>
This is a boolean value indicating whether the restore job is a parent (composite) restore job.  
Type: Boolean  
Required: No

 ** ParentJobId **   <a name="Backup-Type-RestoreJobsListMember-ParentJobId"></a>
This is the unique identifier of the parent restore job for the selected restore job.  
Type: String  
Required: No

 ** PercentDone **   <a name="Backup-Type-RestoreJobsListMember-PercentDone"></a>
Contains an estimated percentage complete of a job at the time the job status was queried.  
Type: String  
Required: No

 ** RecoveryPointArn **   <a name="Backup-Type-RestoreJobsListMember-RecoveryPointArn"></a>
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 **   <a name="Backup-Type-RestoreJobsListMember-RecoveryPointCreationDate"></a>
The date on which a recovery point was created.  
Type: Timestamp  
Required: No

 ** ResourceType **   <a name="Backup-Type-RestoreJobsListMember-ResourceType"></a>
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 **   <a name="Backup-Type-RestoreJobsListMember-RestoreJobId"></a>
Uniquely identifies the job that restores a recovery point.  
Type: String  
Required: No

 ** SourceResourceArn **   <a name="Backup-Type-RestoreJobsListMember-SourceResourceArn"></a>
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 name="Backup-Type-RestoreJobsListMember-Status"></a>
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 name="Backup-Type-RestoreJobsListMember-StatusMessage"></a>
A detailed message explaining the status of the job to restore a recovery point.  
Type: String  
Required: No

 ** ValidationStatus **   <a name="Backup-Type-RestoreJobsListMember-ValidationStatus"></a>
The status of validation run on the indicated restore job.  
Type: String  
Valid Values: `FAILED | SUCCESSFUL | TIMED_OUT | VALIDATING`   
Required: No

 ** ValidationStatusMessage **   <a name="Backup-Type-RestoreJobsListMember-ValidationStatusMessage"></a>
This describes the status of validation run on the indicated restore job.  
Type: String  
Required: No

## See Also
<a name="API_RestoreJobsListMember_SeeAlso"></a>

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
<a name="API_RestoreJobSummary"></a>

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
<a name="API_RestoreJobSummary_Contents"></a>

 ** AccountId **   <a name="Backup-Type-RestoreJobSummary-AccountId"></a>
The account ID that owns the jobs within the summary.  
Type: String  
Pattern: `^[0-9]{12}$`   
Required: No

 ** Count **   <a name="Backup-Type-RestoreJobSummary-Count"></a>
The value as a number of jobs in a job summary.  
Type: Integer  
Required: No

 ** EndTime **   <a name="Backup-Type-RestoreJobSummary-EndTime"></a>
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 **   <a name="Backup-Type-RestoreJobSummary-Region"></a>
The AWS Regions within the job summary.  
Type: String  
Required: No

 ** ResourceType **   <a name="Backup-Type-RestoreJobSummary-ResourceType"></a>
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 **   <a name="Backup-Type-RestoreJobSummary-StartTime"></a>
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 **   <a name="Backup-Type-RestoreJobSummary-State"></a>
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
<a name="API_RestoreJobSummary_SeeAlso"></a>

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
<a name="API_RestoreTestingPlanForCreate"></a>

This contains metadata about a restore testing plan.

## Contents
<a name="API_RestoreTestingPlanForCreate_Contents"></a>

 ** RecoveryPointSelection **   <a name="Backup-Type-RestoreTestingPlanForCreate-RecoveryPointSelection"></a>
 `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 **   <a name="Backup-Type-RestoreTestingPlanForCreate-RestoreTestingPlanName"></a>
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 name="Backup-Type-RestoreTestingPlanForCreate-ScheduleExpression"></a>
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 **   <a name="Backup-Type-RestoreTestingPlanForCreate-ScheduleExpressionTimezone"></a>
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 **   <a name="Backup-Type-RestoreTestingPlanForCreate-StartWindowHours"></a>
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
<a name="API_RestoreTestingPlanForCreate_SeeAlso"></a>

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
<a name="API_RestoreTestingPlanForGet"></a>

This contains metadata about a restore testing plan.

## Contents
<a name="API_RestoreTestingPlanForGet_Contents"></a>

 ** CreationTime **   <a name="Backup-Type-RestoreTestingPlanForGet-CreationTime"></a>
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 **   <a name="Backup-Type-RestoreTestingPlanForGet-RecoveryPointSelection"></a>
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 **   <a name="Backup-Type-RestoreTestingPlanForGet-RestoreTestingPlanArn"></a>
An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.  
Type: String  
Required: Yes

 ** RestoreTestingPlanName **   <a name="Backup-Type-RestoreTestingPlanForGet-RestoreTestingPlanName"></a>
The restore testing plan name.  
Type: String  
Required: Yes

 ** ScheduleExpression **   <a name="Backup-Type-RestoreTestingPlanForGet-ScheduleExpression"></a>
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 **   <a name="Backup-Type-RestoreTestingPlanForGet-CreatorRequestId"></a>
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 **   <a name="Backup-Type-RestoreTestingPlanForGet-LastExecutionTime"></a>
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 **   <a name="Backup-Type-RestoreTestingPlanForGet-LastUpdateTime"></a>
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 **   <a name="Backup-Type-RestoreTestingPlanForGet-ScheduleExpressionTimezone"></a>
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 **   <a name="Backup-Type-RestoreTestingPlanForGet-StartWindowHours"></a>
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
<a name="API_RestoreTestingPlanForGet_SeeAlso"></a>

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
<a name="API_RestoreTestingPlanForList"></a>

This contains metadata about a restore testing plan.

## Contents
<a name="API_RestoreTestingPlanForList_Contents"></a>

 ** CreationTime **   <a name="Backup-Type-RestoreTestingPlanForList-CreationTime"></a>
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 **   <a name="Backup-Type-RestoreTestingPlanForList-RestoreTestingPlanArn"></a>
An Amazon Resource Name (ARN) that uniquely identifiesa restore testing plan.  
Type: String  
Required: Yes

 ** RestoreTestingPlanName **   <a name="Backup-Type-RestoreTestingPlanForList-RestoreTestingPlanName"></a>
The restore testing plan name.  
Type: String  
Required: Yes

 ** ScheduleExpression **   <a name="Backup-Type-RestoreTestingPlanForList-ScheduleExpression"></a>
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 **   <a name="Backup-Type-RestoreTestingPlanForList-LastExecutionTime"></a>
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 **   <a name="Backup-Type-RestoreTestingPlanForList-LastUpdateTime"></a>
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 **   <a name="Backup-Type-RestoreTestingPlanForList-ScheduleExpressionTimezone"></a>
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 **   <a name="Backup-Type-RestoreTestingPlanForList-StartWindowHours"></a>
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
<a name="API_RestoreTestingPlanForList_SeeAlso"></a>

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
<a name="API_RestoreTestingPlanForUpdate"></a>

This contains metadata about a restore testing plan.

## Contents
<a name="API_RestoreTestingPlanForUpdate_Contents"></a>

 ** RecoveryPointSelection **   <a name="Backup-Type-RestoreTestingPlanForUpdate-RecoveryPointSelection"></a>
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 name="Backup-Type-RestoreTestingPlanForUpdate-ScheduleExpression"></a>
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 **   <a name="Backup-Type-RestoreTestingPlanForUpdate-ScheduleExpressionTimezone"></a>
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 **   <a name="Backup-Type-RestoreTestingPlanForUpdate-StartWindowHours"></a>
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
<a name="API_RestoreTestingPlanForUpdate_SeeAlso"></a>

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
<a name="API_RestoreTestingRecoveryPointSelection"></a>

 `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
<a name="API_RestoreTestingRecoveryPointSelection_Contents"></a>

 ** Algorithm **   <a name="Backup-Type-RestoreTestingRecoveryPointSelection-Algorithm"></a>
Acceptable values include "LATEST\$1WITHIN\$1WINDOW" or "RANDOM\$1WITHIN\$1WINDOW"  
Type: String  
Valid Values: `LATEST_WITHIN_WINDOW | RANDOM_WITHIN_WINDOW`   
Required: No

 ** ExcludeVaults **   <a name="Backup-Type-RestoreTestingRecoveryPointSelection-ExcludeVaults"></a>
Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed.  
Type: Array of strings  
Required: No

 ** IncludeVaults **   <a name="Backup-Type-RestoreTestingRecoveryPointSelection-IncludeVaults"></a>
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 **   <a name="Backup-Type-RestoreTestingRecoveryPointSelection-RecoveryPointTypes"></a>
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 **   <a name="Backup-Type-RestoreTestingRecoveryPointSelection-SelectionWindowDays"></a>
Accepted values are integers from 1 to 365.  
Type: Integer  
Required: No

## See Also
<a name="API_RestoreTestingRecoveryPointSelection_SeeAlso"></a>

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
<a name="API_RestoreTestingSelectionForCreate"></a>

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
<a name="API_RestoreTestingSelectionForCreate_Contents"></a>

 ** IamRoleArn **   <a name="Backup-Type-RestoreTestingSelectionForCreate-IamRoleArn"></a>
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 **   <a name="Backup-Type-RestoreTestingSelectionForCreate-ProtectedResourceType"></a>
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 **   <a name="Backup-Type-RestoreTestingSelectionForCreate-RestoreTestingSelectionName"></a>
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 **   <a name="Backup-Type-RestoreTestingSelectionForCreate-ProtectedResourceArns"></a>
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 **   <a name="Backup-Type-RestoreTestingSelectionForCreate-ProtectedResourceConditions"></a>
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 **   <a name="Backup-Type-RestoreTestingSelectionForCreate-RestoreMetadataOverrides"></a>
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 **   <a name="Backup-Type-RestoreTestingSelectionForCreate-ValidationWindowHours"></a>
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
<a name="API_RestoreTestingSelectionForCreate_SeeAlso"></a>

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
<a name="API_RestoreTestingSelectionForGet"></a>

This contains metadata about a restore testing selection.

## Contents
<a name="API_RestoreTestingSelectionForGet_Contents"></a>

 ** CreationTime **   <a name="Backup-Type-RestoreTestingSelectionForGet-CreationTime"></a>
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 **   <a name="Backup-Type-RestoreTestingSelectionForGet-IamRoleArn"></a>
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 **   <a name="Backup-Type-RestoreTestingSelectionForGet-ProtectedResourceType"></a>
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 **   <a name="Backup-Type-RestoreTestingSelectionForGet-RestoreTestingPlanName"></a>
The RestoreTestingPlanName is a unique string that is the name of the restore testing plan.  
Type: String  
Required: Yes

 ** RestoreTestingSelectionName **   <a name="Backup-Type-RestoreTestingSelectionForGet-RestoreTestingSelectionName"></a>
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 **   <a name="Backup-Type-RestoreTestingSelectionForGet-CreatorRequestId"></a>
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 **   <a name="Backup-Type-RestoreTestingSelectionForGet-ProtectedResourceArns"></a>
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 **   <a name="Backup-Type-RestoreTestingSelectionForGet-ProtectedResourceConditions"></a>
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 **   <a name="Backup-Type-RestoreTestingSelectionForGet-RestoreMetadataOverrides"></a>
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 **   <a name="Backup-Type-RestoreTestingSelectionForGet-ValidationWindowHours"></a>
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
<a name="API_RestoreTestingSelectionForGet_SeeAlso"></a>

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
<a name="API_RestoreTestingSelectionForList"></a>

This contains metadata about a restore testing selection.

## Contents
<a name="API_RestoreTestingSelectionForList_Contents"></a>

 ** CreationTime **   <a name="Backup-Type-RestoreTestingSelectionForList-CreationTime"></a>
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 **   <a name="Backup-Type-RestoreTestingSelectionForList-IamRoleArn"></a>
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 **   <a name="Backup-Type-RestoreTestingSelectionForList-ProtectedResourceType"></a>
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 **   <a name="Backup-Type-RestoreTestingSelectionForList-RestoreTestingPlanName"></a>
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 **   <a name="Backup-Type-RestoreTestingSelectionForList-RestoreTestingSelectionName"></a>
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 **   <a name="Backup-Type-RestoreTestingSelectionForList-ValidationWindowHours"></a>
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
<a name="API_RestoreTestingSelectionForList_SeeAlso"></a>

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
<a name="API_RestoreTestingSelectionForUpdate"></a>

This contains metadata about a restore testing selection.

## Contents
<a name="API_RestoreTestingSelectionForUpdate_Contents"></a>

 ** IamRoleArn **   <a name="Backup-Type-RestoreTestingSelectionForUpdate-IamRoleArn"></a>
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 **   <a name="Backup-Type-RestoreTestingSelectionForUpdate-ProtectedResourceArns"></a>
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 **   <a name="Backup-Type-RestoreTestingSelectionForUpdate-ProtectedResourceConditions"></a>
The conditions that you define for resources in your restore testing plan using tags.  
Type: [ProtectedResourceConditions](API_ProtectedResourceConditions.md) object  
Required: No

 ** RestoreMetadataOverrides **   <a name="Backup-Type-RestoreTestingSelectionForUpdate-RestoreMetadataOverrides"></a>
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 **   <a name="Backup-Type-RestoreTestingSelectionForUpdate-ValidationWindowHours"></a>
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
<a name="API_RestoreTestingSelectionForUpdate_SeeAlso"></a>

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
<a name="API_ScanAction"></a>

Defines a scanning action that specifies the malware scanner and scan mode to use.

## Contents
<a name="API_ScanAction_Contents"></a>

 ** MalwareScanner **   <a name="Backup-Type-ScanAction-MalwareScanner"></a>
The malware scanner to use for the scan action. Currently only `GUARDDUTY` is supported.  
Type: String  
Valid Values: `GUARDDUTY`   
Required: No

 ** ScanMode **   <a name="Backup-Type-ScanAction-ScanMode"></a>
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
<a name="API_ScanAction_SeeAlso"></a>

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
<a name="API_ScanJob"></a>

Contains metadata about a scan job, including information about the scanning process, results, and associated resources.

## Contents
<a name="API_ScanJob_Contents"></a>

 ** AccountId **   <a name="Backup-Type-ScanJob-AccountId"></a>
The account ID that owns the scan job.  
Type: String  
Required: Yes

 ** BackupVaultArn **   <a name="Backup-Type-ScanJob-BackupVaultArn"></a>
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 **   <a name="Backup-Type-ScanJob-BackupVaultName"></a>
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 **   <a name="Backup-Type-ScanJob-CreatedBy"></a>
Contains identifying information about the creation of a scan job.  
Type: [ScanJobCreator](API_ScanJobCreator.md) object  
Required: Yes

 ** CreationDate **   <a name="Backup-Type-ScanJob-CreationDate"></a>
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 **   <a name="Backup-Type-ScanJob-IamRoleArn"></a>
Specifies the IAM role ARN used to create the scan job; for example, `arn:aws:iam::123456789012:role/S3Access`.  
Type: String  
Required: Yes

 ** MalwareScanner **   <a name="Backup-Type-ScanJob-MalwareScanner"></a>
The scanning engine used for the scan job. Currently only `GUARDDUTY` is supported.  
Type: String  
Valid Values: `GUARDDUTY`   
Required: Yes

 ** RecoveryPointArn **   <a name="Backup-Type-ScanJob-RecoveryPointArn"></a>
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 **   <a name="Backup-Type-ScanJob-ResourceArn"></a>
An ARN that uniquely identifies the source resource of the recovery point being scanned.  
Type: String  
Required: Yes

 ** ResourceName **   <a name="Backup-Type-ScanJob-ResourceName"></a>
The non-unique name of the resource that belongs to the specified backup.  
Type: String  
Required: Yes

 ** ResourceType **   <a name="Backup-Type-ScanJob-ResourceType"></a>
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 **   <a name="Backup-Type-ScanJob-ScanJobId"></a>
The unique identifier that identifies the scan job request to AWS Backup.  
Type: String  
Required: Yes

 ** ScanMode **   <a name="Backup-Type-ScanJob-ScanMode"></a>
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 **   <a name="Backup-Type-ScanJob-ScannerRoleArn"></a>
Specifies the scanner IAM role ARN used for the scan job.  
Type: String  
Required: Yes

 ** CompletionDate **   <a name="Backup-Type-ScanJob-CompletionDate"></a>
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 **   <a name="Backup-Type-ScanJob-ScanBaseRecoveryPointArn"></a>
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 **   <a name="Backup-Type-ScanJob-ScanId"></a>
The scan ID generated by the malware scanner for the corresponding scan job.  
Type: String  
Required: No

 ** ScanResult **   <a name="Backup-Type-ScanJob-ScanResult"></a>
Contains the scan results information, including the status of threats found during scanning.  
Type: [ScanResultInfo](API_ScanResultInfo.md) object  
Required: No

 ** State **   <a name="Backup-Type-ScanJob-State"></a>
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 name="Backup-Type-ScanJob-StatusMessage"></a>
A detailed message explaining the status of the scan job.  
Type: String  
Required: No

## See Also
<a name="API_ScanJob_SeeAlso"></a>

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
<a name="API_ScanJobCreator"></a>

Contains identifying information about the creation of a scan job, including the backup plan and rule that initiated the scan.

## Contents
<a name="API_ScanJobCreator_Contents"></a>

 ** BackupPlanArn **   <a name="Backup-Type-ScanJobCreator-BackupPlanArn"></a>
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 **   <a name="Backup-Type-ScanJobCreator-BackupPlanId"></a>
The ID of the backup plan.  
Type: String  
Required: Yes

 ** BackupPlanVersion **   <a name="Backup-Type-ScanJobCreator-BackupPlanVersion"></a>
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 **   <a name="Backup-Type-ScanJobCreator-BackupRuleId"></a>
Uniquely identifies the backup rule that initiated the scan job.  
Type: String  
Required: Yes

## See Also
<a name="API_ScanJobCreator_SeeAlso"></a>

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
<a name="API_ScanJobSummary"></a>

Contains summary information about scan jobs, including counts and metadata for a specific time period and criteria.

## Contents
<a name="API_ScanJobSummary_Contents"></a>

 ** AccountId **   <a name="Backup-Type-ScanJobSummary-AccountId"></a>
The account ID that owns the scan jobs included in this summary.  
Type: String  
Pattern: `^[0-9]{12}$`   
Required: No

 ** Count **   <a name="Backup-Type-ScanJobSummary-Count"></a>
The number of scan jobs that match the specified criteria.  
Type: Integer  
Required: No

 ** EndTime **   <a name="Backup-Type-ScanJobSummary-EndTime"></a>
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 **   <a name="Backup-Type-ScanJobSummary-MalwareScanner"></a>
Specifies the malware scanner used during the scan job. Currently only supports `GUARDDUTY`.  
Type: String  
Valid Values: `GUARDDUTY`   
Required: No

 ** Region **   <a name="Backup-Type-ScanJobSummary-Region"></a>
The AWS Region where the scan jobs were executed.  
Type: String  
Required: No

 ** ResourceType **   <a name="Backup-Type-ScanJobSummary-ResourceType"></a>
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 **   <a name="Backup-Type-ScanJobSummary-ScanResultStatus"></a>
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 **   <a name="Backup-Type-ScanJobSummary-StartTime"></a>
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 **   <a name="Backup-Type-ScanJobSummary-State"></a>
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
<a name="API_ScanJobSummary_SeeAlso"></a>

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
<a name="API_ScanResult"></a>

Contains the results of a security scan, including scanner information, scan state, and any findings discovered.

## Contents
<a name="API_ScanResult_Contents"></a>

 ** Findings **   <a name="Backup-Type-ScanResult-Findings"></a>
An array of findings discovered during the scan.  
Type: Array of strings  
Valid Values: `MALWARE`   
Required: No

 ** LastScanTimestamp **   <a name="Backup-Type-ScanResult-LastScanTimestamp"></a>
The timestamp of when the last scan was performed, in Unix format and Coordinated Universal Time (UTC).  
Type: Timestamp  
Required: No

 ** MalwareScanner **   <a name="Backup-Type-ScanResult-MalwareScanner"></a>
The malware scanner used to perform the scan. Currently only `GUARDDUTY` is supported.  
Type: String  
Valid Values: `GUARDDUTY`   
Required: No

 ** ScanJobState **   <a name="Backup-Type-ScanResult-ScanJobState"></a>
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
<a name="API_ScanResult_SeeAlso"></a>

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
<a name="API_ScanResultInfo"></a>

Contains information about the results of a scan job.

## Contents
<a name="API_ScanResultInfo_Contents"></a>

 ** ScanResultStatus **   <a name="Backup-Type-ScanResultInfo-ScanResultStatus"></a>
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
<a name="API_ScanResultInfo_SeeAlso"></a>

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
<a name="API_ScanSetting"></a>

Contains configuration settings for malware scanning, including the scanner type, target resource types, and scanner role.

## Contents
<a name="API_ScanSetting_Contents"></a>

 ** MalwareScanner **   <a name="Backup-Type-ScanSetting-MalwareScanner"></a>
The malware scanner to use for scanning. Currently only `GUARDDUTY` is supported.  
Type: String  
Valid Values: `GUARDDUTY`   
Required: No

 ** ResourceTypes **   <a name="Backup-Type-ScanSetting-ResourceTypes"></a>
An array of resource types to be scanned for malware.  
Type: Array of strings  
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$`   
Required: No

 ** ScannerRoleArn **   <a name="Backup-Type-ScanSetting-ScannerRoleArn"></a>
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
<a name="API_ScanSetting_SeeAlso"></a>

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
<a name="API_ScheduledPlanExecutionMember"></a>

Contains information about a scheduled backup plan execution, including the execution time, rule type, and associated rule identifier.

## Contents
<a name="API_ScheduledPlanExecutionMember_Contents"></a>

 ** ExecutionTime **   <a name="Backup-Type-ScheduledPlanExecutionMember-ExecutionTime"></a>
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 **   <a name="Backup-Type-ScheduledPlanExecutionMember-RuleExecutionType"></a>
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 **   <a name="Backup-Type-ScheduledPlanExecutionMember-RuleId"></a>
The unique identifier of the backup rule that will execute at the scheduled time.  
Type: String  
Required: No

## See Also
<a name="API_ScheduledPlanExecutionMember_SeeAlso"></a>

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
<a name="API_TieringConfiguration"></a>

This contains metadata about a tiering configuration.

## Contents
<a name="API_TieringConfiguration_Contents"></a>

 ** BackupVaultName **   <a name="Backup-Type-TieringConfiguration-BackupVaultName"></a>
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 **   <a name="Backup-Type-TieringConfiguration-ResourceSelection"></a>
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 **   <a name="Backup-Type-TieringConfiguration-TieringConfigurationName"></a>
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 **   <a name="Backup-Type-TieringConfiguration-CreationTime"></a>
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 **   <a name="Backup-Type-TieringConfiguration-CreatorRequestId"></a>
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 **   <a name="Backup-Type-TieringConfiguration-LastUpdatedTime"></a>
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 **   <a name="Backup-Type-TieringConfiguration-TieringConfigurationArn"></a>
An Amazon Resource Name (ARN) that uniquely identifies the tiering configuration.  
Type: String  
Required: No

## See Also
<a name="API_TieringConfiguration_SeeAlso"></a>

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
<a name="API_TieringConfigurationInputForCreate"></a>

This contains metadata about a tiering configuration for create operations.

## Contents
<a name="API_TieringConfigurationInputForCreate_Contents"></a>

 ** BackupVaultName **   <a name="Backup-Type-TieringConfigurationInputForCreate-BackupVaultName"></a>
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 **   <a name="Backup-Type-TieringConfigurationInputForCreate-ResourceSelection"></a>
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 **   <a name="Backup-Type-TieringConfigurationInputForCreate-TieringConfigurationName"></a>
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
<a name="API_TieringConfigurationInputForCreate_SeeAlso"></a>

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
<a name="API_TieringConfigurationInputForUpdate"></a>

This contains metadata about a tiering configuration for update operations.

## Contents
<a name="API_TieringConfigurationInputForUpdate_Contents"></a>

 ** BackupVaultName **   <a name="Backup-Type-TieringConfigurationInputForUpdate-BackupVaultName"></a>
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 **   <a name="Backup-Type-TieringConfigurationInputForUpdate-ResourceSelection"></a>
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
<a name="API_TieringConfigurationInputForUpdate_SeeAlso"></a>

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
<a name="API_TieringConfigurationsListMember"></a>

This contains metadata about a tiering configuration returned in a list.

## Contents
<a name="API_TieringConfigurationsListMember_Contents"></a>

 ** BackupVaultName **   <a name="Backup-Type-TieringConfigurationsListMember-BackupVaultName"></a>
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 **   <a name="Backup-Type-TieringConfigurationsListMember-CreationTime"></a>
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 **   <a name="Backup-Type-TieringConfigurationsListMember-LastUpdatedTime"></a>
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 **   <a name="Backup-Type-TieringConfigurationsListMember-TieringConfigurationArn"></a>
An Amazon Resource Name (ARN) that uniquely identifies the tiering configuration.  
Type: String  
Required: No

 ** TieringConfigurationName **   <a name="Backup-Type-TieringConfigurationsListMember-TieringConfigurationName"></a>
The unique name of the tiering configuration.  
Type: String  
Pattern: `^[a-zA-Z0-9_]{1,200}$`   
Required: No

## See Also
<a name="API_TieringConfigurationsListMember_SeeAlso"></a>

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
<a name="API_Types_AWS_Backup_Gateway"></a>

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
<a name="API_BGW_BandwidthRateLimitInterval"></a>

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
<a name="API_BGW_BandwidthRateLimitInterval_Contents"></a>

 ** DaysOfWeek **   <a name="Backup-Type-BGW_BandwidthRateLimitInterval-DaysOfWeek"></a>
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 **   <a name="Backup-Type-BGW_BandwidthRateLimitInterval-EndHourOfDay"></a>
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 **   <a name="Backup-Type-BGW_BandwidthRateLimitInterval-EndMinuteOfHour"></a>
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 **   <a name="Backup-Type-BGW_BandwidthRateLimitInterval-StartHourOfDay"></a>
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 **   <a name="Backup-Type-BGW_BandwidthRateLimitInterval-StartMinuteOfHour"></a>
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 **   <a name="Backup-Type-BGW_BandwidthRateLimitInterval-AverageUploadRateLimitInBitsPerSec"></a>
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
<a name="API_BGW_BandwidthRateLimitInterval_SeeAlso"></a>

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 name="API_BGW_Gateway"></a>

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
<a name="API_BGW_Gateway_Contents"></a>

 ** GatewayArn **   <a name="Backup-Type-BGW_Gateway-GatewayArn"></a>
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 **   <a name="Backup-Type-BGW_Gateway-GatewayDisplayName"></a>
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 **   <a name="Backup-Type-BGW_Gateway-GatewayType"></a>
The type of the gateway.  
Type: String  
Valid Values: `BACKUP_VM`   
Required: No

 ** HypervisorId **   <a name="Backup-Type-BGW_Gateway-HypervisorId"></a>
The hypervisor ID of the gateway.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** LastSeenTime **   <a name="Backup-Type-BGW_Gateway-LastSeenTime"></a>
The last time AWS Backup gateway communicated with the gateway, in Unix format and UTC time.  
Type: Timestamp  
Required: No

## See Also
<a name="API_BGW_Gateway_SeeAlso"></a>

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
<a name="API_BGW_GatewayDetails"></a>

The details of gateway.

## Contents
<a name="API_BGW_GatewayDetails_Contents"></a>

 ** DeprecationDate **   <a name="Backup-Type-BGW_GatewayDetails-DeprecationDate"></a>
Date after which this gateway will not receive software updates for new features and bug fixes.  
Type: Timestamp  
Required: No

 ** GatewayArn **   <a name="Backup-Type-BGW_GatewayDetails-GatewayArn"></a>
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 **   <a name="Backup-Type-BGW_GatewayDetails-GatewayDisplayName"></a>
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 **   <a name="Backup-Type-BGW_GatewayDetails-GatewayType"></a>
The type of the gateway type.  
Type: String  
Valid Values: `BACKUP_VM`   
Required: No

 ** HypervisorId **   <a name="Backup-Type-BGW_GatewayDetails-HypervisorId"></a>
The hypervisor ID of the gateway.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** LastSeenTime **   <a name="Backup-Type-BGW_GatewayDetails-LastSeenTime"></a>
Details showing the last time AWS Backup gateway communicated with the cloud, in Unix format and UTC time.  
Type: Timestamp  
Required: No

 ** MaintenanceStartTime **   <a name="Backup-Type-BGW_GatewayDetails-MaintenanceStartTime"></a>
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 **   <a name="Backup-Type-BGW_GatewayDetails-NextUpdateAvailabilityTime"></a>
Details showing the next update availability time of the gateway.  
Type: Timestamp  
Required: No

 ** SoftwareVersion **   <a name="Backup-Type-BGW_GatewayDetails-SoftwareVersion"></a>
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 **   <a name="Backup-Type-BGW_GatewayDetails-VpcEndpoint"></a>
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
<a name="API_BGW_GatewayDetails_SeeAlso"></a>

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
<a name="API_BGW_Hypervisor"></a>

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
<a name="API_BGW_Hypervisor_Contents"></a>

 ** Host **   <a name="Backup-Type-BGW_Hypervisor-Host"></a>
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 **   <a name="Backup-Type-BGW_Hypervisor-HypervisorArn"></a>
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 **   <a name="Backup-Type-BGW_Hypervisor-KmsKeyArn"></a>
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 **   <a name="Backup-Type-BGW_Hypervisor-Name"></a>
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 **   <a name="Backup-Type-BGW_Hypervisor-State"></a>
The state of the hypervisor.  
Type: String  
Valid Values: `PENDING | ONLINE | OFFLINE | ERROR`   
Required: No

## See Also
<a name="API_BGW_Hypervisor_SeeAlso"></a>

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
<a name="API_BGW_HypervisorDetails"></a>

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
<a name="API_BGW_HypervisorDetails_Contents"></a>

 ** Host **   <a name="Backup-Type-BGW_HypervisorDetails-Host"></a>
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 **   <a name="Backup-Type-BGW_HypervisorDetails-HypervisorArn"></a>
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 **   <a name="Backup-Type-BGW_HypervisorDetails-KmsKeyArn"></a>
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 **   <a name="Backup-Type-BGW_HypervisorDetails-LastSuccessfulMetadataSyncTime"></a>
This is the time when the most recent successful sync of metadata occurred.  
Type: Timestamp  
Required: No

 ** LatestMetadataSyncStatus **   <a name="Backup-Type-BGW_HypervisorDetails-LatestMetadataSyncStatus"></a>
This is the most recent status for the indicated metadata sync.  
Type: String  
Valid Values: `CREATED | RUNNING | FAILED | PARTIALLY_FAILED | SUCCEEDED`   
Required: No

 ** LatestMetadataSyncStatusMessage **   <a name="Backup-Type-BGW_HypervisorDetails-LatestMetadataSyncStatusMessage"></a>
This is the most recent status for the indicated metadata sync.  
Type: String  
Required: No

 ** LogGroupArn **   <a name="Backup-Type-BGW_HypervisorDetails-LogGroupArn"></a>
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 **   <a name="Backup-Type-BGW_HypervisorDetails-Name"></a>
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 **   <a name="Backup-Type-BGW_HypervisorDetails-State"></a>
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
<a name="API_BGW_HypervisorDetails_SeeAlso"></a>

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
<a name="API_BGW_MaintenanceStartTime"></a>

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
<a name="API_BGW_MaintenanceStartTime_Contents"></a>

 ** HourOfDay **   <a name="Backup-Type-BGW_MaintenanceStartTime-HourOfDay"></a>
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 **   <a name="Backup-Type-BGW_MaintenanceStartTime-MinuteOfHour"></a>
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 **   <a name="Backup-Type-BGW_MaintenanceStartTime-DayOfMonth"></a>
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 **   <a name="Backup-Type-BGW_MaintenanceStartTime-DayOfWeek"></a>
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
<a name="API_BGW_MaintenanceStartTime_SeeAlso"></a>

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 name="API_BGW_Tag"></a>

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
<a name="API_BGW_Tag_Contents"></a>

 ** Key **   <a name="Backup-Type-BGW_Tag-Key"></a>
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 **   <a name="Backup-Type-BGW_Tag-Value"></a>
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
<a name="API_BGW_Tag_SeeAlso"></a>

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 name="API_BGW_VirtualMachine"></a>

A virtual machine that is on a hypervisor.

## Contents
<a name="API_BGW_VirtualMachine_Contents"></a>

 ** HostName **   <a name="Backup-Type-BGW_VirtualMachine-HostName"></a>
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 **   <a name="Backup-Type-BGW_VirtualMachine-HypervisorId"></a>
The ID of the virtual machine's hypervisor.  
Type: String  
Required: No

 ** LastBackupDate **   <a name="Backup-Type-BGW_VirtualMachine-LastBackupDate"></a>
The most recent date a virtual machine was backed up, in Unix format and UTC time.  
Type: Timestamp  
Required: No

 ** Name **   <a name="Backup-Type-BGW_VirtualMachine-Name"></a>
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 **   <a name="Backup-Type-BGW_VirtualMachine-Path"></a>
The path of the virtual machine.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[^\x00]+`   
Required: No

 ** ResourceArn **   <a name="Backup-Type-BGW_VirtualMachine-ResourceArn"></a>
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
<a name="API_BGW_VirtualMachine_SeeAlso"></a>

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
<a name="API_BGW_VirtualMachineDetails"></a>

Your `VirtualMachine` objects, ordered by their Amazon Resource Names (ARNs).

## Contents
<a name="API_BGW_VirtualMachineDetails_Contents"></a>

 ** HostName **   <a name="Backup-Type-BGW_VirtualMachineDetails-HostName"></a>
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 **   <a name="Backup-Type-BGW_VirtualMachineDetails-HypervisorId"></a>
The ID of the virtual machine's hypervisor.  
Type: String  
Required: No

 ** LastBackupDate **   <a name="Backup-Type-BGW_VirtualMachineDetails-LastBackupDate"></a>
The most recent date a virtual machine was backed up, in Unix format and UTC time.  
Type: Timestamp  
Required: No

 ** Name **   <a name="Backup-Type-BGW_VirtualMachineDetails-Name"></a>
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 **   <a name="Backup-Type-BGW_VirtualMachineDetails-Path"></a>
The path of the virtual machine.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[^\x00]+`   
Required: No

 ** ResourceArn **   <a name="Backup-Type-BGW_VirtualMachineDetails-ResourceArn"></a>
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 **   <a name="Backup-Type-BGW_VirtualMachineDetails-VmwareTags"></a>
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
<a name="API_BGW_VirtualMachineDetails_SeeAlso"></a>

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 name="API_BGW_VmwareTag"></a>

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
<a name="API_BGW_VmwareTag_Contents"></a>

 ** VmwareCategory **   <a name="Backup-Type-BGW_VmwareTag-VmwareCategory"></a>
The is the category of VMware.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 80.  
Required: No

 ** VmwareTagDescription **   <a name="Backup-Type-BGW_VmwareTag-VmwareTagDescription"></a>
This is a user-defined description of a VMware tag.  
Type: String  
Required: No

 ** VmwareTagName **   <a name="Backup-Type-BGW_VmwareTag-VmwareTagName"></a>
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
<a name="API_BGW_VmwareTag_SeeAlso"></a>

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
<a name="API_BGW_VmwareToAwsTagMapping"></a>

This displays the mapping of VMware tags to the corresponding AWS tags.

## Contents
<a name="API_BGW_VmwareToAwsTagMapping_Contents"></a>

 ** AwsTagKey **   <a name="Backup-Type-BGW_VmwareToAwsTagMapping-AwsTagKey"></a>
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 **   <a name="Backup-Type-BGW_VmwareToAwsTagMapping-AwsTagValue"></a>
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 **   <a name="Backup-Type-BGW_VmwareToAwsTagMapping-VmwareCategory"></a>
The is the category of VMware.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 80.  
Required: Yes

 ** VmwareTagName **   <a name="Backup-Type-BGW_VmwareToAwsTagMapping-VmwareTagName"></a>
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
<a name="API_BGW_VmwareToAwsTagMapping_SeeAlso"></a>

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
<a name="API_Types_AWS_Backup_Search"></a>

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
<a name="API_BKS_BackupCreationTimeFilter"></a>

This filters by recovery points within the CreatedAfter and CreatedBefore timestamps.

## Contents
<a name="API_BKS_BackupCreationTimeFilter_Contents"></a>

 ** CreatedAfter **   <a name="Backup-Type-BKS_BackupCreationTimeFilter-CreatedAfter"></a>
This timestamp includes recovery points only created after the specified time.  
Type: Timestamp  
Required: No

 ** CreatedBefore **   <a name="Backup-Type-BKS_BackupCreationTimeFilter-CreatedBefore"></a>
This timestamp includes recovery points only created before the specified time.  
Type: Timestamp  
Required: No

## See Also
<a name="API_BKS_BackupCreationTimeFilter_SeeAlso"></a>

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
<a name="API_BKS_CurrentSearchProgress"></a>

This contains information results retrieved from a search job that may not have completed.

## Contents
<a name="API_BKS_CurrentSearchProgress_Contents"></a>

 ** ItemsMatchedCount **   <a name="Backup-Type-BKS_CurrentSearchProgress-ItemsMatchedCount"></a>
This number is the sum of all items that match the item filters in a search job in progress.  
Type: Long  
Required: No

 ** ItemsScannedCount **   <a name="Backup-Type-BKS_CurrentSearchProgress-ItemsScannedCount"></a>
This number is the sum of all items that have been scanned so far during a search job.  
Type: Long  
Required: No

 ** RecoveryPointsScannedCount **   <a name="Backup-Type-BKS_CurrentSearchProgress-RecoveryPointsScannedCount"></a>
This number is the sum of all backups that have been scanned so far during a search job.  
Type: Integer  
Required: No

## See Also
<a name="API_BKS_CurrentSearchProgress_SeeAlso"></a>

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
<a name="API_BKS_EBSItemFilter"></a>

This contains arrays of objects, which may include CreationTimes time condition objects, FilePaths string objects, LastModificationTimes time condition objects, 

## Contents
<a name="API_BKS_EBSItemFilter_Contents"></a>

 ** CreationTimes **   <a name="Backup-Type-BKS_EBSItemFilter-CreationTimes"></a>
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 **   <a name="Backup-Type-BKS_EBSItemFilter-FilePaths"></a>
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 **   <a name="Backup-Type-BKS_EBSItemFilter-LastModificationTimes"></a>
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 **   <a name="Backup-Type-BKS_EBSItemFilter-Sizes"></a>
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
<a name="API_BKS_EBSItemFilter_SeeAlso"></a>

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
<a name="API_BKS_EBSResultItem"></a>

These are the items returned in the results of a search of Amazon EBS backup metadata.

## Contents
<a name="API_BKS_EBSResultItem_Contents"></a>

 ** BackupResourceArn **   <a name="Backup-Type-BKS_EBSResultItem-BackupResourceArn"></a>
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 **   <a name="Backup-Type-BKS_EBSResultItem-BackupVaultName"></a>
The name of the backup vault.  
Type: String  
Required: No

 ** CreationTime **   <a name="Backup-Type-BKS_EBSResultItem-CreationTime"></a>
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 **   <a name="Backup-Type-BKS_EBSResultItem-FilePath"></a>
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 **   <a name="Backup-Type-BKS_EBSResultItem-FileSize"></a>
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 **   <a name="Backup-Type-BKS_EBSResultItem-FileSystemIdentifier"></a>
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 **   <a name="Backup-Type-BKS_EBSResultItem-LastModifiedTime"></a>
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 **   <a name="Backup-Type-BKS_EBSResultItem-SourceResourceArn"></a>
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
<a name="API_BKS_EBSResultItem_SeeAlso"></a>

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
<a name="API_BKS_ExportJobSummary"></a>

This is the summary of an export job.

## Contents
<a name="API_BKS_ExportJobSummary_Contents"></a>

 ** ExportJobIdentifier **   <a name="Backup-Type-BKS_ExportJobSummary-ExportJobIdentifier"></a>
This is the unique string that identifies a specific export job.  
Type: String  
Required: Yes

 ** CompletionTime **   <a name="Backup-Type-BKS_ExportJobSummary-CompletionTime"></a>
This is a timestamp of the time the export job compeleted.  
Type: Timestamp  
Required: No

 ** CreationTime **   <a name="Backup-Type-BKS_ExportJobSummary-CreationTime"></a>
This is a timestamp of the time the export job was created.  
Type: Timestamp  
Required: No

 ** ExportJobArn **   <a name="Backup-Type-BKS_ExportJobSummary-ExportJobArn"></a>
This is the unique ARN (Amazon Resource Name) that belongs to the new export job.  
Type: String  
Required: No

 ** SearchJobArn **   <a name="Backup-Type-BKS_ExportJobSummary-SearchJobArn"></a>
The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.  
Type: String  
Required: No

 ** Status **   <a name="Backup-Type-BKS_ExportJobSummary-Status"></a>
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 name="Backup-Type-BKS_ExportJobSummary-StatusMessage"></a>
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
<a name="API_BKS_ExportJobSummary_SeeAlso"></a>

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
<a name="API_BKS_ExportSpecification"></a>

This contains the export specification object.

## Contents
<a name="API_BKS_ExportSpecification_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** s3ExportSpecification **   <a name="Backup-Type-BKS_ExportSpecification-s3ExportSpecification"></a>
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
<a name="API_BKS_ExportSpecification_SeeAlso"></a>

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
<a name="API_BKS_ItemFilters"></a>

Item Filters represent all input item properties specified when the search was created.

Contains either EBSItemFilters or S3ItemFilters

## Contents
<a name="API_BKS_ItemFilters_Contents"></a>

 ** EBSItemFilters **   <a name="Backup-Type-BKS_ItemFilters-EBSItemFilters"></a>
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 **   <a name="Backup-Type-BKS_ItemFilters-S3ItemFilters"></a>
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
<a name="API_BKS_ItemFilters_SeeAlso"></a>

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
<a name="API_BKS_LongCondition"></a>

The long condition contains a `Value` and can optionally contain an `Operator`.

## Contents
<a name="API_BKS_LongCondition_Contents"></a>

 ** Value **   <a name="Backup-Type-BKS_LongCondition-Value"></a>
The value of an item included in one of the search item filters.  
Type: Long  
Required: Yes

 ** Operator **   <a name="Backup-Type-BKS_LongCondition-Operator"></a>
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
<a name="API_BKS_LongCondition_SeeAlso"></a>

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
<a name="API_BKS_ResultItem"></a>

This is an object representing the item returned in the results of a search for a specific resource type.

## Contents
<a name="API_BKS_ResultItem_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** EBSResultItem **   <a name="Backup-Type-BKS_ResultItem-EBSResultItem"></a>
These are items returned in the search results of an Amazon EBS search.  
Type: [EBSResultItem](API_BKS_EBSResultItem.md) object  
Required: No

 ** S3ResultItem **   <a name="Backup-Type-BKS_ResultItem-S3ResultItem"></a>
These are items returned in the search results of an Amazon S3 search.  
Type: [S3ResultItem](API_BKS_S3ResultItem.md) object  
Required: No

## See Also
<a name="API_BKS_ResultItem_SeeAlso"></a>

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
<a name="API_BKS_S3ExportSpecification"></a>

This specification contains a required string of the destination bucket; optionally, you can include the destination prefix.

## Contents
<a name="API_BKS_S3ExportSpecification_Contents"></a>

 ** DestinationBucket **   <a name="Backup-Type-BKS_S3ExportSpecification-DestinationBucket"></a>
This specifies the destination Amazon S3 bucket for the export job.  
Type: String  
Required: Yes

 ** DestinationPrefix **   <a name="Backup-Type-BKS_S3ExportSpecification-DestinationPrefix"></a>
This specifies the prefix for the destination Amazon S3 bucket for the export job.  
Type: String  
Required: No

## See Also
<a name="API_BKS_S3ExportSpecification_SeeAlso"></a>

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
<a name="API_BKS_S3ItemFilter"></a>

This contains arrays of objects, which may include ObjectKeys, Sizes, CreationTimes, VersionIds, and/or Etags.

## Contents
<a name="API_BKS_S3ItemFilter_Contents"></a>

 ** CreationTimes **   <a name="Backup-Type-BKS_S3ItemFilter-CreationTimes"></a>
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 **   <a name="Backup-Type-BKS_S3ItemFilter-ETags"></a>
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 **   <a name="Backup-Type-BKS_S3ItemFilter-ObjectKeys"></a>
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 **   <a name="Backup-Type-BKS_S3ItemFilter-Sizes"></a>
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 **   <a name="Backup-Type-BKS_S3ItemFilter-VersionIds"></a>
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
<a name="API_BKS_S3ItemFilter_SeeAlso"></a>

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
<a name="API_BKS_S3ResultItem"></a>

These are the items returned in the results of a search of Amazon S3 backup metadata.

## Contents
<a name="API_BKS_S3ResultItem_Contents"></a>

 ** BackupResourceArn **   <a name="Backup-Type-BKS_S3ResultItem-BackupResourceArn"></a>
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 **   <a name="Backup-Type-BKS_S3ResultItem-BackupVaultName"></a>
The name of the backup vault.  
Type: String  
Required: No

 ** CreationTime **   <a name="Backup-Type-BKS_S3ResultItem-CreationTime"></a>
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 **   <a name="Backup-Type-BKS_S3ResultItem-ETag"></a>
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 **   <a name="Backup-Type-BKS_S3ResultItem-ObjectKey"></a>
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 **   <a name="Backup-Type-BKS_S3ResultItem-ObjectSize"></a>
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 **   <a name="Backup-Type-BKS_S3ResultItem-SourceResourceArn"></a>
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 **   <a name="Backup-Type-BKS_S3ResultItem-VersionId"></a>
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
<a name="API_BKS_S3ResultItem_SeeAlso"></a>

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
<a name="API_BKS_SearchJobBackupsResult"></a>

This contains the information about recovery points returned in results of a search job.

## Contents
<a name="API_BKS_SearchJobBackupsResult_Contents"></a>

 ** BackupCreationTime **   <a name="Backup-Type-BKS_SearchJobBackupsResult-BackupCreationTime"></a>
This is the creation time of the backup (recovery point).  
Type: Timestamp  
Required: No

 ** BackupResourceArn **   <a name="Backup-Type-BKS_SearchJobBackupsResult-BackupResourceArn"></a>
The Amazon Resource Name (ARN) that uniquely identifies the backup resources.  
Type: String  
Required: No

 ** IndexCreationTime **   <a name="Backup-Type-BKS_SearchJobBackupsResult-IndexCreationTime"></a>
This is the creation time of the backup index.  
Type: Timestamp  
Required: No

 ** ResourceType **   <a name="Backup-Type-BKS_SearchJobBackupsResult-ResourceType"></a>
This is the resource type of the search.  
Type: String  
Valid Values: `S3 | EBS`   
Required: No

 ** SourceResourceArn **   <a name="Backup-Type-BKS_SearchJobBackupsResult-SourceResourceArn"></a>
The Amazon Resource Name (ARN) that uniquely identifies the source resources.  
Type: String  
Required: No

 ** Status **   <a name="Backup-Type-BKS_SearchJobBackupsResult-Status"></a>
This is the status of the search job backup result.  
Type: String  
Valid Values: `RUNNING | COMPLETED | STOPPING | STOPPED | FAILED`   
Required: No

 ** StatusMessage **   <a name="Backup-Type-BKS_SearchJobBackupsResult-StatusMessage"></a>
This is the status message included with the results.  
Type: String  
Required: No

## See Also
<a name="API_BKS_SearchJobBackupsResult_SeeAlso"></a>

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
<a name="API_BKS_SearchJobSummary"></a>

This is information pertaining to a search job.

## Contents
<a name="API_BKS_SearchJobSummary_Contents"></a>

 ** CompletionTime **   <a name="Backup-Type-BKS_SearchJobSummary-CompletionTime"></a>
This is the completion time of the search job.  
Type: Timestamp  
Required: No

 ** CreationTime **   <a name="Backup-Type-BKS_SearchJobSummary-CreationTime"></a>
This is the creation time of the search job.  
Type: Timestamp  
Required: No

 ** Name **   <a name="Backup-Type-BKS_SearchJobSummary-Name"></a>
This is the name of the search job.  
Type: String  
Required: No

 ** SearchJobArn **   <a name="Backup-Type-BKS_SearchJobSummary-SearchJobArn"></a>
The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.  
Type: String  
Required: No

 ** SearchJobIdentifier **   <a name="Backup-Type-BKS_SearchJobSummary-SearchJobIdentifier"></a>
The unique string that specifies the search job.  
Type: String  
Required: No

 ** SearchScopeSummary **   <a name="Backup-Type-BKS_SearchJobSummary-SearchScopeSummary"></a>
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 **   <a name="Backup-Type-BKS_SearchJobSummary-Status"></a>
This is the status of the search job.  
Type: String  
Valid Values: `RUNNING | COMPLETED | STOPPING | STOPPED | FAILED`   
Required: No

 ** StatusMessage **   <a name="Backup-Type-BKS_SearchJobSummary-StatusMessage"></a>
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
<a name="API_BKS_SearchJobSummary_SeeAlso"></a>

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
<a name="API_BKS_SearchScope"></a>

The search scope is all backup properties input into a search.

## Contents
<a name="API_BKS_SearchScope_Contents"></a>

 ** BackupResourceTypes **   <a name="Backup-Type-BKS_SearchScope-BackupResourceTypes"></a>
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 **   <a name="Backup-Type-BKS_SearchScope-BackupResourceArns"></a>
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 **   <a name="Backup-Type-BKS_SearchScope-BackupResourceCreationTime"></a>
This is the time a backup resource was created.  
Type: [BackupCreationTimeFilter](API_BKS_BackupCreationTimeFilter.md) object  
Required: No

 ** BackupResourceTags **   <a name="Backup-Type-BKS_SearchScope-BackupResourceTags"></a>
These are one or more tags on the backup (recovery point).  
Type: String to string map  
Required: No

 ** SourceResourceArns **   <a name="Backup-Type-BKS_SearchScope-SourceResourceArns"></a>
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
<a name="API_BKS_SearchScope_SeeAlso"></a>

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
<a name="API_BKS_SearchScopeSummary"></a>

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
<a name="API_BKS_SearchScopeSummary_Contents"></a>

 ** TotalItemsToScanCount **   <a name="Backup-Type-BKS_SearchScopeSummary-TotalItemsToScanCount"></a>
This is the count of the total number of items that will be scanned in a search.  
Type: Long  
Required: No

 ** TotalRecoveryPointsToScanCount **   <a name="Backup-Type-BKS_SearchScopeSummary-TotalRecoveryPointsToScanCount"></a>
This is the count of the total number of backups that will be scanned in a search.  
Type: Integer  
Required: No

## See Also
<a name="API_BKS_SearchScopeSummary_SeeAlso"></a>

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
<a name="API_BKS_StringCondition"></a>

This contains the value of the string and can contain one or more operators.

## Contents
<a name="API_BKS_StringCondition_Contents"></a>

 ** Value **   <a name="Backup-Type-BKS_StringCondition-Value"></a>
The value of the string.  
Type: String  
Required: Yes

 ** Operator **   <a name="Backup-Type-BKS_StringCondition-Operator"></a>
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
<a name="API_BKS_StringCondition_SeeAlso"></a>

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 name="API_BKS_TimeCondition"></a>

A time condition denotes a creation time, last modification time, or other time.

## Contents
<a name="API_BKS_TimeCondition_Contents"></a>

 ** Value **   <a name="Backup-Type-BKS_TimeCondition-Value"></a>
This is the timestamp value of the time condition.  
Type: Timestamp  
Required: Yes

 ** Operator **   <a name="Backup-Type-BKS_TimeCondition-Operator"></a>
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
<a name="API_BKS_TimeCondition_SeeAlso"></a>

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)