Backup is a unified backup service designed to protect Amazon Web Services services and their associated data. Backup simplifies the creation, migration, restoration, and deletion of backups, while also providing reporting and auditing.
", "operations": { - "CancelLegalHold": "This action removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.
", + "CancelLegalHold": "Removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.
", "CreateBackupPlan": "Creates a backup plan using a backup plan name and backup rules. A backup plan is a document that contains information that Backup uses to schedule tasks that create recovery points for resources.
If you call CreateBackupPlan with a plan that already exists, you receive an AlreadyExistsException exception.
Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see Assigning resources programmatically.
", "CreateBackupVault": "Creates a logical container where backups are stored. A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key, and a request ID.
Do not include sensitive data, such as passport numbers, in the name of a backup vault.
Creates a framework with one or more controls. A framework is a collection of controls that you can use to evaluate your backup practices. By using pre-built customizable controls to define your policies, you can evaluate whether your backup practices comply with your policies and which resources are not yet in compliance.
", - "CreateLegalHold": "This action creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point.
", - "CreateLogicallyAirGappedBackupVault": "This request creates a logical container to where backups may be copied.
This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.
Do not include sensitive data, such as passport numbers, in the name of a backup vault.
Creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point.
", + "CreateLogicallyAirGappedBackupVault": "Creates a logical container to where backups may be copied.
This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.
Do not include sensitive data, such as passport numbers, in the name of a backup vault.
Creates a report plan. A report plan is a document that contains information about the contents of the report and where Backup will deliver it.
If you call CreateReportPlan with a plan that already exists, you receive an AlreadyExistsException exception.
This is the first of two steps to create a restore testing plan; once this request is successful, finish the procedure with request CreateRestoreTestingSelection.
You must include the parameter RestoreTestingPlan. You may optionally include CreatorRequestId and Tags.
", + "CreateRestoreTestingPlan": "Creates a restore testing plan.
The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.
", "CreateRestoreTestingSelection": "This request can be sent after CreateRestoreTestingPlan request returns successfully. This is the second part of creating a resource testing plan, and it must be completed sequentially.
This consists of RestoreTestingSelectionName, ProtectedResourceType, and one of the following:
ProtectedResourceArns
ProtectedResourceConditions
Each protected resource type can have one single value.
A restore testing selection can include a wildcard value (\"*\") for ProtectedResourceArns along with ProtectedResourceConditions. Alternatively, you can include up to 30 specific protected resource ARNs in ProtectedResourceArns.
Cannot select by both protected resource types AND specific ARNs. Request will fail if both are included.
", "DeleteBackupPlan": "Deletes a backup plan. A backup plan can only be deleted after all associated selections of resources have been deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, if any, will still exist.
", "DeleteBackupSelection": "Deletes the resource selection associated with a backup plan that is specified by the SelectionId.
Returns the Amazon Web Services resource types supported by Backup.
", "ListBackupJobSummaries": "This is a request for a summary of backup jobs created or running within the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results.
This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
", "ListBackupJobs": "Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these monitoring tools.
", - "ListBackupPlanTemplates": "Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
", + "ListBackupPlanTemplates": "Lists the backup plan templates.
", "ListBackupPlanVersions": "Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.
", - "ListBackupPlans": "Returns a list of all active backup plans for an authenticated account. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.
", + "ListBackupPlans": "Lists the active backup plans for the account.
", "ListBackupSelections": "Returns an array containing metadata of the resources associated with the target backup plan.
", "ListBackupVaults": "Returns a list of recovery point storage containers along with information about them.
", "ListCopyJobSummaries": "This request obtains a list of copy jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results.
This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
", @@ -65,7 +65,7 @@ "ListProtectedResourcesByBackupVault": "This request lists the protected resources corresponding to each backup vault.
", "ListRecoveryPointsByBackupVault": "Returns detailed information about the recovery points stored in a backup vault.
", "ListRecoveryPointsByLegalHold": "This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
", - "ListRecoveryPointsByResource": "Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN).
For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.
The information about the recovery points of the type specified by a resource Amazon Resource Name (ARN).
For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.
Returns details about your report jobs.
", "ListReportPlans": "Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan.
This request obtains a summary of restore jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, AggregationPeriod, MaxResults, or NextToken to filter results.
This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
", @@ -73,83 +73,83 @@ "ListRestoreJobsByProtectedResource": "This returns restore jobs that contain the specified protected resource.
You must include ResourceArn. You can optionally include NextToken, ByStatus, MaxResults, ByRecoveryPointCreationDateAfter , and ByRecoveryPointCreationDateBefore.
Returns a list of restore testing plans.
", "ListRestoreTestingSelections": "Returns a list of restore testing selections. Can be filtered by MaxResults and RestoreTestingPlanName.
Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
ListTags only works for resource types that support full Backup management of their backups. Those resource types are listed in the \"Full Backup management\" section of the Feature availability by resource table.
Returns the tags assigned to the resource, such as a target recovery point, backup plan, or backup vault.
", "PutBackupVaultAccessPolicy": "Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format.
", - "PutBackupVaultLockConfiguration": "Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and maximum retention period for future backup and copy jobs that target a backup vault.
Backup Vault Lock has been assessed by Cohasset Associates for use in environments that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about how Backup Vault Lock relates to these regulations, see the Cohasset Associates Compliance Assessment.
Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and maximum retention period for future backup and copy jobs that target a backup vault.
Backup Vault Lock has been assessed by Cohasset Associates for use in environments that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about how Backup Vault Lock relates to these regulations, see the Cohasset Associates Compliance Assessment.
For more information, see Backup Vault Lock.
", "PutBackupVaultNotifications": "Turns on notifications on a backup vault for the specified topic and events.
", "PutRestoreValidationResult": "This request allows you to send your independent self-run restore test validation results. RestoreJobId and ValidationStatus are required. Optionally, you can input a ValidationStatusMessage.
Starts an on-demand backup job for the specified resource.
", "StartCopyJob": "Starts a job to create a one-time copy of the specified resource.
Does not support continuous backups.
", "StartReportJob": "Starts an on-demand report job for the specified report plan.
", "StartRestoreJob": "Recovers the saved resource identified by an Amazon Resource Name (ARN).
", - "StopBackupJob": "Attempts to cancel a job to create a one-time backup of a resource.
This action is not supported for the following services: Amazon FSx for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp ONTAP , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.
", - "TagResource": "Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).
", - "UntagResource": "Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
", - "UpdateBackupPlan": "Updates an existing backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId.
Updates an existing framework identified by its FrameworkName with the input document in JSON format.
Attempts to cancel a job to create a one-time backup of a resource.
This action is not supported for the following services: Amazon FSx for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp ONTAP, Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.
", + "TagResource": "Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).
This API is supported for recovery points for resource types including Aurora, Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune, and Amazon RDS.
", + "UntagResource": "Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
This API is not supported for recovery points for resource types including Aurora, Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune, and Amazon RDS.
", + "UpdateBackupPlan": "Updates the specified backup plan. The new version is uniquely identified by its ID.
", + "UpdateFramework": "Updates the specified framework.
", "UpdateGlobalSettings": "Updates whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not an Organizations management account. Use the DescribeGlobalSettings API to determine the current settings.
Sets the transition lifecycle of a recovery point.
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
This operation does not support continuous backups.
", + "UpdateRecoveryPointLifecycle": "Sets the transition lifecycle of a recovery point.
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.
Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
If your lifecycle currently uses the parameters DeleteAfterDays and MoveToColdStorageAfterDays, include these parameters and their values when you call this operation. Not including them may result in your plan updating with null values.
This operation does not support continuous backups.
", "UpdateRegionSettings": "Updates the current service opt-in settings for the Region.
Use the DescribeRegionSettings API to determine the resource types that are supported.
Updates an existing report plan identified by its ReportPlanName with the input document in JSON format.
Updates the specified report plan.
", "UpdateRestoreTestingPlan": "This request will send changes to your specified restore testing plan. RestoreTestingPlanName cannot be updated after it is created.
RecoveryPointSelection can contain:
Algorithm
ExcludeVaults
IncludeVaults
RecoveryPointTypes
SelectionWindowDays
Most elements except the RestoreTestingSelectionName can be updated with this request.
RestoreTestingSelection can use either protected resource ARNs or conditions, but not both. That is, if your selection has ProtectedResourceArns, requesting an update with the parameter ProtectedResourceConditions will be unsuccessful.
Updates the specified restore testing selection.
Most elements except the RestoreTestingSelectionName can be updated with this request.
You can use either protected resource ARNs or conditions, but not both.
" }, "shapes": { "ARN": { "base": null, "refs": { - "BackupJob$BackupVaultArn": "An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
", "BackupPlansListMember$BackupPlanArn": "An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
A server-side encryption key you can specify to encrypt your backups from services that support full 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, Backup creates a KMS key for you by default.
To learn which Backup services support full Backup management and how Backup handles encryption for backups from services that do not yet support full Backup, see Encryption for backups in Backup
", - "CopyAction$DestinationBackupVaultArn": "An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup. For example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
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.
An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
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.
An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
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.
The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
", "CreateBackupPlanOutput$BackupPlanArn": "An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
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.
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
", - "CreateLegalHoldOutput$LegalHoldArn": "This is the ARN (Amazon Resource Number) of the created legal hold.
", - "CreateLogicallyAirGappedBackupVaultOutput$BackupVaultArn": "This is the ARN (Amazon Resource Name) of the vault being created.
", + "CreateLegalHoldOutput$LegalHoldArn": "The Amazon Resource Name (ARN) of the legal hold.
", + "CreateLogicallyAirGappedBackupVaultOutput$BackupVaultArn": "The ARN (Amazon Resource Name) of the vault.
", "CreateReportPlanOutput$ReportPlanArn": "An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
", "DeleteBackupPlanOutput$BackupPlanArn": "An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
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.
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
", - "DescribeBackupVaultOutput$BackupVaultArn": "An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
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.
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
", "DescribeProtectedResourceInput$ResourceArn": "An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
", "DescribeProtectedResourceOutput$ResourceArn": "An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
", - "DescribeProtectedResourceOutput$LastBackupVaultArn": "This is the ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point.
", - "DescribeProtectedResourceOutput$LastRecoveryPointArn": "This is the ARN (Amazon Resource Name) of the most recent recovery point.
", + "DescribeProtectedResourceOutput$LastBackupVaultArn": "The ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point.
", + "DescribeProtectedResourceOutput$LastRecoveryPointArn": "The ARN (Amazon Resource Name) of the most recent recovery point.
", "DescribeRecoveryPointInput$RecoveryPointArn": "An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies the source vault where the resource was originally backed up in; for example, arn:aws:backup:us-east-1:123456789012:vault:BackupVault. If the recovery is restored to the same Amazon Web Services account or Region, this value will be null.
An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies the source vault where the resource was originally backed up in; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault. If the recovery is restored to the same Amazon Web Services account or Region, this value will be null.
An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
", "DescribeRecoveryPointOutput$EncryptionKeyArn": "The server-side encryption key used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
This is an ARN that uniquely identifies a parent (composite) recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored. The format of the ARN depends on the resource type of the backed-up resource.
", - "DisassociateRecoveryPointFromParentInput$RecoveryPointArn": "This is the Amazon Resource Name (ARN) that uniquely identifies the child (nested) recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
The Amazon Resource Name (ARN) of the resource that was created by the restore job.
The format of the ARN depends on the resource type of the backed-up resource.
", + "DisassociateRecoveryPointFromParentInput$RecoveryPointArn": "The Amazon Resource Name (ARN) that uniquely identifies the child (nested) recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An Amazon Resource Name (ARN) that uniquely identifies an Backup recovery point.
", "Framework$FrameworkArn": "An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
", "GetBackupPlanOutput$BackupPlanArn": "An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS) topic; for example, arn:aws:sns:us-west-2:111122223333:MyTopic.
This is the returned framework ARN for the specified legal hold. An Amazon Resource Name (ARN) uniquely identifies a resource. The format of the ARN depends on the resource type.
", + "GetLegalHoldOutput$LegalHoldArn": "The framework ARN for the specified legal hold. The format of the ARN depends on the resource type.
", "GetRecoveryPointRestoreMetadataInput$RecoveryPointArn": "An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
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.
Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).
", "ListCopyJobsInput$ByResourceArn": "Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).
", "ListRecoveryPointsByBackupVaultInput$ByResourceArn": "Returns only recovery points that match the specified resource Amazon Resource Name (ARN).
", @@ -159,21 +159,21 @@ "ListRestoreJobsInput$ByRestoreTestingPlanArn": "This returns only restore testing jobs that match the specified resource Amazon Resource Name (ARN).
", "ListTagsInput$ResourceArn": "An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the type of resource. Valid targets for ListTags are recovery points, backup plans, and backup vaults.
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
", - "ProtectedResource$LastBackupVaultArn": "This is the ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point.
", - "ProtectedResource$LastRecoveryPointArn": "This is the ARN (Amazon Resource Name) of the most recent recovery point.
", + "ProtectedResource$LastBackupVaultArn": "The ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point.
", + "ProtectedResource$LastRecoveryPointArn": "The ARN (Amazon Resource Name) of the most recent recovery point.
", "PutBackupVaultNotificationsInput$SNSTopicArn": "The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.
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.
An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
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.
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
", "RecoveryPointByBackupVault$EncryptionKeyArn": "The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.
", + "RecoveryPointByBackupVault$ParentRecoveryPointArn": "The Amazon Resource Name (ARN) of the parent (composite) recovery point.
", "RecoveryPointByResource$RecoveryPointArn": "An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
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.
This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.
", + "RecoveryPointByResource$ParentRecoveryPointArn": "The Amazon Resource Name (ARN) of the parent (composite) recovery point.
", "RecoveryPointCreator$BackupPlanArn": "An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.
", - "RecoveryPointMember$ResourceArn": "This is the Amazon Resource Name (ARN) that uniquely identifies a saved resource.
", + "RecoveryPointMember$RecoveryPointArn": "The Amazon Resource Name (ARN) of the parent (composite) recovery point.
", + "RecoveryPointMember$ResourceArn": "The Amazon Resource Name (ARN) that uniquely identifies a saved resource.
", "ReportJob$ReportPlanArn": "An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
", "ReportPlan$ReportPlanArn": "An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
", "ResourceArns$member": null, @@ -184,14 +184,14 @@ "StartBackupJobInput$ResourceArn": "An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
", "StartBackupJobOutput$RecoveryPointArn": "Note: This field is only returned for Amazon EFS and Advanced DynamoDB resources.
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An ARN that uniquely identifies a recovery point to use for the copy job; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
", - "StartCopyJobInput$DestinationBackupVaultArn": "An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to copy to; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to copy to; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.
", - "UntagResourceInput$ResourceArn": "An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.
", + "TagResourceInput$ResourceArn": "An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.
ARNs that do not include backup are incompatible with tagging. TagResource and UntagResource with invalid ARNs will result in an error. Acceptable ARN content can include arn:aws:backup:us-east. Invalid ARN content may look like arn:aws:ec2:us-east.
An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.
ARNs that do not include backup are incompatible with tagging. TagResource and UntagResource with invalid ARNs will result in an error. Acceptable ARN content can include arn:aws:backup:us-east. Invalid ARN content may look like arn:aws:ec2:us-east.
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.
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
", "UpdateRecoveryPointLifecycleInput$RecoveryPointArn": "An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
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.
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
" } @@ -204,14 +204,14 @@ "CopyJob$AccountId": "The account ID that owns the copy job.
", "CopyJobSummary$AccountId": "The account ID that owns the jobs within the summary.
", "DescribeBackupJobOutput$AccountId": "Returns the account ID that owns the backup job.
", - "DescribeRecoveryPointInput$BackupVaultAccountId": "This is the account ID of the specified backup vault.
", + "DescribeRecoveryPointInput$BackupVaultAccountId": "The account ID of the specified backup vault.
", "DescribeRestoreJobOutput$AccountId": "Returns the account ID that owns the restore job.
", - "GetRecoveryPointRestoreMetadataInput$BackupVaultAccountId": "This is the account ID of the specified backup vault.
", + "GetRecoveryPointRestoreMetadataInput$BackupVaultAccountId": "The account ID of the specified backup vault.
", "ListBackupJobSummariesInput$AccountId": "Returns the job count for the specified account.
If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.
Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.
AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.
The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.
If used from an Organizations management account, passing * returns all jobs across the organization.
Returns the job count for the specified account.
If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.
Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.
AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.
The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.
", - "ListProtectedResourcesByBackupVaultInput$BackupVaultAccountId": "This is the list of protected resources by backup vault within the vault(s) you specify by account ID.
", + "ListProtectedResourcesByBackupVaultInput$BackupVaultAccountId": "The list of protected resources by backup vault within the vault(s) you specify by account ID.
", "ListRecoveryPointsByBackupVaultInput$BackupVaultAccountId": "This parameter will sort the list of recovery points by account ID.
", "ListRestoreJobSummariesInput$AccountId": "Returns the job count for the specified account.
If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.
Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.
AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.
The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.
", @@ -220,7 +220,7 @@ } }, "AdvancedBackupSetting": { - "base": "A list of backup options for each resource type.
", + "base": "The backup options for each resource type.
", "refs": { "AdvancedBackupSettings$member": null } @@ -231,7 +231,7 @@ "BackupPlan$AdvancedBackupSettings": "Contains a list of BackupOptions for each resource type.
Specifies a list of BackupOptions for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
Contains a list of BackupOptions for a resource type.
A list of BackupOptions settings for a resource type. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
The settings for a resource type. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
", "GetBackupPlanOutput$AdvancedBackupSettings": "Contains a list of BackupOptions for each resource type. The list is populated only if the advanced option is set for the backup plan.
Contains a list of BackupOptions for each resource type.
This is the period that sets the boundaries for returned results.
Acceptable values include
ONE_DAY for daily job count for the prior 14 days.
SEVEN_DAYS for the aggregated job count for the prior 7 days.
FOURTEEN_DAYS for aggregated job count for prior 14 days.
This is the period that sets the boundaries for returned results.
ONE_DAY for daily job count for the prior 14 days.
SEVEN_DAYS for the aggregated job count for the prior 7 days.
FOURTEEN_DAYS for aggregated job count for prior 14 days.
This is the period that sets the boundaries for returned results.
Acceptable values include
ONE_DAY for daily job count for the prior 14 days.
SEVEN_DAYS for the aggregated job count for the prior 7 days.
FOURTEEN_DAYS for aggregated job count for prior 14 days.
The period for the returned results.
ONE_DAY - The daily job count for the prior 14 days.
SEVEN_DAYS - The aggregated job count for the prior 7 days.
FOURTEEN_DAYS - The aggregated job count for prior 14 days.
The period for the returned results.
ONE_DAY - The daily job count for the prior 14 days.
SEVEN_DAYS - The aggregated job count for the prior 7 days.
FOURTEEN_DAYS - The aggregated job count for prior 14 days.
The period for the returned results.
ONE_DAY - The daily job count for the prior 14 days.
SEVEN_DAYS - The aggregated job count for the prior 7 days.
FOURTEEN_DAYS - The aggregated job count for prior 14 days.
This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
" + "ListBackupJobSummariesOutput$BackupJobSummaries": "The summary information.
" } }, "BackupJobsList": { @@ -313,7 +313,7 @@ "AdvancedBackupSetting$BackupOptions": "Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.
Valid values:
Set to \"WindowsVSS\":\"enabled\" to enable the WindowsVSS backup option and create a Windows VSS backup.
Set to \"WindowsVSS\":\"disabled\" to create a regular backup. The WindowsVSS option is not enabled by default.
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.
", "BackupJob$BackupOptions": "Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
Valid values: Set to \"WindowsVSS\":\"enabled\" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to \"WindowsVSS\":\"disabled\" to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.
Represents the options specified as part of backup plan or on-demand backup job.
", - "StartBackupJobInput$BackupOptions": "Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
Valid values: Set to \"WindowsVSS\":\"enabled\" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to \"WindowsVSS\"\"disabled\" to create a regular backup. The WindowsVSS option is not enabled by default.
The backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
Valid values: Set to \"WindowsVSS\":\"enabled\" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to \"WindowsVSS\"\"disabled\" to create a regular backup. The WindowsVSS option is not enabled by default.
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.
Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
The body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
The body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.
", + "BackupPlan$BackupPlanName": "The display name of a backup plan. Must contain only alphanumeric or '-_.' 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.
", "BackupPlanInput$BackupPlanName": "The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.
", "BackupPlansListMember$BackupPlanName": "The display name of a saved backup plan.
" } @@ -360,7 +360,7 @@ "BackupPlansList": { "base": null, "refs": { - "ListBackupPlansOutput$BackupPlansList": "An array of backup plan list items containing metadata about your saved backup plans.
" + "ListBackupPlansOutput$BackupPlansList": "Information about the backup plans.
" } }, "BackupPlansListMember": { @@ -402,9 +402,9 @@ } }, "BackupSelection": { - "base": "Used to specify a set of resources to a backup plan.
Specifying your desired Conditions, ListOfTags, NotResources, and/or Resources is recommended. If none of these are specified, Backup will attempt to select all supported and opted-in storage resources, which could have unintended cost implications.
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.
", "refs": { - "CreateBackupSelectionInput$BackupSelection": "Specifies the body of a request to assign a set of resources to a backup plan.
", + "CreateBackupSelectionInput$BackupSelection": "The body of a request to assign a set of resources to a backup plan.
", "GetBackupSelectionOutput$BackupSelection": "Specifies the body of a request to assign a set of resources to a backup plan.
" } }, @@ -437,7 +437,7 @@ "base": null, "refs": { "GetBackupVaultNotificationsOutput$BackupVaultEvents": "An array of events that indicate the status of jobs to back up resources to the backup vault.
", - "PutBackupVaultNotificationsInput$BackupVaultEvents": "An array of events that indicate the status of jobs to back up resources to the backup vault.
For common use cases and code samples, see Using Amazon SNS to track Backup events.
The following events are supported:
BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED
COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED
RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RECOVERY_POINT_MODIFIED
S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED
The list below shows items that are deprecated events (for reference) and are no longer in use. They are no longer supported and will not return statuses or notifications. Refer to the list above for current supported events.
An array of events that indicate the status of jobs to back up resources to the backup vault.
For common use cases and code samples, see Using Amazon SNS to track Backup events.
The following events are supported:
BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED
COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED
RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RECOVERY_POINT_MODIFIED
S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED
The list below includes both supported events and deprecated events that are no longer in use (for reference). Deprecated events do not return statuses or notifications. Refer to the list above for the supported events.
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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", - "BackupRule$TargetBackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", - "BackupRuleInput$TargetBackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", - "BackupVaultListMember$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", + "BackupJob$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
", + "BackupRule$TargetBackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
", + "BackupRuleInput$TargetBackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
", + "BackupVaultListMember$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
", "CreateBackupVaultInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.
", "CreateBackupVaultOutput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", - "CreateLogicallyAirGappedBackupVaultInput$BackupVaultName": "This is the name of the vault that is being created.
", - "CreateLogicallyAirGappedBackupVaultOutput$BackupVaultName": "The name of a logical container where backups are stored. Logically air-gapped backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", + "CreateLogicallyAirGappedBackupVaultInput$BackupVaultName": "The name of a logical container where backups are stored. Logically air-gapped backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
", + "CreateLogicallyAirGappedBackupVaultOutput$BackupVaultName": "The name of a logical container where backups are stored. Logically air-gapped backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
", "DeleteBackupVaultAccessPolicyInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "DeleteBackupVaultLockConfigurationInput$BackupVaultName": "The name of the backup vault from which to delete Backup Vault Lock.
", - "DeleteBackupVaultNotificationsInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", - "DeleteRecoveryPointInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", - "DescribeBackupJobOutput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", - "DescribeRecoveryPointInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", - "DescribeRecoveryPointOutput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", - "DisassociateRecoveryPointFromParentInput$BackupVaultName": "This is the name of a logical container where the child (nested) recovery point is stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", + "DeleteBackupVaultNotificationsInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
", + "DeleteRecoveryPointInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
", + "DescribeBackupJobOutput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
", + "DescribeRecoveryPointInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
", + "DescribeRecoveryPointOutput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
", + "DisassociateRecoveryPointFromParentInput$BackupVaultName": "The name of a logical container where the child (nested) recovery point is stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
", "DisassociateRecoveryPointInput$BackupVaultName": "The unique name of an Backup vault.
", - "GetBackupVaultAccessPolicyInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", - "GetBackupVaultAccessPolicyOutput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", - "GetBackupVaultNotificationsInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", - "GetBackupVaultNotificationsOutput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", - "GetRecoveryPointRestoreMetadataInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", - "ListBackupJobsInput$ByBackupVaultName": "Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", - "ListProtectedResourcesByBackupVaultInput$BackupVaultName": "This is the list of protected resources by backup vault within the vault(s) you specify by name.
", - "ListRecoveryPointsByBackupVaultInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
Backup vault name might not be available when a supported service creates the backup.
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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", + "GetBackupVaultAccessPolicyInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
", + "GetBackupVaultAccessPolicyOutput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
", + "GetBackupVaultNotificationsInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
", + "GetBackupVaultNotificationsOutput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
", + "GetRecoveryPointRestoreMetadataInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
", + "ListBackupJobsInput$ByBackupVaultName": "Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
", + "ListProtectedResourcesByBackupVaultInput$BackupVaultName": "The list of protected resources by backup vault within the vault(s) you specify by name.
", + "ListRecoveryPointsByBackupVaultInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
Backup vault name might not be available when a supported service creates the backup.
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 Amazon Web Services Region where they are created.
", "PutBackupVaultLockConfigurationInput$BackupVaultName": "The Backup Vault Lock configuration that specifies the name of the backup vault it protects.
", - "PutBackupVaultNotificationsInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", - "RecoveryPointByBackupVault$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", - "RecoveryPointByResource$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", - "RecoveryPointMember$BackupVaultName": "This is the name of the backup vault (the logical container in which backups are stored).
", - "StartBackupJobInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", - "StartCopyJobInput$SourceBackupVaultName": "The name of a logical source container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", - "UpdateRecoveryPointLifecycleInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
" + "PutBackupVaultNotificationsInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
", + "RecoveryPointByBackupVault$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
", + "RecoveryPointByResource$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
", + "RecoveryPointMember$BackupVaultName": "The name of the backup vault (the logical container in which backups are stored).
", + "StartBackupJobInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
", + "StartCopyJobInput$SourceBackupVaultName": "The name of a logical source container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
", + "UpdateRecoveryPointLifecycleInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
" } }, "Boolean": { @@ -498,12 +498,12 @@ "BackupRuleInput$EnableContinuousBackup": "Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.
", "BackupVaultListMember$Locked": "A Boolean value that indicates whether 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.
A Boolean that indicates whether Backup Vault Lock is currently protecting the backup vault. True means that Vault Lock causes delete or update operations on the recovery points stored in the vault to fail.
Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
", + "Lifecycle$OptInToArchiveForSupportedResources": "If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
", "ListBackupPlansInput$IncludeDeleted": "A Boolean value with a default value of FALSE that returns deleted backup plans when set to TRUE.
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. 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 are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
", + "base": "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. 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 table. Backup ignores this expression for other resource types.
", "refs": { "DescribeRecoveryPointOutput$CalculatedLifecycle": "A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.
A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.
Includes information about tags you define to assign tagged resources to a backup plan.
", + "base": "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\".
Contains information about which resources to include or exclude from a backup plan using their tags. Conditions are case sensitive.
", "refs": { - "BackupSelection$Conditions": "A list of conditions that you define to assign resources to your backup plans using tags. For example, \"StringEquals\": { \"Key\": \"aws:ResourceTag/CreatedByCryo\", \"Value\": \"true\" },. Condition operators are case sensitive.
Conditions differs from ListOfTags as follows:
When you specify more than one condition, you only assign the resources that match ALL conditions (using AND logic).
Conditions supports StringEquals, StringLike, StringNotEquals, and StringNotLike. ListOfTags only supports StringEquals.
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).
" } }, "ConflictException": { @@ -579,7 +579,7 @@ } }, "ControlInputParameter": { - "base": "A list of 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.
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.
A list of ParameterName and ParameterValue pairs.
The name/value pairs.
" } }, "ControlName": { @@ -962,7 +962,7 @@ "FormatList": { "base": null, "refs": { - "ReportDeliveryChannel$Formats": "A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.
The format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.
A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
", - "DescribeFrameworkOutput$FrameworkControls": "A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
", - "UpdateFrameworkInput$FrameworkControls": "A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
" + "CreateFrameworkInput$FrameworkControls": "The controls that make up the framework. Each control in the list has a name, input parameters, and scope.
", + "DescribeFrameworkOutput$FrameworkControls": "The controls that make up the framework. Each control in the list has a name, input parameters, and scope.
", + "UpdateFrameworkInput$FrameworkControls": "The controls that make up the framework. Each control in the list has a name, input parameters, and scope.
" } }, "FrameworkDescription": { @@ -997,7 +997,7 @@ "FrameworkList": { "base": null, "refs": { - "ListFrameworksOutput$Frameworks": "A list of frameworks with details for each framework, including the framework name, Amazon Resource Name (ARN), description, number of controls, creation time, and deployment status.
" + "ListFrameworksOutput$Frameworks": "The frameworks with details for each framework, including the framework name, Amazon Resource Name (ARN), description, number of controls, creation time, and deployment status.
" } }, "FrameworkName": { @@ -1175,7 +1175,7 @@ "DescribeRecoveryPointOutput$IamRoleArn": "Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
The IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access.
This displays the status of the legal hold returned after creating the legal hold. Statuses can be ACTIVE, PENDING, CANCELED, CANCELING, or FAILED.
This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.
This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.
The status of the legal hold.
", + "GetLegalHoldOutput$Status": "The status of the legal hold.
", + "LegalHold$Status": "The status of the legal hold.
" } }, "LegalHoldsList": { @@ -1237,17 +1237,17 @@ } }, "Lifecycle": { - "base": "Contains an array of Transition objects specifying how long 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 cannot be changed after a backup has been transitioned to cold.
Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
", + "base": "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 table. 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.
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
", - "BackupRuleInput$Lifecycle": "The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
This parameter has a maximum value of 100 years (36,500 days).
", + "BackupRule$Lifecycle": "The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 table. Backup ignores this expression for other resource types.
", + "BackupRuleInput$Lifecycle": "The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 table. Backup ignores this expression for other resource types.
This parameter has a maximum value of 100 years (36,500 days).
", "CopyAction$Lifecycle": null, - "DescribeRecoveryPointOutput$Lifecycle": "The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.
Backups that are transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
", - "RecoveryPointByBackupVault$Lifecycle": "The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
", - "StartBackupJobInput$Lifecycle": "The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
This parameter has a maximum value of 100 years (36,500 days).
", + "DescribeRecoveryPointOutput$Lifecycle": "The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.
Backups that are transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.
", + "RecoveryPointByBackupVault$Lifecycle": "The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 table. Backup ignores this expression for other resource types.
", + "StartBackupJobInput$Lifecycle": "The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.
This parameter has a maximum value of 100 years (36,500 days).
", "StartCopyJobInput$Lifecycle": null, "UpdateRecoveryPointLifecycleInput$Lifecycle": "The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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.
", - "UpdateRecoveryPointLifecycleOutput$Lifecycle": "The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
" + "UpdateRecoveryPointLifecycleOutput$Lifecycle": "The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 table. Backup ignores this expression for other resource types.
" } }, "LimitExceededException": { @@ -1368,7 +1368,7 @@ "ListOfTags": { "base": null, "refs": { - "BackupSelection$ListOfTags": "A list of conditions that you define to assign resources to your backup plans using tags. For example, \"StringEquals\": { \"Key\": \"aws:ResourceTag/CreatedByCryo\", \"Value\": \"true\" },. Condition operators are case sensitive.
ListOfTags differs from Conditions as follows:
When you specify more than one condition, you assign all resources that match AT LEAST ONE condition (using OR logic).
ListOfTags only supports StringEquals. Conditions supports StringEquals, StringLike, StringNotEquals, and StringNotLike.
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).
" } }, "ListProtectedResourcesByBackupVaultInput": { @@ -1521,24 +1521,24 @@ "BackupJobChildJobsInState$value": null, "BackupVaultListMember$MinRetentionDays": "The 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.
", "BackupVaultListMember$MaxRetentionDays": "The 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.
", - "CancelLegalHoldInput$RetainRecordInDays": "The integer amount in days specifying amount of days after this API operation to remove legal hold.
", + "CancelLegalHoldInput$RetainRecordInDays": "The integer amount, in days, after which to remove legal hold.
", "CopyJob$BackupSizeInBytes": "The size, in bytes, of a copy job.
", - "CopyJob$NumberOfChildJobs": "This is the number of child (nested) copy jobs.
", + "CopyJob$NumberOfChildJobs": "The number of child (nested) copy jobs.
", "CopyJobChildJobsInState$value": null, - "CreateLogicallyAirGappedBackupVaultInput$MinRetentionDays": "This setting specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, no minimum retention period is enforced.
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 a job 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.
", - "CreateLogicallyAirGappedBackupVaultInput$MaxRetentionDays": "This is the setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Backup 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 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.
", + "CreateLogicallyAirGappedBackupVaultInput$MinRetentionDays": "This setting specifies the minimum retention period that the vault retains its recovery points.
The minimum value accepted is 7 days.
", + "CreateLogicallyAirGappedBackupVaultInput$MaxRetentionDays": "The maximum retention period that the vault retains its recovery points.
", "DescribeBackupJobOutput$BackupSizeInBytes": "The size, in bytes, of a backup.
", "DescribeBackupJobOutput$BytesTransferred": "The size in bytes transferred to a backup vault at the time that the job status was queried.
", "DescribeBackupJobOutput$NumberOfChildJobs": "This returns the number of child (nested) backup jobs.
", - "DescribeBackupVaultOutput$MinRetentionDays": "The 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.
", + "DescribeBackupVaultOutput$MinRetentionDays": "The Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock will not enforce a minimum retention period.
If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.
", "DescribeBackupVaultOutput$MaxRetentionDays": "The 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.
", - "DescribeProtectedResourceOutput$LatestRestoreExecutionTimeMinutes": "This is the time in minutes the most recent restore job took to complete.
", + "DescribeProtectedResourceOutput$LatestRestoreExecutionTimeMinutes": "The time, in minutes, that the most recent restore job took to complete.
", "DescribeRecoveryPointOutput$BackupSizeInBytes": "The size, in bytes, of a backup.
", "DescribeRestoreJobOutput$BackupSizeInBytes": "The size, in bytes, of the restored resource.
", "DescribeRestoreJobOutput$ExpectedCompletionTimeMinutes": "The amount of time in minutes that a job restoring a recovery point is expected to take.
", - "Lifecycle$MoveToColdStorageAfterDays": "Specifies the number of days after creation that a recovery point is moved to cold storage.
", - "Lifecycle$DeleteAfterDays": "Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.
The Backup Vault Lock configuration that specifies the minimum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to retain certain data for at least seven years (2555 days).
If this parameter is not specified, Vault Lock will not enforce a minimum retention period.
If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails that backup or copy job, and you should either modify your lifecycle settings or use a different vault. The shortest minimum retention period you can specify is 1 day. Recovery points already saved in the vault prior to Vault Lock are not affected.
", + "Lifecycle$MoveToColdStorageAfterDays": "The number of days after creation that a recovery point is moved to cold storage.
", + "Lifecycle$DeleteAfterDays": "The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in MoveToColdStorageAfterDays.
The Backup Vault Lock configuration that specifies the minimum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to retain certain data for at least seven years (2555 days).
This parameter is required when a vault lock is created through CloudFormation; otherwise, this parameter is optional. If this parameter is not specified, Vault Lock will not enforce a minimum retention period.
If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails that backup or copy job, and you should either modify your lifecycle settings or use a different vault. The shortest minimum retention period you can specify is 1 day. Recovery points already saved in the vault prior to Vault Lock are not affected.
", "PutBackupVaultLockConfigurationInput$MaxRetentionDays": "The Backup Vault Lock configuration that specifies the maximum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to destroy certain data after retaining it for four years (1460 days).
If this parameter is not included, Vault Lock does not enforce a maximum retention period on the recovery points in the vault. If this parameter is included without a value, Vault Lock will not enforce a maximum retention period.
If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. The longest maximum retention period you can specify is 36500 days (approximately 100 years). Recovery points already saved in the vault prior to Vault Lock are not affected.
", "PutBackupVaultLockConfigurationInput$ChangeableForDays": "The Backup Vault Lock configuration that specifies the number of days before the lock date. For example, setting ChangeableForDays to 30 on Jan. 1, 2022 at 8pm UTC will set the lock date to Jan. 31, 2022 at 8pm UTC.
Backup enforces a 72-hour cooling-off period before Vault Lock takes effect and becomes immutable. Therefore, you must set ChangeableForDays to 3 or greater.
Before the lock date, you can delete Vault Lock from the vault using DeleteBackupVaultLockConfiguration or change the Vault Lock configuration using PutBackupVaultLockConfiguration. On and after the lock date, the Vault Lock becomes immutable and cannot be changed or deleted.
If this parameter is not specified, you can delete Vault Lock from the vault using DeleteBackupVaultLockConfiguration or change the Vault Lock configuration using PutBackupVaultLockConfiguration at any time.
The size, in bytes, of a backup.
", @@ -1556,9 +1556,9 @@ "MaxResults": { "base": null, "refs": { - "ListBackupJobSummariesInput$MaxResults": "This parameter sets the maximum number of items to be returned.
The value is an integer. Range of accepted values is from 1 to 500.
", + "ListBackupJobSummariesInput$MaxResults": "The maximum number of items to be returned.
The value is an integer. Range of accepted values is from 1 to 500.
", "ListBackupJobsInput$MaxResults": "The maximum number of items to be returned.
", - "ListBackupPlanTemplatesInput$MaxResults": "The maximum number of items to be returned.
", + "ListBackupPlanTemplatesInput$MaxResults": "The maximum number of items to return.
", "ListBackupPlanVersionsInput$MaxResults": "The maximum number of items to be returned.
", "ListBackupPlansInput$MaxResults": "The maximum number of items to be returned.
", "ListBackupSelectionsInput$MaxResults": "The maximum number of items to be returned.
", @@ -1569,7 +1569,7 @@ "ListProtectedResourcesByBackupVaultInput$MaxResults": "The maximum number of items to be returned.
", "ListProtectedResourcesInput$MaxResults": "The maximum number of items to be returned.
", "ListRecoveryPointsByBackupVaultInput$MaxResults": "The maximum number of items to be returned.
", - "ListRecoveryPointsByLegalHoldInput$MaxResults": "This is the maximum number of resource list items to be returned.
", + "ListRecoveryPointsByLegalHoldInput$MaxResults": "The maximum number of resource list items to be returned.
", "ListRecoveryPointsByResourceInput$MaxResults": "The maximum number of items to be returned.
Amazon RDS requires a value of at least 20.
The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.
", "ListReportPlansInput$MaxResults": "The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.
", @@ -1593,7 +1593,7 @@ "refs": { "GetRecoveryPointRestoreMetadataOutput$RestoreMetadata": "The set of metadata key-value pairs that describe the original configuration of the backed-up resource. These values vary depending on the service that is being restored.
", "GetRestoreJobMetadataOutput$Metadata": "This contains the metadata of the specified backup job.
", - "StartRestoreJobInput$Metadata": "A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.
You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.
You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:
file-system-id: The ID of the Amazon EFS file system that is backed up by Backup. Returned in GetRecoveryPointRestoreMetadata.
Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.
KmsKeyId: Specifies the Amazon Web Services KMS key that is used to encrypt the restored file system. You can specify a key from another Amazon Web Services account provided that key it is properly shared with your account via Amazon Web Services KMS.
PerformanceMode: Specifies the throughput mode of the file system.
CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.
newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.
ItemsToRestore: An array of one to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional. For example, \"itemsToRestore\":\"[\\\"/my.test\\\"]\".
A set of metadata key-value pairs.
You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.
For more information about the metadata for each resource, see the following:
A list of conditions that you define for resources in your restore testing plan using tags.
For example, \"StringEquals\": { \"Key\": \"aws:ResourceTag/CreatedByCryo\", \"Value\": \"true\" },. Condition operators are case sensitive.
The conditions that you define for resources in your restore testing plan using tags.
", "refs": { "RestoreTestingSelectionForCreate$ProtectedResourceConditions": "If you have included the wildcard in ProtectedResourceArns, you can include resource conditions, such as ProtectedResourceConditions: { StringEquals: [{ key: \"XXXX\", value: \"YYYY\" }].
In a resource testing selection, this parameter filters by specific conditions such as StringEquals or StringNotEquals.
A list of conditions that you define for resources in your restore testing plan using tags.
For example, \"StringEquals\": { \"Key\": \"aws:ResourceTag/CreatedByCryo\", \"Value\": \"true\" },. Condition operators are case sensitive.
The conditions that you define for resources in your restore testing plan using tags.
" } }, "ProtectedResourcesList": { @@ -1709,15 +1709,15 @@ "RecoveryPointSelection": { "base": "This specifies criteria to assign a set of resources, such as resource types or backup vaults.
", "refs": { - "CreateLegalHoldInput$RecoveryPointSelection": "This specifies criteria to assign a set of resources, such as resource types or backup vaults.
", - "CreateLegalHoldOutput$RecoveryPointSelection": "This specifies criteria to assign a set of resources, such as resource types or backup vaults.
", - "GetLegalHoldOutput$RecoveryPointSelection": "This specifies criteria to assign a set of resources, such as resource types or backup vaults.
" + "CreateLegalHoldInput$RecoveryPointSelection": "The criteria to assign a set of resources, such as resource types or backup vaults.
", + "CreateLegalHoldOutput$RecoveryPointSelection": "The criteria to assign to a set of resources, such as resource types or backup vaults.
", + "GetLegalHoldOutput$RecoveryPointSelection": "The criteria to assign a set of resources, such as resource types or backup vaults.
" } }, "RecoveryPointStatus": { "base": null, "refs": { - "DescribeRecoveryPointOutput$Status": "A status code specifying the state of the recovery point.
PARTIAL status indicates Backup could not create the recovery point before the backup window closed. To increase your backup plan window using the API, see UpdateBackupPlan. You can also increase your backup plan window using the Console by choosing and editing your backup plan.
EXPIRED status indicates that the recovery point has exceeded its retention period, but Backup lacks permission or is otherwise unable to delete it. To manually delete these recovery points, see Step 3: Delete the recovery points in the Clean up resources section of Getting started.
STOPPED status occurs on a continuous backup where a user has taken some action that causes the continuous backup to be disabled. This can be caused by the removal of permissions, turning off versioning, turning off events being sent to EventBridge, or disabling the EventBridge rules that are put in place by Backup.
To resolve STOPPED status, ensure that all requested permissions are in place and that versioning is enabled on the S3 bucket. Once these conditions are met, the next instance of a backup rule running will result in a new continuous recovery point being created. The recovery points with STOPPED status do not need to be deleted.
For SAP HANA on Amazon EC2 STOPPED status occurs due to user action, application misconfiguration, or backup failure. To ensure that future continuous backups succeed, refer to the recovery point status and check SAP HANA for details.
A status code specifying the state of the recovery point.
PARTIAL status indicates Backup could not create the recovery point before the backup window closed. To increase your backup plan window using the API, see UpdateBackupPlan. You can also increase your backup plan window using the Console by choosing and editing your backup plan.
EXPIRED status indicates that the recovery point has exceeded its retention period, but Backup lacks permission or is otherwise unable to delete it. To manually delete these recovery points, see Step 3: Delete the recovery points in the Clean up resources section of Getting started.
STOPPED status occurs on a continuous backup where a user has taken some action that causes the continuous backup to be disabled. This can be caused by the removal of permissions, turning off versioning, turning off events being sent to EventBridge, or disabling the EventBridge rules that are put in place by Backup. For recovery points of Amazon S3, Amazon RDS, and Amazon Aurora resources, this status occurs when the retention period of a continuous backup rule is changed.
To resolve STOPPED status, ensure that all requested permissions are in place and that versioning is enabled on the S3 bucket. Once these conditions are met, the next instance of a backup rule running will result in a new continuous recovery point being created. The recovery points with STOPPED status do not need to be deleted.
For SAP HANA on Amazon EC2 STOPPED status occurs due to user action, application misconfiguration, or backup failure. To ensure that future continuous backups succeed, refer to the recovery point status and check SAP HANA for details.
A status code specifying the state of the recovery point.
", "RecoveryPointByResource$Status": "A status code specifying the state of the recovery point.
" } @@ -1725,14 +1725,14 @@ "RecoveryPointsList": { "base": null, "refs": { - "ListRecoveryPointsByLegalHoldOutput$RecoveryPoints": "This is a list of the recovery points returned by ListRecoveryPointsByLegalHold.
The recovery points.
" } }, "Region": { "base": null, "refs": { "BackupJobSummary$Region": "The Amazon Web Services Regions within the job summary.
", - "CopyJobSummary$Region": "This is the Amazon Web Services Regions within the job summary.
", + "CopyJobSummary$Region": "The Amazon Web Services Regions within the job summary.
", "RestoreJobSummary$Region": "The Amazon Web Services Regions within the job summary.
" } }, @@ -1741,7 +1741,7 @@ "refs": { "CreateReportPlanInput$ReportDeliveryChannel": "A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
", "ReportPlan$ReportDeliveryChannel": "Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
", - "UpdateReportPlanInput$ReportDeliveryChannel": "A structure that contains information about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
" + "UpdateReportPlanInput$ReportDeliveryChannel": "The information about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
" } }, "ReportDestination": { @@ -1753,7 +1753,7 @@ "ReportJob": { "base": "Contains detailed information about a report job. A report job compiles a report based on a report plan and publishes it to Amazon S3.
", "refs": { - "DescribeReportJobOutput$ReportJob": "A list of information about a report job, including its completion and creation times, report destination, unique report job ID, Amazon Resource Name (ARN), report template, status, and status message.
", + "DescribeReportJobOutput$ReportJob": "The information about a report job, including its completion and creation times, report destination, unique report job ID, Amazon Resource Name (ARN), report template, status, and status message.
", "ReportJobList$member": null } }, @@ -1789,7 +1789,7 @@ "ReportPlanList": { "base": null, "refs": { - "ListReportPlansOutput$ReportPlans": "A list of your report plans with detailed information for each plan. This information includes the Amazon Resource Name (ARN), report plan name, description, settings, delivery channel, deployment status, creation time, and last times the report plan attempted to and successfully ran.
" + "ListReportPlansOutput$ReportPlans": "The report plans with detailed information for each plan. This information includes the Amazon Resource Name (ARN), report plan name, description, settings, delivery channel, deployment status, creation time, and last times the report plan attempted to and successfully ran.
" } }, "ReportPlanName": { @@ -1811,14 +1811,14 @@ "refs": { "CreateReportPlanInput$ReportSetting": "Identifies the report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.
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 Amazon Web Services Regions and frameworks.
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 Amazon Web Services Regions and frameworks.
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 Amazon Web Services Regions and frameworks.
A list of Amazon Resource Names (ARNs) 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.
", - "BackupSelection$NotResources": "A list of Amazon Resource Names (ARNs) 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.
" + "BackupSelection$Resources": "The Amazon Resource Names (ARNs) of the resources to assign to a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.
If you need to assign many resources to a backup plan, consider a different resource selection strategy, such as assigning all resources of a resource type or refining your resource selection using tags.
If you specify multiple ARNs, the resources much match any of the ARNs (OR logic).
", + "BackupSelection$NotResources": "The Amazon Resource Names (ARNs) of the resources to exclude from a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.
If you need to exclude many resources from a backup plan, consider a different resource selection strategy, such as assigning only one or a few resource types or refining your resource selection using tags.
" } }, "ResourceIdentifiers": { @@ -1844,23 +1844,23 @@ "DescribeProtectedResourceOutput$ResourceType": "The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon EBS volume or an Amazon RDS database.
", "DescribeRecoveryPointOutput$ResourceType": "The type of Amazon Web Services resource to save as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
", "DescribeRestoreJobOutput$ResourceType": "Returns metadata associated with a restore job listed by resource type.
", - "GetRecoveryPointRestoreMetadataOutput$ResourceType": "This is the resource type associated with the recovery point.
", + "GetRecoveryPointRestoreMetadataOutput$ResourceType": "The resource type of the recovery point.
", "ListBackupJobSummariesInput$ResourceType": "Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.
The the value ANY returns count of all resource types.
AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.
The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
", - "ListBackupJobsInput$ByResourceType": "Returns only backup jobs for the specified resources:
Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
Redshift for Amazon Redshift
RDS for Amazon Relational Database Service
SAP HANA on Amazon EC2 for SAP HANA databases
Storage Gateway for Storage Gateway
S3 for Amazon S3
Timestream for Amazon Timestream
VirtualMachine for virtual machines
Returns only backup jobs for the specified resources:
Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
RDS for Amazon Relational Database Service
Redshift for Amazon Redshift
S3 for Amazon Simple Storage Service (Amazon S3)
SAP HANA on Amazon EC2 for SAP HANA databases on Amazon Elastic Compute Cloud instances
Storage Gateway for Storage Gateway
Timestream for Amazon Timestream
VirtualMachine for VMware virtual machines
Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.
The the value ANY returns count of all resource types.
AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.
The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
", - "ListCopyJobsInput$ByResourceType": "Returns only backup jobs for the specified resources:
Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
Redshift for Amazon Redshift
RDS for Amazon Relational Database Service
SAP HANA on Amazon EC2 for SAP HANA databases
Storage Gateway for Storage Gateway
S3 for Amazon S3
Timestream for Amazon Timestream
VirtualMachine for virtual machines
Returns only recovery points that match the specified resource type(s):
Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
Redshift for Amazon Redshift
RDS for Amazon Relational Database Service
SAP HANA on Amazon EC2 for SAP HANA databases
Storage Gateway for Storage Gateway
S3 for Amazon S3
Timestream for Amazon Timestream
VirtualMachine for virtual machines
Returns only backup jobs for the specified resources:
Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
RDS for Amazon Relational Database Service
Redshift for Amazon Redshift
S3 for Amazon Simple Storage Service (Amazon S3)
SAP HANA on Amazon EC2 for SAP HANA databases on Amazon Elastic Compute Cloud instances
Storage Gateway for Storage Gateway
Timestream for Amazon Timestream
VirtualMachine for VMware virtual machines
Returns only recovery points that match the specified resource type(s):
Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
RDS for Amazon Relational Database Service
Redshift for Amazon Redshift
S3 for Amazon Simple Storage Service (Amazon S3)
SAP HANA on Amazon EC2 for SAP HANA databases on Amazon Elastic Compute Cloud instances
Storage Gateway for Storage Gateway
Timestream for Amazon Timestream
VirtualMachine for VMware virtual machines
Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.
The the value ANY returns count of all resource types.
AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.
The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
", - "ListRestoreJobsInput$ByResourceType": "Include this parameter to return only restore jobs for the specified resources:
Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
Redshift for Amazon Redshift
RDS for Amazon Relational Database Service
SAP HANA on Amazon EC2 for SAP HANA databases
Storage Gateway for Storage Gateway
S3 for Amazon S3
Timestream for Amazon Timestream
VirtualMachine for virtual machines
Include this parameter to return only restore jobs for the specified resources:
Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
RDS for Amazon Relational Database Service
Redshift for Amazon Redshift
S3 for Amazon Simple Storage Service (Amazon S3)
SAP HANA on Amazon EC2 for SAP HANA databases on Amazon Elastic Compute Cloud instances
Storage Gateway for Storage Gateway
Timestream for Amazon Timestream
VirtualMachine for VMware virtual machines
The type of Amazon Web Services 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.
", "RecoveryPointByBackupVault$ResourceType": "The type of Amazon Web Services 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.
", - "RecoveryPointMember$ResourceType": "This is the Amazon Web Services resource type that is saved as a recovery point.
", + "RecoveryPointMember$ResourceType": "The Amazon Web Services resource type that is saved as a recovery point.
", "ResourceTypeManagementPreference$key": null, "ResourceTypeOptInPreference$key": null, "ResourceTypes$member": null, "RestoreJobSummary$ResourceType": "This value is the job count for the specified resource type. The request GetSupportedResourceTypes returns strings for supported resource types.
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.
", - "StartRestoreJobInput$ResourceType": "Starts a job to restore a recovery point for one of the following resources:
Aurora for Amazon Aurora
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
CloudFormation for CloudFormation
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
Redshift for Amazon Redshift
Storage Gateway for Storage Gateway
S3 for Amazon S3
Timestream for Amazon Timestream
VirtualMachine for virtual machines
Starts a job to restore a recovery point for one of the following resources:
Aurora - Amazon Aurora
DocumentDB - Amazon DocumentDB
CloudFormation - CloudFormation
DynamoDB - Amazon DynamoDB
EBS - Amazon Elastic Block Store
EC2 - Amazon Elastic Compute Cloud
EFS - Amazon Elastic File System
FSx - Amazon FSx
Neptune - Amazon Neptune
RDS - Amazon Relational Database Service
Redshift - Amazon Redshift
Storage Gateway - Storage Gateway
S3 - Amazon Simple Storage Service
Timestream - Amazon Timestream
VirtualMachine - Virtual machines
Returns whether Backup fully manages the backups for a resource type.
For the benefits of full Backup management, see Full Backup management.
For a list of resource types and whether each supports full Backup management, see the Feature availability by resource table.
If \"DynamoDB\":false, you can enable full Backup management for DynamoDB backup by enabling Backup's advanced DynamoDB backup features.
Returns whether Backup fully manages the backups for a resource type.
For the benefits of full Backup management, see Full Backup management.
For a list of resource types and whether each supports full Backup management, see the Feature availability by resource table.
If \"DynamoDB\":false, you can enable full Backup management for DynamoDB backup by enabling Backup's advanced DynamoDB backup features.
Enables or disables full Backup management of backups for a resource type. To enable full Backup management for DynamoDB along with Backup's advanced DynamoDB backup features, follow the procedure to enable advanced DynamoDB backup programmatically.
" } }, "ResourceTypeOptInPreference": { "base": null, "refs": { - "DescribeRegionSettingsOutput$ResourceTypeOptInPreference": "Returns a list of all services along with the opt-in preferences in the Region.
", + "DescribeRegionSettingsOutput$ResourceTypeOptInPreference": "The services along with the opt-in preferences in the Region.
", "UpdateRegionSettingsInput$ResourceTypeOptInPreference": "Updates the list of services along with the opt-in preferences for the Region.
If resource assignments are only based on tags, then service opt-in settings are applied. If a resource type is explicitly assigned to a backup plan, such as Amazon S3, Amazon EC2, or Amazon RDS, it will be included in the backup even if the opt-in is not enabled for that particular service. If both a resource type and tags are specified in a resource assignment, the resource type specified in the backup plan takes priority over the tag condition. Service opt-in settings are disregarded in this situation.
" } }, "ResourceTypes": { "base": null, "refs": { - "GetSupportedResourceTypesOutput$ResourceTypes": "Contains a string with the supported Amazon Web Services resource types:
Aurora for Amazon Aurora
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
RDS for Amazon Relational Database Service
Storage Gateway for Storage Gateway
DocDB for Amazon DocumentDB (with MongoDB compatibility)
Neptune for Amazon Neptune
Contains a string with the supported Amazon Web Services resource types:
Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
RDS for Amazon Relational Database Service
Redshift for Amazon Redshift
S3 for Amazon Simple Storage Service (Amazon S3)
SAP HANA on Amazon EC2 for SAP HANA databases on Amazon Elastic Compute Cloud instances
Storage Gateway for Storage Gateway
Timestream for Amazon Timestream
VirtualMachine for VMware virtual machines
This notes the status of the data generated by the restore test. The status may be Deleting, Failed, or Successful.
The status of the data generated by the restore test.
", "RestoreJobsListMember$DeletionStatus": "This notes the status of the data generated by the restore test. The status may be Deleting, Failed, or Successful.
Required: Algorithm; Required: Recovery point types; IncludeVaults(one or more). Optional: SelectionWindowDays ('30' if not specified);ExcludeVaults (list of selectors), defaults to empty list if not listed.
", + "base": " 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 [\"*\"] 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.
Required: Algorithm; Required: Recovery point types; IncludeVaults (one or more). Optional: SelectionWindowDays ('30' if not specified); ExcludeVaults (list of selectors), defaults to empty list if not listed.
", + "RestoreTestingPlanForCreate$RecoveryPointSelection": " RecoveryPointSelection has five parameters (three required and two optional). The values you specify determine which recovery point is included in the restore test. You must indicate with Algorithm if you want the latest recovery point within your SelectionWindowDays or if you want a random recovery point, and you must indicate through IncludeVaults from which vaults the recovery points can be chosen.
Algorithm (required) Valid values: \"LATEST_WITHIN_WINDOW\" or \"RANDOM_WITHIN_WINDOW\".
Recovery point types (required) Valid values: \"SNAPSHOT\" and/or \"CONTINUOUS\". Include SNAPSHOT to restore only snapshot recovery points; include CONTINUOUS to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for Algorithm.
IncludeVaults (required). You must include one or more backup vaults. Use the wildcard [\"*\"] 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.
The specified criteria to assign a set of resources, such as recovery point types or backup vaults.
", "RestoreTestingPlanForUpdate$RecoveryPointSelection": "Required: Algorithm; RecoveryPointTypes; IncludeVaults (one or more).
Optional: SelectionWindowDays ('30' if not specified); ExcludeVaults (defaults to empty list if not listed).
These are the types of recovery points.
" + "RestoreTestingRecoveryPointSelection$RecoveryPointTypes": "These are the types of recovery points.
Include SNAPSHOT to restore only snapshot recovery points; include CONTINUOUS to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for Algorithm.
This is the status of validation run on the indicated restore job.
", - "PutRestoreValidationResultInput$ValidationStatus": "This is the status of your restore validation.
", - "RestoreJobsListMember$ValidationStatus": "This is the status of validation run on the indicated restore job.
" + "DescribeRestoreJobOutput$ValidationStatus": "The status of validation run on the indicated restore job.
", + "PutRestoreValidationResultInput$ValidationStatus": "The status of your restore validation.
", + "RestoreJobsListMember$ValidationStatus": "The status of validation run on the indicated restore job.
" } }, "SensitiveStringMap": { "base": null, "refs": { - "CreateRestoreTestingPlanInput$Tags": "Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters,numbers, spaces, and the following characters: + - = . _ : /.
", + "CreateRestoreTestingPlanInput$Tags": "The tags to assign to the restore testing plan.
", "RestoreTestingSelectionForCreate$RestoreMetadataOverrides": "You can override certain restore metadata keys by including the parameter RestoreMetadataOverrides in the body of RestoreTestingSelection. Key values are not case sensitive.
See the complete list of restore testing inferred metadata.
", "RestoreTestingSelectionForGet$RestoreMetadataOverrides": "You can override certain restore metadata keys by including the parameter RestoreMetadataOverrides in the body of RestoreTestingSelection. Key values are not case sensitive.
See the complete list of restore testing inferred metadata.
", "RestoreTestingSelectionForUpdate$RestoreMetadataOverrides": "You can override certain restore metadata keys by including the parameter RestoreMetadataOverrides in the body of RestoreTestingSelection. Key values are not case sensitive.
See the complete list of restore testing inferred metadata.
" @@ -2121,13 +2121,13 @@ "CreateRestoreTestingPlanOutput$RestoreTestingPlanName": "This unique string is the name of the restore testing plan.
The name cannot be changed after creation. The name consists of only alphanumeric characters and underscores. Maximum length is 50.
", "CreateRestoreTestingSelectionInput$CreatorRequestId": "This is an optional unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
", "CreateRestoreTestingSelectionInput$RestoreTestingPlanName": "Input the restore testing plan name that was returned from the related CreateRestoreTestingPlan request.
", - "CreateRestoreTestingSelectionOutput$RestoreTestingPlanArn": "This is the ARN of the restore testing plan with which the restore testing selection is associated.
", - "CreateRestoreTestingSelectionOutput$RestoreTestingPlanName": "Unique string that is the name of the restore testing plan.
The name cannot be changed after creation. The name consists of only alphanumeric characters and underscores. Maximum length is 50.
", - "CreateRestoreTestingSelectionOutput$RestoreTestingSelectionName": "This is the unique name of the restore testing selection that belongs to the related restore testing plan.
", + "CreateRestoreTestingSelectionOutput$RestoreTestingPlanArn": "The ARN of the restore testing plan with which the restore testing selection is associated.
", + "CreateRestoreTestingSelectionOutput$RestoreTestingPlanName": "The name of the restore testing plan.
The name cannot be changed after creation. The name consists of only alphanumeric characters and underscores. Maximum length is 50.
", + "CreateRestoreTestingSelectionOutput$RestoreTestingSelectionName": "The name of the restore testing selection for the related restore testing plan.
", "DeleteRestoreTestingPlanInput$RestoreTestingPlanName": "Required unique name of the restore testing plan you wish to delete.
", "DeleteRestoreTestingSelectionInput$RestoreTestingPlanName": "Required unique name of the restore testing plan that contains the restore testing selection you wish to delete.
", "DeleteRestoreTestingSelectionInput$RestoreTestingSelectionName": "Required unique name of the restore testing selection you wish to delete.
", - "GetRestoreTestingInferredMetadataInput$BackupVaultAccountId": "This is the account ID of the specified backup vault.
", + "GetRestoreTestingInferredMetadataInput$BackupVaultAccountId": "The account ID of the specified backup vault.
", "GetRestoreTestingInferredMetadataInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web ServicesRegion where they are created. They consist of letters, numbers, and hyphens.
", "GetRestoreTestingInferredMetadataInput$RecoveryPointArn": "An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Required unique name of the restore testing plan.
", @@ -2145,23 +2145,23 @@ "RestoreTestingPlanForCreate$ScheduleExpressionTimezone": "Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
", "RestoreTestingPlanForGet$CreatorRequestId": "This identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
", "RestoreTestingPlanForGet$RestoreTestingPlanArn": "An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.
", - "RestoreTestingPlanForGet$RestoreTestingPlanName": "This is the restore testing plan name.
", + "RestoreTestingPlanForGet$RestoreTestingPlanName": "The restore testing plan name.
", "RestoreTestingPlanForGet$ScheduleExpression": "A CRON expression in specified timezone when a restore testing plan is executed.
", "RestoreTestingPlanForGet$ScheduleExpressionTimezone": "Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
", "RestoreTestingPlanForList$RestoreTestingPlanArn": "An Amazon Resource Name (ARN) that uniquely identifiesa restore testing plan.
", - "RestoreTestingPlanForList$RestoreTestingPlanName": "This is the restore testing plan name.
", + "RestoreTestingPlanForList$RestoreTestingPlanName": "The restore testing plan name.
", "RestoreTestingPlanForList$ScheduleExpression": "A CRON expression in specified timezone when a restore testing plan is executed.
", "RestoreTestingPlanForList$ScheduleExpressionTimezone": "Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
", "RestoreTestingPlanForUpdate$ScheduleExpression": "A CRON expression in specified timezone when a restore testing plan is executed.
", "RestoreTestingPlanForUpdate$ScheduleExpressionTimezone": "Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
", "RestoreTestingSelectionForCreate$IamRoleArn": "The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access.
The type of Amazon Web Services 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
This is the unique name of the restore testing selection that belongs to the related restore testing plan.
", + "RestoreTestingSelectionForCreate$RestoreTestingSelectionName": "The unique name of the restore testing selection that belongs to the related restore testing plan.
", "RestoreTestingSelectionForGet$CreatorRequestId": "This identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
", "RestoreTestingSelectionForGet$IamRoleArn": "The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example:arn:aws:iam::123456789012:role/S3Access.
The type of Amazon Web Services resource included in a resource testing selection; for example, an Amazon EBS volume or an Amazon RDS database.
", "RestoreTestingSelectionForGet$RestoreTestingPlanName": "The RestoreTestingPlanName is a unique string that is the name of the restore testing plan.
", - "RestoreTestingSelectionForGet$RestoreTestingSelectionName": "This is the unique name of the restore testing selection that belongs to the related restore testing plan.
", + "RestoreTestingSelectionForGet$RestoreTestingSelectionName": "The unique name of the restore testing selection that belongs to the related restore testing plan.
", "RestoreTestingSelectionForList$IamRoleArn": "The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access.
The type of Amazon Web Services resource included in a restore testing selection; for example, an Amazon EBS volume or an Amazon RDS database.
", "RestoreTestingSelectionForList$RestoreTestingPlanName": "Unique string that is the name of the restore testing plan.
The name cannot be changed after creation. The name must consist of only alphanumeric characters and underscores. Maximum length is 50.
", @@ -2169,14 +2169,14 @@ "RestoreTestingSelectionForUpdate$IamRoleArn": "The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access.
This is the restore testing plan name you wish to update.
", + "UpdateRestoreTestingPlanInput$RestoreTestingPlanName": "The name of the restore testing plan name.
", "UpdateRestoreTestingPlanOutput$RestoreTestingPlanArn": "Unique ARN (Amazon Resource Name) of the restore testing plan.
", "UpdateRestoreTestingPlanOutput$RestoreTestingPlanName": "The name cannot be changed after creation. The name consists of only alphanumeric characters and underscores. Maximum length is 50.
", "UpdateRestoreTestingSelectionInput$RestoreTestingPlanName": "The restore testing plan name is required to update the indicated testing plan.
", - "UpdateRestoreTestingSelectionInput$RestoreTestingSelectionName": "This is the required restore testing selection name of the restore testing selection you wish to update.
", + "UpdateRestoreTestingSelectionInput$RestoreTestingSelectionName": "The required restore testing selection name of the restore testing selection you wish to update.
", "UpdateRestoreTestingSelectionOutput$RestoreTestingPlanArn": "Unique string that is the name of the restore testing plan.
", - "UpdateRestoreTestingSelectionOutput$RestoreTestingPlanName": "This is the restore testing plan with which the updated restore testing selection is associated.
", - "UpdateRestoreTestingSelectionOutput$RestoreTestingSelectionName": "This is the returned restore testing selection name.
" + "UpdateRestoreTestingSelectionOutput$RestoreTestingPlanName": "The restore testing plan with which the updated restore testing selection is associated.
", + "UpdateRestoreTestingSelectionOutput$RestoreTestingSelectionName": "The returned restore testing selection name.
" } }, "TagKey": { @@ -2188,7 +2188,7 @@ "TagKeyList": { "base": null, "refs": { - "UntagResourceInput$TagKeyList": "A list of keys to identify which key-value tags to remove from a resource.
" + "UntagResourceInput$TagKeyList": "The keys to identify which key-value tags to remove from a resource.
" } }, "TagResourceInput": { @@ -2205,14 +2205,14 @@ "Tags": { "base": null, "refs": { - "BackupRule$RecoveryPointTags": "An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.
", - "BackupRuleInput$RecoveryPointTags": "To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
", - "CreateBackupPlanInput$BackupPlanTags": "To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.
", - "CreateBackupVaultInput$BackupVaultTags": "Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.
", + "BackupRule$RecoveryPointTags": "The tags that are assigned to resources that are associated with this rule when restored from backup.
", + "BackupRuleInput$RecoveryPointTags": "The tags to assign to the resources.
", + "CreateBackupPlanInput$BackupPlanTags": "The tags to assign to the backup plan.
", + "CreateBackupVaultInput$BackupVaultTags": "The tags to assign to the backup vault.
", "CreateLegalHoldInput$Tags": "Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.
", - "CreateLogicallyAirGappedBackupVaultInput$BackupVaultTags": "These are the tags that will be included in the newly-created vault.
", - "ListTagsOutput$Tags": "To help organize your resources, you can assign your own metadata to the resources you create. Each tag is a key-value pair.
", - "StartBackupJobInput$RecoveryPointTags": "To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
", + "CreateLogicallyAirGappedBackupVaultInput$BackupVaultTags": "The tags to assign to the vault.
", + "ListTagsOutput$Tags": "Information about the tags.
", + "StartBackupJobInput$RecoveryPointTags": "The tags to assign to the resources.
", "TagResourceInput$Tags": "Key-value pairs that are used to help organize your resources. You can assign your own metadata to the resources you create. For clarity, this is the structure to assign tags: [{\"Key\":\"string\",\"Value\":\"string\"}].
The date and time a restore testing plan was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.
This is the time the resource testing selection was created successfully.
", + "CreateRestoreTestingSelectionOutput$CreationTime": "The time that the resource testing selection was created.
", "RestoreTestingPlanForGet$CreationTime": "The date and time that a restore testing plan was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
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.
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.
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.
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.
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.
This is 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.
This is the time the resource testing plan was created.
", - "UpdateRestoreTestingPlanOutput$UpdateTime": "This is the time the update completed for the restore testing plan.
", - "UpdateRestoreTestingSelectionOutput$CreationTime": "This is the time the resource testing selection was updated successfully.
", - "UpdateRestoreTestingSelectionOutput$UpdateTime": "This is the time the update completed for the restore testing selection.
" + "RestoreTestingSelectionForList$CreationTime": "The date and time that a restore testing selection was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26,2018 12:11:30.087 AM.
The time the resource testing plan was created.
", + "UpdateRestoreTestingPlanOutput$UpdateTime": "The time the update completed for the restore testing plan.
", + "UpdateRestoreTestingSelectionOutput$CreationTime": "The time the resource testing selection was updated successfully.
", + "UpdateRestoreTestingSelectionOutput$UpdateTime": "The time the update completed for the restore testing selection.
" } }, "Timezone": { "base": null, "refs": { - "BackupRule$ScheduleExpressionTimezone": "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.
", - "BackupRuleInput$ScheduleExpressionTimezone": "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.
" + "BackupRule$ScheduleExpressionTimezone": "The timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
", + "BackupRuleInput$ScheduleExpressionTimezone": "The timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
" } }, "UntagResourceInput": { @@ -2326,17 +2326,20 @@ "VaultState": { "base": null, "refs": { - "CreateLogicallyAirGappedBackupVaultOutput$VaultState": "This is the current state of the vault.
" + "BackupVaultListMember$VaultState": "The current state of the vault.
", + "CreateLogicallyAirGappedBackupVaultOutput$VaultState": "The current state of the vault.
", + "DescribeBackupVaultOutput$VaultState": "The current state of the vault.->
" } }, "VaultType": { "base": null, "refs": { - "DescribeBackupVaultOutput$VaultType": "This is the type of vault described.
", - "DescribeRecoveryPointOutput$VaultType": "This is the type of vault in which the described recovery point is stored.
", + "BackupVaultListMember$VaultType": "The type of vault in which the described recovery point is stored.
", + "DescribeBackupVaultOutput$VaultType": "The type of vault described.
", + "DescribeRecoveryPointOutput$VaultType": "The type of vault in which the described recovery point is stored.
", "ListBackupVaultsInput$ByVaultType": "This parameter will sort the list of vaults by vault type.
", - "RecoveryPointByBackupVault$VaultType": "This is the type of vault in which the described recovery point is stored.
", - "RecoveryPointByResource$VaultType": "This is the type of vault in which the described recovery point is stored.
" + "RecoveryPointByBackupVault$VaultType": "The type of vault in which the described recovery point is stored.
", + "RecoveryPointByResource$VaultType": "The type of vault in which the described recovery point is stored.
" } }, "WindowMinutes": { @@ -2408,7 +2411,7 @@ "BackupJob$PercentDone": "Contains an estimated percentage complete of a job at the time the job status was queried.
", "BackupJob$BackupType": "Represents the type of backup for a backup job.
", "BackupJob$ParentJobId": "This uniquely identifies a request to Backup to back up a resource. The return will be the parent (composite) job ID.
", - "BackupJob$ResourceName": "This is the non-unique name of the resource that belongs to the specified backup.
", + "BackupJob$ResourceName": "The non-unique name of the resource that belongs to the specified backup.
", "BackupJob$MessageCategory": "This parameter is the job count for the specified message category.
Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. See Monitoring 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.
Uniquely identifies a stored backup plan template.
", "BackupPlanTemplatesListMember$BackupPlanTemplateName": "The optional display name of a backup plan template.
", @@ -2420,8 +2423,8 @@ "BackupSelectionsListMember$BackupPlanId": "Uniquely identifies a backup plan.
", "BackupSelectionsListMember$CreatorRequestId": "A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
", "BackupVaultListMember$CreatorRequestId": "A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
", - "CancelLegalHoldInput$LegalHoldId": "Legal hold ID required to remove the specified legal hold on a recovery point.
", - "CancelLegalHoldInput$CancelDescription": "String describing the reason for removing the legal hold.
", + "CancelLegalHoldInput$LegalHoldId": "The ID of the legal hold.
", + "CancelLegalHoldInput$CancelDescription": "A string the describes the reason for removing the legal hold.
", "ComplianceResourceIdList$member": null, "ConflictException$Code": null, "ConflictException$Message": null, @@ -2430,32 +2433,32 @@ "CopyJob$CopyJobId": "Uniquely identifies a copy job.
", "CopyJob$StatusMessage": "A detailed message explaining the status of the job to copy a resource.
", "CopyJob$ParentJobId": "This uniquely identifies a request to Backup to copy a resource. The return will be the parent (composite) job ID.
", - "CopyJob$CompositeMemberIdentifier": "This is 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 within a stack.
", - "CopyJob$ResourceName": "This is the non-unique name of the resource that belongs to the specified backup.
", + "CopyJob$CompositeMemberIdentifier": "The identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.
", + "CopyJob$ResourceName": "The non-unique name of the resource that belongs to the specified backup.
", "CopyJob$MessageCategory": "This parameter is the job count for the specified message category.
Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and InvalidParameters. See Monitoring 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
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 '-_.' characters.
", - "CreateBackupPlanOutput$BackupPlanId": "Uniquely identifies a backup plan.
", + "CreateBackupPlanOutput$BackupPlanId": "The ID of the backup plan.
", "CreateBackupPlanOutput$VersionId": "Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.
", - "CreateBackupSelectionInput$BackupPlanId": "Uniquely identifies the backup plan to be associated with the selection of resources.
", + "CreateBackupSelectionInput$BackupPlanId": "The ID of the backup plan.
", "CreateBackupSelectionInput$CreatorRequestId": "A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
", "CreateBackupSelectionOutput$SelectionId": "Uniquely identifies the body of a request to assign a set of resources to a backup plan.
", - "CreateBackupSelectionOutput$BackupPlanId": "Uniquely identifies a backup plan.
", + "CreateBackupSelectionOutput$BackupPlanId": "The ID of the backup plan.
", "CreateBackupVaultInput$CreatorRequestId": "A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
", "CreateFrameworkInput$IdempotencyToken": "A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateFrameworkInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.
This is the string title of the legal hold.
", - "CreateLegalHoldInput$Description": "This is the string description of the legal hold.
", + "CreateLegalHoldInput$Title": "The title of the legal hold.
", + "CreateLegalHoldInput$Description": "The description of the legal hold.
", "CreateLegalHoldInput$IdempotencyToken": "This is a user-chosen string used to distinguish between otherwise identical calls. Retrying a successful request with the same idempotency token results in a success message with no action taken.
", - "CreateLegalHoldOutput$Title": "This is the string title of the legal hold returned after creating the legal hold.
", - "CreateLegalHoldOutput$Description": "This is the returned string description of the legal hold.
", - "CreateLegalHoldOutput$LegalHoldId": "Legal hold ID returned for the specified legal hold on a recovery point.
", - "CreateLogicallyAirGappedBackupVaultInput$CreatorRequestId": "This is the ID of the creation request.
This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
", + "CreateLegalHoldOutput$Title": "The title of the legal hold.
", + "CreateLegalHoldOutput$Description": "The description of the legal hold.
", + "CreateLegalHoldOutput$LegalHoldId": "The ID of the legal hold.
", + "CreateLogicallyAirGappedBackupVaultInput$CreatorRequestId": "The ID of the creation request.
This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
", "CreateReportPlanInput$IdempotencyToken": "A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.
Uniquely identifies a backup plan.
", "DeleteBackupPlanOutput$BackupPlanId": "Uniquely identifies a backup plan.
", "DeleteBackupPlanOutput$VersionId": "Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
", "DeleteBackupSelectionInput$BackupPlanId": "Uniquely identifies a backup plan.
", "DeleteBackupSelectionInput$SelectionId": "Uniquely identifies the body of a request to assign a set of resources to a backup plan.
", - "DeleteBackupVaultInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", + "DeleteBackupVaultInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
", "DependencyFailureException$Code": null, "DependencyFailureException$Message": null, "DependencyFailureException$Type": "", @@ -2466,24 +2469,24 @@ "DescribeBackupJobOutput$PercentDone": "Contains an estimated percentage that is complete of a job at the time the job status was queried.
", "DescribeBackupJobOutput$BackupType": "Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow Copy Service (VSS) backup was taken, BackupType returns \"WindowsVSS\". If BackupType is empty, then the backup type was a regular backup.
This returns the parent (composite) resource backup job ID.
", - "DescribeBackupJobOutput$ResourceName": "This is the non-unique name of the resource that belongs to the specified backup.
", - "DescribeBackupJobOutput$MessageCategory": "This is the job count for the specified message category.
Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. View Monitoring for a list of accepted MessageCategory strings.
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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", - "DescribeBackupVaultInput$BackupVaultAccountId": "This is the account ID of the specified backup vault.
", - "DescribeBackupVaultOutput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", + "DescribeBackupJobOutput$ResourceName": "The non-unique name of the resource that belongs to the specified backup.
", + "DescribeBackupJobOutput$MessageCategory": "The job count for the specified message category.
Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. View Monitoring for a list of accepted MessageCategory strings.
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 Amazon Web Services Region where they are created.
", + "DescribeBackupVaultInput$BackupVaultAccountId": "The account ID of the specified backup vault.
", + "DescribeBackupVaultOutput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
", "DescribeBackupVaultOutput$CreatorRequestId": "A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
", "DescribeCopyJobInput$CopyJobId": "Uniquely identifies a copy job.
", "DescribeFrameworkOutput$DeploymentStatus": "The deployment status of a framework. The statuses are:
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:
ACTIVE when recording is turned on for all resources governed by the framework.
PARTIALLY_ACTIVE when recording is turned off for at least one resource governed by the framework.
INACTIVE when recording is turned off for all resources governed by the framework.
UNAVAILABLE when Backup is unable to validate recording status at this time.
A customer-chosen string that you can use to distinguish between otherwise identical calls to DescribeFrameworkOutput. Retrying a successful request with the same idempotency token results in a success message with no action taken.
This is the non-unique name of the resource that belongs to the specified backup.
", + "DescribeProtectedResourceOutput$ResourceName": "The name of the resource that belongs to the specified backup.
", "DescribeRecoveryPointOutput$StatusMessage": "A status message explaining the status of the recovery point.
", - "DescribeRecoveryPointOutput$CompositeMemberIdentifier": "This is 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 within a stack.
", - "DescribeRecoveryPointOutput$ResourceName": "This is the non-unique name of the resource that belongs to the specified backup.
", + "DescribeRecoveryPointOutput$CompositeMemberIdentifier": "The identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.
", + "DescribeRecoveryPointOutput$ResourceName": "The name of the resource that belongs to the specified backup.
", "DescribeRestoreJobOutput$RestoreJobId": "Uniquely identifies the job that restores a recovery point.
", "DescribeRestoreJobOutput$StatusMessage": "A message showing the status of a job to restore a recovery point.
", "DescribeRestoreJobOutput$PercentDone": "Contains an estimated percentage that is complete of a job at the time the job status was queried.
", - "DescribeRestoreJobOutput$ValidationStatusMessage": "This describes the status of validation run on the indicated restore job.
", + "DescribeRestoreJobOutput$ValidationStatusMessage": "The status message.
", "DescribeRestoreJobOutput$DeletionStatusMessage": "This describes the restore job deletion status.
", "ExportBackupPlanTemplateInput$BackupPlanId": "Uniquely identifies a backup plan.
", "ExportBackupPlanTemplateOutput$BackupPlanTemplateJson": "The body of a backup plan template in JSON format.
This is a signed JSON document that cannot be modified before being passed to GetBackupPlanFromJSON.
Uniquely identifies the body of a request to assign a set of resources to a backup plan.
", "GetBackupSelectionOutput$BackupPlanId": "Uniquely identifies a backup plan.
", "GetBackupSelectionOutput$CreatorRequestId": "A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
", - "GetLegalHoldInput$LegalHoldId": "This is the ID required to use GetLegalHold. This unique ID is associated with a specific legal hold.
This is the string title of the legal hold.
", - "GetLegalHoldOutput$Description": "This is the returned string description of the legal hold.
", - "GetLegalHoldOutput$CancelDescription": "String describing the reason for removing the legal hold.
", - "GetLegalHoldOutput$LegalHoldId": "This is the returned ID associated with a specified legal hold.
", + "GetLegalHoldInput$LegalHoldId": "The ID of the legal hold.
", + "GetLegalHoldOutput$Title": "The title of the legal hold.
", + "GetLegalHoldOutput$Description": "The description of the legal hold.
", + "GetLegalHoldOutput$CancelDescription": "The reason for removing the legal hold.
", + "GetLegalHoldOutput$LegalHoldId": "The ID of the legal hold.
", "InvalidParameterValueException$Code": null, "InvalidParameterValueException$Message": null, "InvalidParameterValueException$Type": "", @@ -2518,15 +2521,15 @@ "InvalidResourceStateException$Message": null, "InvalidResourceStateException$Type": "", "InvalidResourceStateException$Context": "", - "LegalHold$Title": "This is the title of a legal hold.
", - "LegalHold$Description": "This is the description of a legal hold.
", - "LegalHold$LegalHoldId": "ID of specific legal hold on one or more recovery points.
", + "LegalHold$Title": "The title of a legal hold.
", + "LegalHold$Description": "The description of a legal hold.
", + "LegalHold$LegalHoldId": "The ID of the legal hold.
", "LimitExceededException$Code": null, "LimitExceededException$Message": null, "LimitExceededException$Type": "", "LimitExceededException$Context": "", "ListBackupJobSummariesInput$NextToken": "The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
This is the period that sets the boundaries for returned results.
ONE_DAY for daily job count for the prior 14 days.
SEVEN_DAYS for the aggregated job count for the prior 7 days.
FOURTEEN_DAYS for aggregated job count for prior 14 days.
The period for the returned results.
ONE_DAY - The daily job count for the prior 14 days.
SEVEN_DAYS - The aggregated job count for the prior 7 days.
FOURTEEN_DAYS - The aggregated job count for prior 14 days.
The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
This is a filter to list child (nested) jobs based on parent job ID.
", @@ -2545,10 +2548,10 @@ "ListBackupVaultsInput$NextToken": "The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
This is the period that sets the boundaries for returned results.
ONE_DAY for daily job count for the prior 14 days.
SEVEN_DAYS for the aggregated job count for the prior 7 days.
FOURTEEN_DAYS for aggregated job count for prior 14 days.
The period for the returned results.
ONE_DAY - The daily job count for the prior 14 days.
SEVEN_DAYS - The aggregated job count for the prior 7 days.
FOURTEEN_DAYS - The aggregated job count for prior 14 days.
The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
", - "ListCopyJobsInput$ByDestinationVaultArn": "An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
This is a filter to list child (nested) jobs based on parent job ID.
", "ListCopyJobsInput$ByMessageCategory": "This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.
Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS.
View Monitoring for a list of accepted strings.
The the value ANY returns count of all message categories.
AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
", @@ -2563,9 +2566,9 @@ "ListRecoveryPointsByBackupVaultInput$NextToken": "The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
Returns only recovery points that match the specified backup plan ID.
", "ListRecoveryPointsByBackupVaultOutput$NextToken": "The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
This is the ID of the legal hold.
", - "ListRecoveryPointsByLegalHoldInput$NextToken": "This is the next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
This return is the next item following a partial list of returned resources.
", + "ListRecoveryPointsByLegalHoldInput$LegalHoldId": "The ID of the legal hold.
", + "ListRecoveryPointsByLegalHoldInput$NextToken": "The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned resources.
", "ListRecoveryPointsByResourceInput$NextToken": "The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
Returns only report jobs that are in the specified status. The statuses are:
CREATED | RUNNING | COMPLETED | FAILED
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListReportPlansOutput$NextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListRestoreJobSummariesInput$NextToken": "The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
This is the period that sets the boundaries for returned results.
ONE_DAY for daily job count for the prior 14 days.
SEVEN_DAYS for the aggregated job count for the prior 7 days.
FOURTEEN_DAYS for aggregated job count for prior 14 days.
The period for the returned results.
ONE_DAY - The daily job count for the prior 14 days.
SEVEN_DAYS - The aggregated job count for the prior 7 days.
FOURTEEN_DAYS - The aggregated job count for prior 14 days.
The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned items. For example, if a request ismade to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows youto return more items in your list starting at the location pointed to by the next token
This is the non-unique name of the resource that belongs to the specified backup.
", + "ProtectedResource$ResourceName": "The non-unique name of the resource that belongs to the specified backup.
", "PutRestoreValidationResultInput$ValidationStatusMessage": "This is an optional message string you can input to describe the validation status for the restore test validation.
", - "RecoveryPointByBackupVault$StatusMessage": "A message explaining the reason of the recovery point deletion failure.
", - "RecoveryPointByBackupVault$CompositeMemberIdentifier": "This is 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 within a stack.
", - "RecoveryPointByBackupVault$ResourceName": "This is the non-unique name of the resource that belongs to the specified backup.
", - "RecoveryPointByResource$StatusMessage": "A message explaining the reason of the recovery point deletion failure.
", - "RecoveryPointByResource$ResourceName": "This is the non-unique name of the resource that belongs to the specified backup.
", + "RecoveryPointByBackupVault$StatusMessage": "A message explaining the current status of the recovery point.
", + "RecoveryPointByBackupVault$CompositeMemberIdentifier": "The identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.
", + "RecoveryPointByBackupVault$ResourceName": "The non-unique name of the resource that belongs to the specified backup.
", + "RecoveryPointByResource$StatusMessage": "A message explaining the current status of the recovery point.
", + "RecoveryPointByResource$ResourceName": "The non-unique name of the resource that belongs to the specified backup.
", "RecoveryPointCreator$BackupPlanId": "Uniquely identifies a backup plan.
", "RecoveryPointCreator$BackupPlanVersion": "Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.
", "RecoveryPointCreator$BackupRuleId": "Uniquely identifies a rule used to schedule the backup of a selection of resources.
", @@ -2626,7 +2629,7 @@ "StartRestoreJobInput$IdempotencyToken": "A customer-chosen string that you can use to distinguish between otherwise identical calls to StartRestoreJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.
Uniquely identifies a request to Backup to back up a resource.
", "TagKeyList$member": null, - "UpdateBackupPlanInput$BackupPlanId": "Uniquely identifies a backup plan.
", + "UpdateBackupPlanInput$BackupPlanId": "The ID of the backup plan.
", "UpdateBackupPlanOutput$BackupPlanId": "Uniquely identifies a backup plan.
", "UpdateBackupPlanOutput$VersionId": "Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.
", "UpdateFrameworkInput$IdempotencyToken": "A customer-chosen string that you can use to distinguish between otherwise identical calls to UpdateFrameworkInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.
The object key that uniquely identifies your reports in your S3 bucket.
", "ReportSetting$FrameworkArns": "The Amazon Resource Names (ARNs) of the frameworks a report covers.
", - "ReportSetting$Accounts": "These are the accounts to be included in the report.
", + "ReportSetting$Accounts": "These are the accounts to be included in the report.
Use string value of ROOT to include all organizational units.
These are the Organizational Units to be included in the report.
", - "ReportSetting$Regions": "These are the Regions to be included in the report.
", + "ReportSetting$Regions": "These are the Regions to be included in the report.
Use the wildcard as the string value to include all Regions.
", "RestoreTestingRecoveryPointSelection$ExcludeVaults": "Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed.
", "RestoreTestingRecoveryPointSelection$IncludeVaults": "Accepted values include wildcard [\"*\"] or by specific ARNs or ARN wilcard replacement [\"arn:aws:backup:us-west-2:123456789012:backup-vault:asdf\", ...] [\"arn:aws:backup:*:*:backup-vault:asdf-*\", ...]
", "RestoreTestingSelectionForCreate$ProtectedResourceArns": "Each protected resource can be filtered by its specific ARNs, such as ProtectedResourceArns: [\"arn:aws:...\", \"arn:aws:...\"] or by a wildcard: ProtectedResourceArns: [\"*\"], but not both.
The tag key-value pair applied to those Amazon Web Services 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. The structure to assign a tag is: [{\"Key\":\"string\",\"Value\":\"string\"}].
Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
", - "CreateReportPlanInput$ReportPlanTags": "Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
", + "ControlScope$Tags": "The tag key-value pair applied to those Amazon Web Services 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\"}].
The tags to assign to the framework.
", + "CreateReportPlanInput$ReportPlanTags": "The tags to assign to the report plan.
", "GetRestoreTestingInferredMetadataOutput$InferredMetadata": "This is a string map of the metadata inferred from the request.
" } }, @@ -2668,12 +2671,12 @@ "BackupJob$CompletionDate": "The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
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.
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.
This is the date on which the backup job was initiated.
", + "BackupJob$InitiationDate": "The date on which the backup job was initiated.
", "BackupJobSummary$StartTime": "The value of time in number format of a job start time.
This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
", "BackupJobSummary$EndTime": "The value of time in number format of a job end time.
This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
", "BackupPlansListMember$CreationDate": "The date and time a resource backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
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.
The last time a job to back up resources was run with this rule. 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.
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.
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.
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.
The date and time when 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.
", @@ -2686,7 +2689,7 @@ "CreateBackupPlanOutput$CreationDate": "The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Time in number format when legal hold was created.
", + "CreateLegalHoldOutput$CreationDate": "The time when the legal hold was created.
", "CreateLogicallyAirGappedBackupVaultOutput$CreationDate": "The date and time when the vault was created.
This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
", "CreateReportPlanOutput$CreationTime": "The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
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).
", @@ -2696,30 +2699,30 @@ "DescribeBackupJobOutput$CompletionDate": "The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
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.
This is the date a backup job was initiated.
", + "DescribeBackupJobOutput$InitiationDate": "The date a backup job was initiated.
", "DescribeBackupVaultOutput$CreationDate": "The date and time that a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time when Backup Vault Lock configuration cannot be changed or deleted.
If you applied Vault Lock to your vault without specifying a lock date, you can change any of your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.
This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
", "DescribeFrameworkOutput$CreationTime": "The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.
The date and time that the flag isCrossAccountBackupEnabled was last updated. This update is in Unix format and Coordinated Universal Time (UTC). The value of LastUpdateTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
This is the creation date of the most recent restore job.
", - "DescribeProtectedResourceOutput$LatestRestoreRecoveryPointCreationDate": "This is the date the most recent recovery point was created.
", + "DescribeProtectedResourceOutput$LatestRestoreJobCreationDate": "The creation date of the most recent restore job.
", + "DescribeProtectedResourceOutput$LatestRestoreRecoveryPointCreationDate": "The date the most recent recovery point was created.
", "DescribeRecoveryPointOutput$CreationDate": "The date and time that a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that a job to create a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
This is the creation date of the recovery point made by the specifed restore job.
", + "DescribeRestoreJobOutput$RecoveryPointCreationDate": "The creation date of the recovery point made by the specifed restore job.
", "Framework$CreationTime": "The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.
The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The last time a job to back up resources was run with this backup 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.
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.
The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Time in number format when legal hold was created.
", - "GetLegalHoldOutput$CancellationDate": "Time in number when legal hold was cancelled.
", - "GetLegalHoldOutput$RetainRecordUntil": "This is the date and time until which the legal hold record will be retained.
", - "LegalHold$CreationDate": "This is the time in number format when legal hold was created.
", - "LegalHold$CancellationDate": "This is the time in number format when legal hold was cancelled.
", + "GetLegalHoldOutput$CreationDate": "The time when the legal hold was created.
", + "GetLegalHoldOutput$CancellationDate": "The time when the legal hold was cancelled.
", + "GetLegalHoldOutput$RetainRecordUntil": "The date and time until which the legal hold record is retained.
", + "LegalHold$CreationDate": "The time when the legal hold was created.
", + "LegalHold$CancellationDate": "The time when the legal hold was cancelled.
", "ListBackupJobsInput$ByCreatedBefore": "Returns only backup jobs that were created before the specified date.
", "ListBackupJobsInput$ByCreatedAfter": "Returns only backup jobs that were created after the specified date.
", "ListBackupJobsInput$ByCompleteAfter": "Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
", diff --git a/generator/ServiceModels/backup/backup-2018-11-15.normal.json b/generator/ServiceModels/backup/backup-2018-11-15.normal.json index f2c72a78ca4d..4adb46a31888 100644 --- a/generator/ServiceModels/backup/backup-2018-11-15.normal.json +++ b/generator/ServiceModels/backup/backup-2018-11-15.normal.json @@ -5,10 +5,12 @@ "endpointPrefix":"backup", "jsonVersion":"1.1", "protocol":"rest-json", + "protocols":["rest-json"], "serviceFullName":"AWS Backup", "serviceId":"Backup", "signatureVersion":"v4", - "uid":"backup-2018-11-15" + "uid":"backup-2018-11-15", + "auth":["aws.auth#sigv4"] }, "operations":{ "CancelLegalHold":{ @@ -27,7 +29,7 @@ {"shape":"ServiceUnavailableException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"This action removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.
", + "documentation":"Removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.
", "idempotent":true }, "CreateBackupPlan":{ @@ -116,7 +118,7 @@ {"shape":"ServiceUnavailableException"}, {"shape":"LimitExceededException"} ], - "documentation":"This action creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point.
", + "documentation":"Creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point.
", "idempotent":true }, "CreateLogicallyAirGappedBackupVault":{ @@ -135,7 +137,7 @@ {"shape":"ServiceUnavailableException"}, {"shape":"InvalidRequestException"} ], - "documentation":"This request creates a logical container to where backups may be copied.
This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.
Do not include sensitive data, such as passport numbers, in the name of a backup vault.
Creates a logical container to where backups may be copied.
This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.
Do not include sensitive data, such as passport numbers, in the name of a backup vault.
This is the first of two steps to create a restore testing plan; once this request is successful, finish the procedure with request CreateRestoreTestingSelection.
You must include the parameter RestoreTestingPlan. You may optionally include CreatorRequestId and Tags.
", + "documentation":"Creates a restore testing plan.
The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.
", "idempotent":true }, "CreateRestoreTestingSelection":{ @@ -855,7 +857,7 @@ {"shape":"ServiceUnavailableException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
" + "documentation":"Lists the backup plan templates.
" }, "ListBackupPlanVersions":{ "name":"ListBackupPlanVersions", @@ -888,7 +890,7 @@ {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], - "documentation":"Returns a list of all active backup plans for an authenticated account. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.
", + "documentation":"Lists the active backup plans for the account.
", "idempotent":true }, "ListBackupSelections":{ @@ -1059,7 +1061,7 @@ {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], - "documentation":"Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN).
For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.
The information about the recovery points of the type specified by a resource Amazon Resource Name (ARN).
For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.
Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
ListTags only works for resource types that support full Backup management of their backups. Those resource types are listed in the \"Full Backup management\" section of the Feature availability by resource table.
Returns the tags assigned to the resource, such as a target recovery point, backup plan, or backup vault.
", "idempotent":true }, "PutBackupVaultAccessPolicy":{ @@ -1216,7 +1218,7 @@ {"shape":"InvalidRequestException"}, {"shape":"ServiceUnavailableException"} ], - "documentation":"Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and maximum retention period for future backup and copy jobs that target a backup vault.
Backup Vault Lock has been assessed by Cohasset Associates for use in environments that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about how Backup Vault Lock relates to these regulations, see the Cohasset Associates Compliance Assessment.
Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and maximum retention period for future backup and copy jobs that target a backup vault.
Backup Vault Lock has been assessed by Cohasset Associates for use in environments that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about how Backup Vault Lock relates to these regulations, see the Cohasset Associates Compliance Assessment.
For more information, see Backup Vault Lock.
", "idempotent":true }, "PutBackupVaultNotifications":{ @@ -1340,7 +1342,7 @@ {"shape":"InvalidRequestException"}, {"shape":"ServiceUnavailableException"} ], - "documentation":"Attempts to cancel a job to create a one-time backup of a resource.
This action is not supported for the following services: Amazon FSx for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp ONTAP , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.
" + "documentation":"Attempts to cancel a job to create a one-time backup of a resource.
This action is not supported for the following services: Amazon FSx for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp ONTAP, Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.
" }, "TagResource":{ "name":"TagResource", @@ -1356,7 +1358,7 @@ {"shape":"ServiceUnavailableException"}, {"shape":"LimitExceededException"} ], - "documentation":"Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).
", + "documentation":"Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).
This API is supported for recovery points for resource types including Aurora, Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune, and Amazon RDS.
", "idempotent":true }, "UntagResource":{ @@ -1372,7 +1374,7 @@ {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], - "documentation":"Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
", + "documentation":"Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
This API is not supported for recovery points for resource types including Aurora, Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune, and Amazon RDS.
", "idempotent":true }, "UpdateBackupPlan":{ @@ -1389,7 +1391,7 @@ {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], - "documentation":"Updates an existing backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId.
Updates the specified backup plan. The new version is uniquely identified by its ID.
", "idempotent":true }, "UpdateFramework":{ @@ -1409,7 +1411,7 @@ {"shape":"ConflictException"}, {"shape":"ServiceUnavailableException"} ], - "documentation":"Updates an existing framework identified by its FrameworkName with the input document in JSON format.
Updates the specified framework.
", "idempotent":true }, "UpdateGlobalSettings":{ @@ -1442,7 +1444,7 @@ {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], - "documentation":"Sets the transition lifecycle of a recovery point.
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
This operation does not support continuous backups.
", + "documentation":"Sets the transition lifecycle of a recovery point.
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.
Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
If your lifecycle currently uses the parameters DeleteAfterDays and MoveToColdStorageAfterDays, include these parameters and their values when you call this operation. Not including them may result in your plan updating with null values.
This operation does not support continuous backups.
", "idempotent":true }, "UpdateRegionSettings":{ @@ -1474,7 +1476,7 @@ {"shape":"MissingParameterValueException"}, {"shape":"ConflictException"} ], - "documentation":"Updates an existing report plan identified by its ReportPlanName with the input document in JSON format.
Updates the specified report plan.
", "idempotent":true }, "UpdateRestoreTestingPlan":{ @@ -1512,7 +1514,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], - "documentation":"Most elements except the RestoreTestingSelectionName can be updated with this request.
RestoreTestingSelection can use either protected resource ARNs or conditions, but not both. That is, if your selection has ProtectedResourceArns, requesting an update with the parameter ProtectedResourceConditions will be unsuccessful.
Updates the specified restore testing selection.
Most elements except the RestoreTestingSelectionName can be updated with this request.
You can use either protected resource ARNs or conditions, but not both.
", "idempotent":true } }, @@ -1534,7 +1536,7 @@ "documentation":"Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.
Valid values:
Set to \"WindowsVSS\":\"enabled\" to enable the WindowsVSS backup option and create a Windows VSS backup.
Set to \"WindowsVSS\":\"disabled\" to create a regular backup. The WindowsVSS option is not enabled by default.
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.
" } }, - "documentation":"A list of backup options for each resource type.
" + "documentation":"The backup options for each resource type.
" }, "AdvancedBackupSettings":{ "type":"list", @@ -1586,11 +1588,11 @@ }, "BackupVaultName":{ "shape":"BackupVaultName", - "documentation":"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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
" + "documentation":"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 Amazon Web Services Region where they are created.
" }, "BackupVaultArn":{ "shape":"ARN", - "documentation":"An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
This is the non-unique name of the resource that belongs to the specified backup.
" + "documentation":"The non-unique name of the resource that belongs to the specified backup.
" }, "InitiationDate":{ "shape":"timestamp", - "documentation":"This is the date on which the backup job was initiated.
" + "documentation":"The date on which the backup job was initiated.
" }, "MessageCategory":{ "shape":"string", @@ -1782,7 +1784,7 @@ "members":{ "BackupPlanName":{ "shape":"BackupPlanName", - "documentation":"The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.
" + "documentation":"The display name of a backup plan. Must contain only alphanumeric or '-_.' 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.
" }, "Rules":{ "shape":"BackupRules", @@ -1877,7 +1879,7 @@ }, "LastExecutionDate":{ "shape":"timestamp", - "documentation":"The last time a job to back up resources was run with this rule. 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.
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.
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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
" + "documentation":"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 Amazon Web Services Region where they are created.
" }, "ScheduleExpression":{ "shape":"CronExpression", @@ -1915,11 +1917,11 @@ }, "Lifecycle":{ "shape":"Lifecycle", - "documentation":"The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
" + "documentation":"The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 table. Backup ignores this expression for other resource types.
" }, "RecoveryPointTags":{ "shape":"Tags", - "documentation":"An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.
" + "documentation":"The tags that are assigned to resources that are associated with this rule when restored from backup.
" }, "RuleId":{ "shape":"string", @@ -1935,7 +1937,7 @@ }, "ScheduleExpressionTimezone":{ "shape":"Timezone", - "documentation":"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.
" + "documentation":"The timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
" } }, "documentation":"Specifies a scheduled task used to back up a selection of resources.
" @@ -1953,7 +1955,7 @@ }, "TargetBackupVaultName":{ "shape":"BackupVaultName", - "documentation":"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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
" + "documentation":"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 Amazon Web Services Region where they are created.
" }, "ScheduleExpression":{ "shape":"CronExpression", @@ -1969,11 +1971,11 @@ }, "Lifecycle":{ "shape":"Lifecycle", - "documentation":"The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
This parameter has a maximum value of 100 years (36,500 days).
" + "documentation":"The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 table. Backup ignores this expression for other resource types.
This parameter has a maximum value of 100 years (36,500 days).
" }, "RecoveryPointTags":{ "shape":"Tags", - "documentation":"To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
" + "documentation":"The tags to assign to the resources.
" }, "CopyActions":{ "shape":"CopyActions", @@ -1985,7 +1987,7 @@ }, "ScheduleExpressionTimezone":{ "shape":"Timezone", - "documentation":"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.
" + "documentation":"The timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
" } }, "documentation":"Specifies a scheduled task used to back up a selection of resources.
" @@ -2019,22 +2021,22 @@ }, "Resources":{ "shape":"ResourceArns", - "documentation":"A list of Amazon Resource Names (ARNs) 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.
" + "documentation":"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).
" }, "ListOfTags":{ "shape":"ListOfTags", - "documentation":"A list of conditions that you define to assign resources to your backup plans using tags. For example, \"StringEquals\": { \"Key\": \"aws:ResourceTag/CreatedByCryo\", \"Value\": \"true\" },. Condition operators are case sensitive.
ListOfTags differs from Conditions as follows:
When you specify more than one condition, you assign all resources that match AT LEAST ONE condition (using OR logic).
ListOfTags only supports StringEquals. Conditions supports StringEquals, StringLike, StringNotEquals, and StringNotLike.
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).
" }, "NotResources":{ "shape":"ResourceArns", - "documentation":"A list of Amazon Resource Names (ARNs) 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.
" + "documentation":"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.
" }, "Conditions":{ "shape":"Conditions", - "documentation":"A list of conditions that you define to assign resources to your backup plans using tags. For example, \"StringEquals\": { \"Key\": \"aws:ResourceTag/CreatedByCryo\", \"Value\": \"true\" },. Condition operators are case sensitive.
Conditions differs from ListOfTags as follows:
When you specify more than one condition, you only assign the resources that match ALL conditions (using AND logic).
Conditions supports StringEquals, StringLike, StringNotEquals, and StringNotLike. ListOfTags only supports StringEquals.
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).
" } }, - "documentation":"Used to specify a set of resources to a backup plan.
Specifying your desired Conditions, ListOfTags, NotResources, and/or Resources is recommended. If none of these are specified, Backup will attempt to select all supported and opted-in storage resources, which could have unintended cost implications.
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.
" }, "BackupSelectionName":{ "type":"string", @@ -2109,11 +2111,19 @@ "members":{ "BackupVaultName":{ "shape":"BackupVaultName", - "documentation":"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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
" + "documentation":"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 Amazon Web Services Region where they are created.
" }, "BackupVaultArn":{ "shape":"ARN", - "documentation":"An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
The type of vault in which the described recovery point is stored.
" + }, + "VaultState":{ + "shape":"VaultState", + "documentation":"The current state of the vault.
" }, "CreationDate":{ "shape":"timestamp", @@ -2167,7 +2177,7 @@ "documentation":"A timestamp that specifies when to delete a recovery point.
" } }, - "documentation":"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. 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 are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
" + "documentation":"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. 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 table. Backup ignores this expression for other resource types.
" }, "CancelLegalHoldInput":{ "type":"structure", @@ -2178,19 +2188,19 @@ "members":{ "LegalHoldId":{ "shape":"string", - "documentation":"Legal hold ID required to remove the specified legal hold on a recovery point.
", + "documentation":"The ID of the legal hold.
", "location":"uri", "locationName":"legalHoldId" }, "CancelDescription":{ "shape":"string", - "documentation":"String describing the reason for removing the legal hold.
", + "documentation":"A string the describes the reason for removing the legal hold.
", "location":"querystring", "locationName":"cancelDescription" }, "RetainRecordInDays":{ "shape":"Long", - "documentation":"The integer amount in days specifying amount of days after this API operation to remove legal hold.
", + "documentation":"The integer amount, in days, after which to remove legal hold.
", "location":"querystring", "locationName":"retainRecordInDays" } @@ -2243,7 +2253,7 @@ "documentation":"The value in a key-value pair. For example, in the tag Department: Accounting, Accounting is the value.
Includes information about tags you define to assign tagged resources to a backup plan.
" + "documentation":"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\".
The value of parameter, for example, hourly.
A list of 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.
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.
The tag key-value pair applied to those Amazon Web Services 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. The structure to assign a tag is: [{\"Key\":\"string\",\"Value\":\"string\"}].
The tag key-value pair applied to those Amazon Web Services 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\"}].
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.
To set a control scope that includes all of a particular resource, leave the ControlScope empty or do not pass it when calling CreateFramework.
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:vault:aBackupVault.
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.
The details of the copy operation.
" @@ -2359,7 +2369,7 @@ }, "SourceBackupVaultArn":{ "shape":"ARN", - "documentation":"An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
This is 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 within a stack.
" + "documentation":"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 within a stack.
" }, "NumberOfChildJobs":{ "shape":"Long", - "documentation":"This is the number of child (nested) copy jobs.
" + "documentation":"The number of child (nested) copy jobs.
" }, "ChildJobsInState":{ "shape":"CopyJobChildJobsInState", @@ -2428,7 +2438,7 @@ }, "ResourceName":{ "shape":"string", - "documentation":"This is the non-unique name of the resource that belongs to the specified backup.
" + "documentation":"The non-unique name of the resource that belongs to the specified backup.
" }, "MessageCategory":{ "shape":"string", @@ -2473,7 +2483,7 @@ "members":{ "Region":{ "shape":"Region", - "documentation":"This is the Amazon Web Services Regions within the job summary.
" + "documentation":"The Amazon Web Services Regions within the job summary.
" }, "AccountId":{ "shape":"AccountId", @@ -2520,11 +2530,11 @@ "members":{ "BackupPlan":{ "shape":"BackupPlanInput", - "documentation":"Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
The body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.
" + "documentation":"The tags to assign to the backup plan.
" }, "CreatorRequestId":{ "shape":"string", @@ -2537,7 +2547,7 @@ "members":{ "BackupPlanId":{ "shape":"string", - "documentation":"Uniquely identifies a backup plan.
" + "documentation":"The ID of the backup plan.
" }, "BackupPlanArn":{ "shape":"ARN", @@ -2553,7 +2563,7 @@ }, "AdvancedBackupSettings":{ "shape":"AdvancedBackupSettings", - "documentation":"A list of BackupOptions settings for a resource type. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
The settings for a resource type. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
" } } }, @@ -2566,13 +2576,13 @@ "members":{ "BackupPlanId":{ "shape":"string", - "documentation":"Uniquely identifies the backup plan to be associated with the selection of resources.
", + "documentation":"The ID of the backup plan.
", "location":"uri", "locationName":"backupPlanId" }, "BackupSelection":{ "shape":"BackupSelection", - "documentation":"Specifies the body of a request to assign a set of resources to a backup plan.
" + "documentation":"The body of a request to assign a set of resources to a backup plan.
" }, "CreatorRequestId":{ "shape":"string", @@ -2589,7 +2599,7 @@ }, "BackupPlanId":{ "shape":"string", - "documentation":"Uniquely identifies a backup plan.
" + "documentation":"The ID of the backup plan.
" }, "CreationDate":{ "shape":"timestamp", @@ -2609,7 +2619,7 @@ }, "BackupVaultTags":{ "shape":"Tags", - "documentation":"Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.
" + "documentation":"The tags to assign to the backup vault.
" }, "EncryptionKeyArn":{ "shape":"ARN", @@ -2630,7 +2640,7 @@ }, "BackupVaultArn":{ "shape":"ARN", - "documentation":"An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
" + "documentation":"The controls that make up the framework. Each control in the list has a name, input parameters, and scope.
" }, "IdempotencyToken":{ "shape":"string", @@ -2664,7 +2674,7 @@ }, "FrameworkTags":{ "shape":"stringMap", - "documentation":"Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
" + "documentation":"The tags to assign to the framework.
" } } }, @@ -2690,11 +2700,11 @@ "members":{ "Title":{ "shape":"string", - "documentation":"This is the string title of the legal hold.
" + "documentation":"The title of the legal hold.
" }, "Description":{ "shape":"string", - "documentation":"This is the string description of the legal hold.
" + "documentation":"The description of the legal hold.
" }, "IdempotencyToken":{ "shape":"string", @@ -2702,7 +2712,7 @@ }, "RecoveryPointSelection":{ "shape":"RecoveryPointSelection", - "documentation":"This specifies criteria to assign a set of resources, such as resource types or backup vaults.
" + "documentation":"The criteria to assign a set of resources, such as resource types or backup vaults.
" }, "Tags":{ "shape":"Tags", @@ -2715,31 +2725,31 @@ "members":{ "Title":{ "shape":"string", - "documentation":"This is the string title of the legal hold returned after creating the legal hold.
" + "documentation":"The title of the legal hold.
" }, "Status":{ "shape":"LegalHoldStatus", - "documentation":"This displays the status of the legal hold returned after creating the legal hold. Statuses can be ACTIVE, PENDING, CANCELED, CANCELING, or FAILED.
The status of the legal hold.
" }, "Description":{ "shape":"string", - "documentation":"This is the returned string description of the legal hold.
" + "documentation":"The description of the legal hold.
" }, "LegalHoldId":{ "shape":"string", - "documentation":"Legal hold ID returned for the specified legal hold on a recovery point.
" + "documentation":"The ID of the legal hold.
" }, "LegalHoldArn":{ "shape":"ARN", - "documentation":"This is the ARN (Amazon Resource Number) of the created legal hold.
" + "documentation":"The Amazon Resource Name (ARN) of the legal hold.
" }, "CreationDate":{ "shape":"timestamp", - "documentation":"Time in number format when legal hold was created.
" + "documentation":"The time when the legal hold was created.
" }, "RecoveryPointSelection":{ "shape":"RecoveryPointSelection", - "documentation":"This specifies criteria to assign a set of resources, such as resource types or backup vaults.
" + "documentation":"The criteria to assign to a set of resources, such as resource types or backup vaults.
" } } }, @@ -2753,25 +2763,25 @@ "members":{ "BackupVaultName":{ "shape":"BackupVaultName", - "documentation":"This is the name of the vault that is being created.
", + "documentation":"The name of a logical container where backups are stored. Logically air-gapped backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
", "location":"uri", "locationName":"backupVaultName" }, "BackupVaultTags":{ "shape":"Tags", - "documentation":"These are the tags that will be included in the newly-created vault.
" + "documentation":"The tags to assign to the vault.
" }, "CreatorRequestId":{ "shape":"string", - "documentation":"This is the ID of the creation request.
This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
" + "documentation":"The ID of the creation request.
This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
" }, "MinRetentionDays":{ "shape":"Long", - "documentation":"This setting specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, no minimum retention period is enforced.
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 a job 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.
" + "documentation":"This setting specifies the minimum retention period that the vault retains its recovery points.
The minimum value accepted is 7 days.
" }, "MaxRetentionDays":{ "shape":"Long", - "documentation":"This is the setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Backup 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 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.
" + "documentation":"The maximum retention period that the vault retains its recovery points.
" } } }, @@ -2780,11 +2790,11 @@ "members":{ "BackupVaultName":{ "shape":"BackupVaultName", - "documentation":"The name of a logical container where backups are stored. Logically air-gapped backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
" + "documentation":"The name of a logical container where backups are stored. Logically air-gapped backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
" }, "BackupVaultArn":{ "shape":"ARN", - "documentation":"This is the ARN (Amazon Resource Name) of the vault being created.
" + "documentation":"The ARN (Amazon Resource Name) of the vault.
" }, "CreationDate":{ "shape":"timestamp", @@ -2792,7 +2802,7 @@ }, "VaultState":{ "shape":"VaultState", - "documentation":"This is the current state of the vault.
" + "documentation":"The current state of the vault.
" } } }, @@ -2822,7 +2832,7 @@ }, "ReportPlanTags":{ "shape":"stringMap", - "documentation":"Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
" + "documentation":"The tags to assign to the report plan.
" }, "IdempotencyToken":{ "shape":"string", @@ -2862,7 +2872,7 @@ }, "Tags":{ "shape":"SensitiveStringMap", - "documentation":"Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters,numbers, spaces, and the following characters: + - = . _ : /.
" + "documentation":"The tags to assign to the restore testing plan.
" } } }, @@ -2922,19 +2932,19 @@ "members":{ "CreationTime":{ "shape":"Timestamp", - "documentation":"This is the time the resource testing selection was created successfully.
" + "documentation":"The time that the resource testing selection was created.
" }, "RestoreTestingPlanArn":{ "shape":"String", - "documentation":"This is the ARN of the restore testing plan with which the restore testing selection is associated.
" + "documentation":"The ARN of the restore testing plan with which the restore testing selection is associated.
" }, "RestoreTestingPlanName":{ "shape":"String", - "documentation":"Unique string that is the name of the restore testing plan.
The name cannot be changed after creation. The name consists of only alphanumeric characters and underscores. Maximum length is 50.
" + "documentation":"The name of the restore testing plan.
The name cannot be changed after creation. The name consists of only alphanumeric characters and underscores. Maximum length is 50.
" }, "RestoreTestingSelectionName":{ "shape":"String", - "documentation":"This is the unique name of the restore testing selection that belongs to the related restore testing plan.
" + "documentation":"The name of the restore testing selection for the related restore testing plan.
" } } }, @@ -3029,7 +3039,7 @@ "members":{ "BackupVaultName":{ "shape":"string", - "documentation":"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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", + "documentation":"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 Amazon Web Services Region where they are created.
", "location":"uri", "locationName":"backupVaultName" } @@ -3053,7 +3063,7 @@ "members":{ "BackupVaultName":{ "shape":"BackupVaultName", - "documentation":"The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", + "documentation":"The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
", "location":"uri", "locationName":"backupVaultName" } @@ -3080,7 +3090,7 @@ "members":{ "BackupVaultName":{ "shape":"BackupVaultName", - "documentation":"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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", + "documentation":"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 Amazon Web Services Region where they are created.
", "location":"uri", "locationName":"backupVaultName" }, @@ -3180,11 +3190,11 @@ }, "BackupVaultName":{ "shape":"BackupVaultName", - "documentation":"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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
" + "documentation":"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 Amazon Web Services Region where they are created.
" }, "BackupVaultArn":{ "shape":"ARN", - "documentation":"An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
This is the non-unique name of the resource that belongs to the specified backup.
" + "documentation":"The non-unique name of the resource that belongs to the specified backup.
" }, "InitiationDate":{ "shape":"timestamp", - "documentation":"This is the date a backup job was initiated.
" + "documentation":"The date a backup job was initiated.
" }, "MessageCategory":{ "shape":"string", - "documentation":"This is the job count for the specified message category.
Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. View Monitoring for a list of accepted MessageCategory strings.
The job count for the specified message category.
Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. View Monitoring for a list of accepted MessageCategory strings.
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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", + "documentation":"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 Amazon Web Services Region where they are created.
", "location":"uri", "locationName":"backupVaultName" }, "BackupVaultAccountId":{ "shape":"string", - "documentation":"This is the account ID of the specified backup vault.
", + "documentation":"The account ID of the specified backup vault.
", "location":"querystring", "locationName":"backupVaultAccountId" } @@ -3303,15 +3313,19 @@ "members":{ "BackupVaultName":{ "shape":"string", - "documentation":"The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
" + "documentation":"The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
" }, "BackupVaultArn":{ "shape":"ARN", - "documentation":"An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
This is the type of vault described.
" + "documentation":"The type of vault described.
" + }, + "VaultState":{ + "shape":"VaultState", + "documentation":"The current state of the vault.->
" }, "EncryptionKeyArn":{ "shape":"ARN", @@ -3335,7 +3349,7 @@ }, "MinRetentionDays":{ "shape":"Long", - "documentation":"The 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.
" + "documentation":"The Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock will not enforce a minimum retention period.
If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.
" }, "MaxRetentionDays":{ "shape":"Long", @@ -3397,7 +3411,7 @@ }, "FrameworkControls":{ "shape":"FrameworkControls", - "documentation":"A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
" + "documentation":"The controls that make up the framework. Each control in the list has a name, input parameters, and scope.
" }, "CreationTime":{ "shape":"timestamp", @@ -3464,27 +3478,27 @@ }, "ResourceName":{ "shape":"string", - "documentation":"This is the non-unique name of the resource that belongs to the specified backup.
" + "documentation":"The name of the resource that belongs to the specified backup.
" }, "LastBackupVaultArn":{ "shape":"ARN", - "documentation":"This is the ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point.
" + "documentation":"The ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point.
" }, "LastRecoveryPointArn":{ "shape":"ARN", - "documentation":"This is the ARN (Amazon Resource Name) of the most recent recovery point.
" + "documentation":"The ARN (Amazon Resource Name) of the most recent recovery point.
" }, "LatestRestoreExecutionTimeMinutes":{ "shape":"Long", - "documentation":"This is the time in minutes the most recent restore job took to complete.
" + "documentation":"The time, in minutes, that the most recent restore job took to complete.
" }, "LatestRestoreJobCreationDate":{ "shape":"timestamp", - "documentation":"This is the creation date of the most recent restore job.
" + "documentation":"The creation date of the most recent restore job.
" }, "LatestRestoreRecoveryPointCreationDate":{ "shape":"timestamp", - "documentation":"This is the date the most recent recovery point was created.
" + "documentation":"The date the most recent recovery point was created.
" } } }, @@ -3497,7 +3511,7 @@ "members":{ "BackupVaultName":{ "shape":"BackupVaultName", - "documentation":"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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", + "documentation":"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 Amazon Web Services Region where they are created.
", "location":"uri", "locationName":"backupVaultName" }, @@ -3509,7 +3523,7 @@ }, "BackupVaultAccountId":{ "shape":"AccountId", - "documentation":"This is the account ID of the specified backup vault.
", + "documentation":"The account ID of the specified backup vault.
", "location":"querystring", "locationName":"backupVaultAccountId" } @@ -3524,15 +3538,15 @@ }, "BackupVaultName":{ "shape":"BackupVaultName", - "documentation":"The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
" + "documentation":"The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
" }, "BackupVaultArn":{ "shape":"ARN", - "documentation":"An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies the source vault where the resource was originally backed up in; for example, arn:aws:backup:us-east-1:123456789012:vault:BackupVault. If the recovery is restored to the same Amazon Web Services account or Region, this value will be null.
An Amazon Resource Name (ARN) that uniquely identifies the source vault where the resource was originally backed up in; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault. If the recovery is restored to the same Amazon Web Services account or Region, this value will be null.
A status code specifying the state of the recovery point.
PARTIAL status indicates Backup could not create the recovery point before the backup window closed. To increase your backup plan window using the API, see UpdateBackupPlan. You can also increase your backup plan window using the Console by choosing and editing your backup plan.
EXPIRED status indicates that the recovery point has exceeded its retention period, but Backup lacks permission or is otherwise unable to delete it. To manually delete these recovery points, see Step 3: Delete the recovery points in the Clean up resources section of Getting started.
STOPPED status occurs on a continuous backup where a user has taken some action that causes the continuous backup to be disabled. This can be caused by the removal of permissions, turning off versioning, turning off events being sent to EventBridge, or disabling the EventBridge rules that are put in place by Backup.
To resolve STOPPED status, ensure that all requested permissions are in place and that versioning is enabled on the S3 bucket. Once these conditions are met, the next instance of a backup rule running will result in a new continuous recovery point being created. The recovery points with STOPPED status do not need to be deleted.
For SAP HANA on Amazon EC2 STOPPED status occurs due to user action, application misconfiguration, or backup failure. To ensure that future continuous backups succeed, refer to the recovery point status and check SAP HANA for details.
A status code specifying the state of the recovery point.
PARTIAL status indicates Backup could not create the recovery point before the backup window closed. To increase your backup plan window using the API, see UpdateBackupPlan. You can also increase your backup plan window using the Console by choosing and editing your backup plan.
EXPIRED status indicates that the recovery point has exceeded its retention period, but Backup lacks permission or is otherwise unable to delete it. To manually delete these recovery points, see Step 3: Delete the recovery points in the Clean up resources section of Getting started.
STOPPED status occurs on a continuous backup where a user has taken some action that causes the continuous backup to be disabled. This can be caused by the removal of permissions, turning off versioning, turning off events being sent to EventBridge, or disabling the EventBridge rules that are put in place by Backup. For recovery points of Amazon S3, Amazon RDS, and Amazon Aurora resources, this status occurs when the retention period of a continuous backup rule is changed.
To resolve STOPPED status, ensure that all requested permissions are in place and that versioning is enabled on the S3 bucket. Once these conditions are met, the next instance of a backup rule running will result in a new continuous recovery point being created. The recovery points with STOPPED status do not need to be deleted.
For SAP HANA on Amazon EC2 STOPPED status occurs due to user action, application misconfiguration, or backup failure. To ensure that future continuous backups succeed, refer to the recovery point status and check SAP HANA for details.
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.
Backups that are transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
" + "documentation":"The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.
Backups that are transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.
" }, "EncryptionKeyArn":{ "shape":"ARN", @@ -3600,7 +3614,7 @@ }, "CompositeMemberIdentifier":{ "shape":"string", - "documentation":"This is 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 within a stack.
" + "documentation":"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 within a stack.
" }, "IsParent":{ "shape":"boolean", @@ -3608,11 +3622,11 @@ }, "ResourceName":{ "shape":"string", - "documentation":"This is the non-unique name of the resource that belongs to the specified backup.
" + "documentation":"The name of the resource that belongs to the specified backup.
" }, "VaultType":{ "shape":"VaultType", - "documentation":"This is the type of vault in which the described recovery point is stored.
" + "documentation":"The type of vault in which the described recovery point is stored.
" } } }, @@ -3626,11 +3640,11 @@ "members":{ "ResourceTypeOptInPreference":{ "shape":"ResourceTypeOptInPreference", - "documentation":"Returns a list of all services along with the opt-in preferences in the Region.
" + "documentation":"The services along with the opt-in preferences in the Region.
" }, "ResourceTypeManagementPreference":{ "shape":"ResourceTypeManagementPreference", - "documentation":"Returns whether Backup fully manages the backups for a resource type.
For the benefits of full Backup management, see Full Backup management.
For a list of resource types and whether each supports full Backup management, see the Feature availability by resource table.
If \"DynamoDB\":false, you can enable full Backup management for DynamoDB backup by enabling Backup's advanced DynamoDB backup features.
Returns whether Backup fully manages the backups for a resource type.
For the benefits of full Backup management, see Full Backup management.
For a list of resource types and whether each supports full Backup management, see the Feature availability by resource table.
If \"DynamoDB\":false, you can enable full Backup management for DynamoDB backup by enabling Backup's advanced DynamoDB backup features.
A list of information about a report job, including its completion and creation times, report destination, unique report job ID, Amazon Resource Name (ARN), report template, status, and status message.
" + "documentation":"The information about a report job, including its completion and creation times, report destination, unique report job ID, Amazon Resource Name (ARN), report template, status, and status message.
" } } }, @@ -3737,7 +3751,7 @@ }, "CreatedResourceArn":{ "shape":"ARN", - "documentation":"An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored. The format of the ARN depends on the resource type of the backed-up resource.
" + "documentation":"The Amazon Resource Name (ARN) of the resource that was created by the restore job.
The format of the ARN depends on the resource type of the backed-up resource.
" }, "ResourceType":{ "shape":"ResourceType", @@ -3745,7 +3759,7 @@ }, "RecoveryPointCreationDate":{ "shape":"timestamp", - "documentation":"This is the creation date of the recovery point made by the specifed restore job.
" + "documentation":"The creation date of the recovery point made by the specifed restore job.
" }, "CreatedBy":{ "shape":"RestoreJobCreator", @@ -3753,15 +3767,15 @@ }, "ValidationStatus":{ "shape":"RestoreValidationStatus", - "documentation":"This is the status of validation run on the indicated restore job.
" + "documentation":"The status of validation run on the indicated restore job.
" }, "ValidationStatusMessage":{ "shape":"string", - "documentation":"This describes the status of validation run on the indicated restore job.
" + "documentation":"The status message.
" }, "DeletionStatus":{ "shape":"RestoreDeletionStatus", - "documentation":"This notes the status of the data generated by the restore test. The status may be Deleting, Failed, or Successful.
The status of the data generated by the restore test.
" }, "DeletionStatusMessage":{ "shape":"string", @@ -3778,13 +3792,13 @@ "members":{ "BackupVaultName":{ "shape":"BackupVaultName", - "documentation":"This is the name of a logical container where the child (nested) recovery point is stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", + "documentation":"The name of a logical container where the child (nested) recovery point is stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
", "location":"uri", "locationName":"backupVaultName" }, "RecoveryPointArn":{ "shape":"ARN", - "documentation":"This is the Amazon Resource Name (ARN) that uniquely identifies the child (nested) recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
The Amazon Resource Name (ARN) that uniquely identifies the child (nested) recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
A list of ParameterName and ParameterValue pairs.
The name/value pairs.
" }, "ControlScope":{ "shape":"ControlScope", @@ -3996,7 +4010,7 @@ }, "LastExecutionDate":{ "shape":"timestamp", - "documentation":"The last time a job to back up resources was run with this backup 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.
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.
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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", + "documentation":"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 Amazon Web Services Region where they are created.
", "location":"uri", "locationName":"backupVaultName" } @@ -4067,11 +4081,11 @@ "members":{ "BackupVaultName":{ "shape":"BackupVaultName", - "documentation":"The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
" + "documentation":"The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
" }, "BackupVaultArn":{ "shape":"ARN", - "documentation":"An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", + "documentation":"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 Amazon Web Services Region where they are created.
", "location":"uri", "locationName":"backupVaultName" } @@ -4096,11 +4110,11 @@ "members":{ "BackupVaultName":{ "shape":"BackupVaultName", - "documentation":"The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
" + "documentation":"The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
" }, "BackupVaultArn":{ "shape":"ARN", - "documentation":"An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
This is the ID required to use GetLegalHold. This unique ID is associated with a specific legal hold.
The ID of the legal hold.
", "location":"uri", "locationName":"legalHoldId" } @@ -4129,43 +4143,43 @@ "members":{ "Title":{ "shape":"string", - "documentation":"This is the string title of the legal hold.
" + "documentation":"The title of the legal hold.
" }, "Status":{ "shape":"LegalHoldStatus", - "documentation":"This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.
The status of the legal hold.
" }, "Description":{ "shape":"string", - "documentation":"This is the returned string description of the legal hold.
" + "documentation":"The description of the legal hold.
" }, "CancelDescription":{ "shape":"string", - "documentation":"String describing the reason for removing the legal hold.
" + "documentation":"The reason for removing the legal hold.
" }, "LegalHoldId":{ "shape":"string", - "documentation":"This is the returned ID associated with a specified legal hold.
" + "documentation":"The ID of the legal hold.
" }, "LegalHoldArn":{ "shape":"ARN", - "documentation":"This is the returned framework ARN for the specified legal hold. An Amazon Resource Name (ARN) uniquely identifies a resource. The format of the ARN depends on the resource type.
" + "documentation":"The framework ARN for the specified legal hold. The format of the ARN depends on the resource type.
" }, "CreationDate":{ "shape":"timestamp", - "documentation":"Time in number format when legal hold was created.
" + "documentation":"The time when the legal hold was created.
" }, "CancellationDate":{ "shape":"timestamp", - "documentation":"Time in number when legal hold was cancelled.
" + "documentation":"The time when the legal hold was cancelled.
" }, "RetainRecordUntil":{ "shape":"timestamp", - "documentation":"This is the date and time until which the legal hold record will be retained.
" + "documentation":"The date and time until which the legal hold record is retained.
" }, "RecoveryPointSelection":{ "shape":"RecoveryPointSelection", - "documentation":"This specifies criteria to assign a set of resources, such as resource types or backup vaults.
" + "documentation":"The criteria to assign a set of resources, such as resource types or backup vaults.
" } } }, @@ -4178,7 +4192,7 @@ "members":{ "BackupVaultName":{ "shape":"BackupVaultName", - "documentation":"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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", + "documentation":"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 Amazon Web Services Region where they are created.
", "location":"uri", "locationName":"backupVaultName" }, @@ -4190,7 +4204,7 @@ }, "BackupVaultAccountId":{ "shape":"AccountId", - "documentation":"This is the account ID of the specified backup vault.
", + "documentation":"The account ID of the specified backup vault.
", "location":"querystring", "locationName":"backupVaultAccountId" } @@ -4201,7 +4215,7 @@ "members":{ "BackupVaultArn":{ "shape":"ARN", - "documentation":"An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
This is the resource type associated with the recovery point.
" + "documentation":"The resource type of the recovery point.
" } } }, @@ -4251,7 +4265,7 @@ "members":{ "BackupVaultAccountId":{ "shape":"String", - "documentation":"This is the account ID of the specified backup vault.
", + "documentation":"The account ID of the specified backup vault.
", "location":"querystring", "locationName":"BackupVaultAccountId" }, @@ -4337,7 +4351,7 @@ "members":{ "ResourceTypes":{ "shape":"ResourceTypes", - "documentation":"Contains a string with the supported Amazon Web Services resource types:
Aurora for Amazon Aurora
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
RDS for Amazon Relational Database Service
Storage Gateway for Storage Gateway
DocDB for Amazon DocumentDB (with MongoDB compatibility)
Neptune for Amazon Neptune
Contains a string with the supported Amazon Web Services resource types:
Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
RDS for Amazon Relational Database Service
Redshift for Amazon Redshift
S3 for Amazon Simple Storage Service (Amazon S3)
SAP HANA on Amazon EC2 for SAP HANA databases on Amazon Elastic Compute Cloud instances
Storage Gateway for Storage Gateway
Timestream for Amazon Timestream
VirtualMachine for VMware virtual machines
This is the title of a legal hold.
" + "documentation":"The title of a legal hold.
" }, "Status":{ "shape":"LegalHoldStatus", - "documentation":"This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.
The status of the legal hold.
" }, "Description":{ "shape":"string", - "documentation":"This is the description of a legal hold.
" + "documentation":"The description of a legal hold.
" }, "LegalHoldId":{ "shape":"string", - "documentation":"ID of specific legal hold on one or more recovery points.
" + "documentation":"The ID of the legal hold.
" }, "LegalHoldArn":{ "shape":"ARN", - "documentation":"This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
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.
This is the time in number format when legal hold was created.
" + "documentation":"The time when the legal hold was created.
" }, "CancellationDate":{ "shape":"timestamp", - "documentation":"This is the time in number format when legal hold was cancelled.
" + "documentation":"The time when the legal hold was cancelled.
" } }, "documentation":"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.
" @@ -4476,18 +4490,18 @@ "members":{ "MoveToColdStorageAfterDays":{ "shape":"Long", - "documentation":"Specifies the number of days after creation that a recovery point is moved to cold storage.
" + "documentation":"The number of days after creation that a recovery point is moved to cold storage.
" }, "DeleteAfterDays":{ "shape":"Long", - "documentation":"Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.
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.
Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
" + "documentation":"If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
" } }, - "documentation":"Contains an array of Transition objects specifying how long 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 cannot be changed after a backup has been transitioned to cold.
Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
" + "documentation":"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 table. 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.
This is the period that sets the boundaries for returned results.
Acceptable values include
ONE_DAY for daily job count for the prior 14 days.
SEVEN_DAYS for the aggregated job count for the prior 7 days.
FOURTEEN_DAYS for aggregated job count for prior 14 days.
The period for the returned results.
ONE_DAY - The daily job count for the prior 14 days.
SEVEN_DAYS - The aggregated job count for the prior 7 days.
FOURTEEN_DAYS - The aggregated job count for prior 14 days.
This parameter sets the maximum number of items to be returned.
The value is an integer. Range of accepted values is from 1 to 500.
", + "documentation":"The maximum number of items to be returned.
The value is an integer. Range of accepted values is from 1 to 500.
", "location":"querystring", "locationName":"MaxResults" }, @@ -4558,11 +4572,11 @@ "members":{ "BackupJobSummaries":{ "shape":"BackupJobSummaryList", - "documentation":"This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
" + "documentation":"The summary information.
" }, "AggregationPeriod":{ "shape":"string", - "documentation":"This is the period that sets the boundaries for returned results.
ONE_DAY for daily job count for the prior 14 days.
SEVEN_DAYS for the aggregated job count for the prior 7 days.
FOURTEEN_DAYS for aggregated job count for prior 14 days.
The period for the returned results.
ONE_DAY - The daily job count for the prior 14 days.
SEVEN_DAYS - The aggregated job count for the prior 7 days.
FOURTEEN_DAYS - The aggregated job count for prior 14 days.
Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", + "documentation":"Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
", "location":"querystring", "locationName":"backupVaultName" }, @@ -4617,7 +4631,7 @@ }, "ByResourceType":{ "shape":"ResourceType", - "documentation":"Returns only backup jobs for the specified resources:
Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
Redshift for Amazon Redshift
RDS for Amazon Relational Database Service
SAP HANA on Amazon EC2 for SAP HANA databases
Storage Gateway for Storage Gateway
S3 for Amazon S3
Timestream for Amazon Timestream
VirtualMachine for virtual machines
Returns only backup jobs for the specified resources:
Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
RDS for Amazon Relational Database Service
Redshift for Amazon Redshift
S3 for Amazon Simple Storage Service (Amazon S3)
SAP HANA on Amazon EC2 for SAP HANA databases on Amazon Elastic Compute Cloud instances
Storage Gateway for Storage Gateway
Timestream for Amazon Timestream
VirtualMachine for VMware virtual machines
The maximum number of items to be returned.
", + "documentation":"The maximum number of items to return.
", "location":"querystring", "locationName":"maxResults" } @@ -4765,7 +4779,7 @@ }, "BackupPlansList":{ "shape":"BackupPlansList", - "documentation":"An array of backup plan list items containing metadata about your saved backup plans.
" + "documentation":"Information about the backup plans.
" } } }, @@ -4877,7 +4891,7 @@ }, "AggregationPeriod":{ "shape":"AggregationPeriod", - "documentation":"This is the period that sets the boundaries for returned results.
ONE_DAY for daily job count for the prior 14 days.
SEVEN_DAYS for the aggregated job count for the prior 7 days.
FOURTEEN_DAYS for aggregated job count for prior 14 days.
The period for the returned results.
ONE_DAY - The daily job count for the prior 14 days.
SEVEN_DAYS - The aggregated job count for the prior 7 days.
FOURTEEN_DAYS - The aggregated job count for prior 14 days.
This is the period that sets the boundaries for returned results.
ONE_DAY for daily job count for the prior 14 days.
SEVEN_DAYS for the aggregated job count for the prior 7 days.
FOURTEEN_DAYS for aggregated job count for prior 14 days.
The period for the returned results.
ONE_DAY - The daily job count for the prior 14 days.
SEVEN_DAYS - The aggregated job count for the prior 7 days.
FOURTEEN_DAYS - The aggregated job count for prior 14 days.
Returns only backup jobs for the specified resources:
Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
Redshift for Amazon Redshift
RDS for Amazon Relational Database Service
SAP HANA on Amazon EC2 for SAP HANA databases
Storage Gateway for Storage Gateway
S3 for Amazon S3
Timestream for Amazon Timestream
VirtualMachine for virtual machines
Returns only backup jobs for the specified resources:
Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
RDS for Amazon Relational Database Service
Redshift for Amazon Redshift
S3 for Amazon Simple Storage Service (Amazon S3)
SAP HANA on Amazon EC2 for SAP HANA databases on Amazon Elastic Compute Cloud instances
Storage Gateway for Storage Gateway
Timestream for Amazon Timestream
VirtualMachine for VMware virtual machines
An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
A list of frameworks with details for each framework, including the framework name, Amazon Resource Name (ARN), description, number of controls, creation time, and deployment status.
" + "documentation":"The frameworks with details for each framework, including the framework name, Amazon Resource Name (ARN), description, number of controls, creation time, and deployment status.
" }, "NextToken":{ "shape":"string", @@ -5078,13 +5092,13 @@ "members":{ "BackupVaultName":{ "shape":"BackupVaultName", - "documentation":"This is the list of protected resources by backup vault within the vault(s) you specify by name.
", + "documentation":"The list of protected resources by backup vault within the vault(s) you specify by name.
", "location":"uri", "locationName":"backupVaultName" }, "BackupVaultAccountId":{ "shape":"AccountId", - "documentation":"This is the list of protected resources by backup vault within the vault(s) you specify by account ID.
", + "documentation":"The list of protected resources by backup vault within the vault(s) you specify by account ID.
", "location":"querystring", "locationName":"backupVaultAccountId" }, @@ -5151,7 +5165,7 @@ "members":{ "BackupVaultName":{ "shape":"BackupVaultName", - "documentation":"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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
Backup vault name might not be available when a supported service creates the backup.
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 Amazon Web Services Region where they are created.
Backup vault name might not be available when a supported service creates the backup.
Returns only recovery points that match the specified resource type(s):
Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
Redshift for Amazon Redshift
RDS for Amazon Relational Database Service
SAP HANA on Amazon EC2 for SAP HANA databases
Storage Gateway for Storage Gateway
S3 for Amazon S3
Timestream for Amazon Timestream
VirtualMachine for virtual machines
Returns only recovery points that match the specified resource type(s):
Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
RDS for Amazon Relational Database Service
Redshift for Amazon Redshift
S3 for Amazon Simple Storage Service (Amazon S3)
SAP HANA on Amazon EC2 for SAP HANA databases on Amazon Elastic Compute Cloud instances
Storage Gateway for Storage Gateway
Timestream for Amazon Timestream
VirtualMachine for VMware virtual machines
This is the ID of the legal hold.
", + "documentation":"The ID of the legal hold.
", "location":"uri", "locationName":"legalHoldId" }, "NextToken":{ "shape":"string", - "documentation":"This is the next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
This is the maximum number of resource list items to be returned.
", + "documentation":"The maximum number of resource list items to be returned.
", "location":"querystring", "locationName":"maxResults" } @@ -5253,11 +5267,11 @@ "members":{ "RecoveryPoints":{ "shape":"RecoveryPointsList", - "documentation":"This is a list of the recovery points returned by ListRecoveryPointsByLegalHold.
The recovery points.
" }, "NextToken":{ "shape":"string", - "documentation":"This return is the next item following a partial list of returned resources.
" + "documentation":"The next item following a partial list of returned resources.
" } } }, @@ -5380,7 +5394,7 @@ "members":{ "ReportPlans":{ "shape":"ReportPlanList", - "documentation":"A list of your report plans with detailed information for each plan. This information includes the Amazon Resource Name (ARN), report plan name, description, settings, delivery channel, deployment status, creation time, and last times the report plan attempted to and successfully ran.
" + "documentation":"The report plans with detailed information for each plan. This information includes the Amazon Resource Name (ARN), report plan name, description, settings, delivery channel, deployment status, creation time, and last times the report plan attempted to and successfully ran.
" }, "NextToken":{ "shape":"string", @@ -5411,7 +5425,7 @@ }, "AggregationPeriod":{ "shape":"AggregationPeriod", - "documentation":"This is the period that sets the boundaries for returned results.
Acceptable values include
ONE_DAY for daily job count for the prior 14 days.
SEVEN_DAYS for the aggregated job count for the prior 7 days.
FOURTEEN_DAYS for aggregated job count for prior 14 days.
The period for the returned results.
ONE_DAY - The daily job count for the prior 14 days.
SEVEN_DAYS - The aggregated job count for the prior 7 days.
FOURTEEN_DAYS - The aggregated job count for prior 14 days.
This is the period that sets the boundaries for returned results.
ONE_DAY for daily job count for the prior 14 days.
SEVEN_DAYS for the aggregated job count for the prior 7 days.
FOURTEEN_DAYS for aggregated job count for prior 14 days.
The period for the returned results.
ONE_DAY - The daily job count for the prior 14 days.
SEVEN_DAYS - The aggregated job count for the prior 7 days.
FOURTEEN_DAYS - The aggregated job count for prior 14 days.
Include this parameter to return only restore jobs for the specified resources:
Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
Redshift for Amazon Redshift
RDS for Amazon Relational Database Service
SAP HANA on Amazon EC2 for SAP HANA databases
Storage Gateway for Storage Gateway
S3 for Amazon S3
Timestream for Amazon Timestream
VirtualMachine for virtual machines
Include this parameter to return only restore jobs for the specified resources:
Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
RDS for Amazon Relational Database Service
Redshift for Amazon Redshift
S3 for Amazon Simple Storage Service (Amazon S3)
SAP HANA on Amazon EC2 for SAP HANA databases on Amazon Elastic Compute Cloud instances
Storage Gateway for Storage Gateway
Timestream for Amazon Timestream
VirtualMachine for VMware virtual machines
To help organize your resources, you can assign your own metadata to the resources you create. Each tag is a key-value pair.
" + "documentation":"Information about the tags.
" } } }, @@ -5753,15 +5767,15 @@ }, "ResourceName":{ "shape":"string", - "documentation":"This is the non-unique name of the resource that belongs to the specified backup.
" + "documentation":"The non-unique name of the resource that belongs to the specified backup.
" }, "LastBackupVaultArn":{ "shape":"ARN", - "documentation":"This is the ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point.
" + "documentation":"The ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point.
" }, "LastRecoveryPointArn":{ "shape":"ARN", - "documentation":"This is the ARN (Amazon Resource Name) of the most recent recovery point.
" + "documentation":"The ARN (Amazon Resource Name) of the most recent recovery point.
" } }, "documentation":"A structure that contains information about a backed-up resource.
" @@ -5778,7 +5792,7 @@ "documentation":"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.\"
" } }, - "documentation":"A list of conditions that you define for resources in your restore testing plan using tags.
For example, \"StringEquals\": { \"Key\": \"aws:ResourceTag/CreatedByCryo\", \"Value\": \"true\" },. Condition operators are case sensitive.
The conditions that you define for resources in your restore testing plan using tags.
" }, "ProtectedResourcesList":{ "type":"list", @@ -5790,7 +5804,7 @@ "members":{ "BackupVaultName":{ "shape":"BackupVaultName", - "documentation":"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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", + "documentation":"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 Amazon Web Services Region where they are created.
", "location":"uri", "locationName":"backupVaultName" }, @@ -5812,7 +5826,7 @@ }, "MinRetentionDays":{ "shape":"Long", - "documentation":"The Backup Vault Lock configuration that specifies the minimum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to retain certain data for at least seven years (2555 days).
If this parameter is not specified, Vault Lock will not enforce a minimum retention period.
If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails that backup or copy job, and you should either modify your lifecycle settings or use a different vault. The shortest minimum retention period you can specify is 1 day. Recovery points already saved in the vault prior to Vault Lock are not affected.
" + "documentation":"The Backup Vault Lock configuration that specifies the minimum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to retain certain data for at least seven years (2555 days).
This parameter is required when a vault lock is created through CloudFormation; otherwise, this parameter is optional. If this parameter is not specified, Vault Lock will not enforce a minimum retention period.
If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails that backup or copy job, and you should either modify your lifecycle settings or use a different vault. The shortest minimum retention period you can specify is 1 day. Recovery points already saved in the vault prior to Vault Lock are not affected.
" }, "MaxRetentionDays":{ "shape":"Long", @@ -5834,7 +5848,7 @@ "members":{ "BackupVaultName":{ "shape":"BackupVaultName", - "documentation":"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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", + "documentation":"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 Amazon Web Services Region where they are created.
", "location":"uri", "locationName":"backupVaultName" }, @@ -5844,7 +5858,7 @@ }, "BackupVaultEvents":{ "shape":"BackupVaultEvents", - "documentation":"An array of events that indicate the status of jobs to back up resources to the backup vault.
For common use cases and code samples, see Using Amazon SNS to track Backup events.
The following events are supported:
BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED
COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED
RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RECOVERY_POINT_MODIFIED
S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED
The list below shows items that are deprecated events (for reference) and are no longer in use. They are no longer supported and will not return statuses or notifications. Refer to the list above for current supported events.
An array of events that indicate the status of jobs to back up resources to the backup vault.
For common use cases and code samples, see Using Amazon SNS to track Backup events.
The following events are supported:
BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED
COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED
RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RECOVERY_POINT_MODIFIED
S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED
The list below includes both supported events and deprecated events that are no longer in use (for reference). Deprecated events do not return statuses or notifications. Refer to the list above for the supported events.
This is the status of your restore validation.
" + "documentation":"The status of your restore validation.
" }, "ValidationStatusMessage":{ "shape":"string", @@ -5880,11 +5894,11 @@ }, "BackupVaultName":{ "shape":"BackupVaultName", - "documentation":"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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
" + "documentation":"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 Amazon Web Services Region where they are created.
" }, "BackupVaultArn":{ "shape":"ARN", - "documentation":"An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
A message explaining the reason of the recovery point deletion failure.
" + "documentation":"A message explaining the current status of the recovery point.
" }, "CreationDate":{ "shape":"timestamp", @@ -5932,7 +5946,7 @@ }, "Lifecycle":{ "shape":"Lifecycle", - "documentation":"The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
" + "documentation":"The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 table. Backup ignores this expression for other resource types.
" }, "EncryptionKeyArn":{ "shape":"ARN", @@ -5948,11 +5962,11 @@ }, "ParentRecoveryPointArn":{ "shape":"ARN", - "documentation":"This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.
" + "documentation":"The Amazon Resource Name (ARN) of the parent (composite) recovery point.
" }, "CompositeMemberIdentifier":{ "shape":"string", - "documentation":"This is 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 within a stack.
" + "documentation":"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 within a stack.
" }, "IsParent":{ "shape":"boolean", @@ -5960,11 +5974,11 @@ }, "ResourceName":{ "shape":"string", - "documentation":"This is the non-unique name of the resource that belongs to the specified backup.
" + "documentation":"The non-unique name of the resource that belongs to the specified backup.
" }, "VaultType":{ "shape":"VaultType", - "documentation":"This is the type of vault in which the described recovery point is stored.
" + "documentation":"The type of vault in which the described recovery point is stored.
" } }, "documentation":"Contains detailed information about the recovery points stored in a backup vault.
" @@ -5990,7 +6004,7 @@ }, "StatusMessage":{ "shape":"string", - "documentation":"A message explaining the reason of the recovery point deletion failure.
" + "documentation":"A message explaining the current status of the recovery point.
" }, "EncryptionKeyArn":{ "shape":"ARN", @@ -6002,7 +6016,7 @@ }, "BackupVaultName":{ "shape":"BackupVaultName", - "documentation":"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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
" + "documentation":"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 Amazon Web Services Region where they are created.
" }, "IsParent":{ "shape":"boolean", @@ -6010,15 +6024,15 @@ }, "ParentRecoveryPointArn":{ "shape":"ARN", - "documentation":"This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.
" + "documentation":"The Amazon Resource Name (ARN) of the parent (composite) recovery point.
" }, "ResourceName":{ "shape":"string", - "documentation":"This is the non-unique name of the resource that belongs to the specified backup.
" + "documentation":"The non-unique name of the resource that belongs to the specified backup.
" }, "VaultType":{ "shape":"VaultType", - "documentation":"This is the type of vault in which the described recovery point is stored.
" + "documentation":"The type of vault in which the described recovery point is stored.
" } }, "documentation":"Contains detailed information about a saved recovery point.
" @@ -6054,19 +6068,19 @@ "members":{ "RecoveryPointArn":{ "shape":"ARN", - "documentation":"This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.
" + "documentation":"The Amazon Resource Name (ARN) of the parent (composite) recovery point.
" }, "ResourceArn":{ "shape":"ARN", - "documentation":"This is the Amazon Resource Name (ARN) that uniquely identifies a saved resource.
" + "documentation":"The Amazon Resource Name (ARN) that uniquely identifies a saved resource.
" }, "ResourceType":{ "shape":"ResourceType", - "documentation":"This is the Amazon Web Services resource type that is saved as a recovery point.
" + "documentation":"The Amazon Web Services resource type that is saved as a recovery point.
" }, "BackupVaultName":{ "shape":"BackupVaultName", - "documentation":"This is the name of the backup vault (the logical container in which backups are stored).
" + "documentation":"The name of the backup vault (the logical container in which backups are stored).
" } }, "documentation":"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.
" @@ -6114,7 +6128,7 @@ }, "Formats":{ "shape":"FormatList", - "documentation":"A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.
The format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.
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.
" @@ -6252,7 +6266,7 @@ }, "Accounts":{ "shape":"stringList", - "documentation":"These are the accounts to be included in the report.
" + "documentation":"These are the accounts to be included in the report.
Use string value of ROOT to include all organizational units.
These are the Regions to be included in the report.
" + "documentation":"These are the Regions to be included in the report.
Use the wildcard as the string value to include all Regions.
" } }, "documentation":"Contains detailed information about a report setting.
" @@ -6437,7 +6451,7 @@ }, "IamRoleArn":{ "shape":"IAMRoleArn", - "documentation":"Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
The IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
This is the status of validation run on the indicated restore job.
" + "documentation":"The status of validation run on the indicated restore job.
" }, "ValidationStatusMessage":{ "shape":"string", @@ -6488,7 +6502,7 @@ "members":{ "RecoveryPointSelection":{ "shape":"RestoreTestingRecoveryPointSelection", - "documentation":"Required: Algorithm; Required: Recovery point types; IncludeVaults (one or more). Optional: SelectionWindowDays ('30' if not specified); ExcludeVaults (list of selectors), defaults to empty list if not listed.
" + "documentation":" 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 [\"*\"] 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.
This is the restore testing plan name.
" + "documentation":"The restore testing plan name.
" }, "ScheduleExpression":{ "shape":"String", @@ -6589,7 +6603,7 @@ }, "RestoreTestingPlanName":{ "shape":"String", - "documentation":"This is the restore testing plan name.
" + "documentation":"The restore testing plan name.
" }, "ScheduleExpression":{ "shape":"String", @@ -6649,14 +6663,14 @@ }, "RecoveryPointTypes":{ "shape":"RestoreTestingRecoveryPointTypeList", - "documentation":"These are the types of recovery points.
" + "documentation":"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.
Accepted values are integers from 1 to 365.
" } }, - "documentation":"Required: Algorithm; Required: Recovery point types; IncludeVaults(one or more). Optional: SelectionWindowDays ('30' if not specified);ExcludeVaults (list of selectors), defaults to empty list if not listed.
" + "documentation":" 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 [\"*\"] 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.
This is the unique name of the restore testing selection that belongs to the related restore testing plan.
" + "documentation":"The unique name of the restore testing selection that belongs to the related restore testing plan.
" }, "ValidationWindowHours":{ "shape":"integer", @@ -6759,7 +6773,7 @@ }, "RestoreTestingSelectionName":{ "shape":"String", - "documentation":"This is the unique name of the restore testing selection that belongs to the related restore testing plan.
" + "documentation":"The unique name of the restore testing selection that belongs to the related restore testing plan.
" }, "ValidationWindowHours":{ "shape":"integer", @@ -6780,7 +6794,7 @@ "members":{ "CreationTime":{ "shape":"Timestamp", - "documentation":"This is 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.
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.
A list of conditions that you define for resources in your restore testing plan using tags.
For example, \"StringEquals\": { \"Key\": \"aws:ResourceTag/CreatedByCryo\", \"Value\": \"true\" },. Condition operators are case sensitive.
The conditions that you define for resources in your restore testing plan using tags.
" }, "RestoreMetadataOverrides":{ "shape":"SensitiveStringMap", @@ -6878,7 +6892,7 @@ "members":{ "BackupVaultName":{ "shape":"BackupVaultName", - "documentation":"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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
" + "documentation":"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 Amazon Web Services Region where they are created.
" }, "ResourceArn":{ "shape":"ARN", @@ -6902,15 +6916,15 @@ }, "Lifecycle":{ "shape":"Lifecycle", - "documentation":"The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
This parameter has a maximum value of 100 years (36,500 days).
" + "documentation":"The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.
This parameter has a maximum value of 100 years (36,500 days).
" }, "RecoveryPointTags":{ "shape":"Tags", - "documentation":"To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
" + "documentation":"The tags to assign to the resources.
" }, "BackupOptions":{ "shape":"BackupOptions", - "documentation":"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. The WindowsVSS option is not enabled by default.
The backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
Valid values: Set to \"WindowsVSS\":\"enabled\" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to \"WindowsVSS\"\"disabled\" to create a regular backup. The WindowsVSS option is not enabled by default.
The name of a logical source container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
" + "documentation":"The name of a logical source container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
" }, "DestinationBackupVaultArn":{ "shape":"ARN", - "documentation":"An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to copy to; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to copy to; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.
You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.
You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:
file-system-id: The ID of the Amazon EFS file system that is backed up by Backup. Returned in GetRecoveryPointRestoreMetadata.
Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.
KmsKeyId: Specifies the Amazon Web Services KMS key that is used to encrypt the restored file system. You can specify a key from another Amazon Web Services account provided that key it is properly shared with your account via Amazon Web Services KMS.
PerformanceMode: Specifies the throughput mode of the file system.
CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.
newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.
ItemsToRestore: An array of one to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional. For example, \"itemsToRestore\":\"[\\\"/my.test\\\"]\".
A set of metadata key-value pairs.
You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.
For more information about the metadata for each resource, see the following:
Starts a job to restore a recovery point for one of the following resources:
Aurora for Amazon Aurora
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
CloudFormation for CloudFormation
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
Redshift for Amazon Redshift
Storage Gateway for Storage Gateway
S3 for Amazon S3
Timestream for Amazon Timestream
VirtualMachine for virtual machines
Starts a job to restore a recovery point for one of the following resources:
Aurora - Amazon Aurora
DocumentDB - Amazon DocumentDB
CloudFormation - CloudFormation
DynamoDB - Amazon DynamoDB
EBS - Amazon Elastic Block Store
EC2 - Amazon Elastic Compute Cloud
EFS - Amazon Elastic File System
FSx - Amazon FSx
Neptune - Amazon Neptune
RDS - Amazon Relational Database Service
Redshift - Amazon Redshift
Storage Gateway - Storage Gateway
S3 - Amazon Simple Storage Service
Timestream - Amazon Timestream
VirtualMachine - Virtual machines
An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.
", + "documentation":"An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.
ARNs that do not include backup are incompatible with tagging. TagResource and UntagResource with invalid ARNs will result in an error. Acceptable ARN content can include arn:aws:backup:us-east. Invalid ARN content may look like arn:aws:ec2:us-east.
An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.
", + "documentation":"An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.
ARNs that do not include backup are incompatible with tagging. TagResource and UntagResource with invalid ARNs will result in an error. Acceptable ARN content can include arn:aws:backup:us-east. Invalid ARN content may look like arn:aws:ec2:us-east.
A list of keys to identify which key-value tags to remove from a resource.
" + "documentation":"The keys to identify which key-value tags to remove from a resource.
" } } }, @@ -7135,13 +7149,13 @@ "members":{ "BackupPlanId":{ "shape":"string", - "documentation":"Uniquely identifies a backup plan.
", + "documentation":"The ID of the backup plan.
", "location":"uri", "locationName":"backupPlanId" }, "BackupPlan":{ "shape":"BackupPlanInput", - "documentation":"Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
The body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
" + "documentation":"The controls that make up the framework. Each control in the list has a name, input parameters, and scope.
" }, "IdempotencyToken":{ "shape":"string", @@ -7230,7 +7244,7 @@ "members":{ "BackupVaultName":{ "shape":"BackupVaultName", - "documentation":"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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", + "documentation":"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 Amazon Web Services Region where they are created.
", "location":"uri", "locationName":"backupVaultName" }, @@ -7251,7 +7265,7 @@ "members":{ "BackupVaultArn":{ "shape":"ARN", - "documentation":"An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
" + "documentation":"The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 table. Backup ignores this expression for other resource types.
" }, "CalculatedLifecycle":{ "shape":"CalculatedLifecycle", @@ -7296,11 +7310,11 @@ }, "ReportDeliveryChannel":{ "shape":"ReportDeliveryChannel", - "documentation":"A structure that contains information about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
" + "documentation":"The information about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
" }, "ReportSetting":{ "shape":"ReportSetting", - "documentation":"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 Amazon Web Services Regions and frameworks.
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 Amazon Web Services Regions and frameworks.
This is the restore testing plan name you wish to update.
", + "documentation":"The name of the restore testing plan name.
", "location":"uri", "locationName":"RestoreTestingPlanName" } @@ -7356,7 +7370,7 @@ "members":{ "CreationTime":{ "shape":"Timestamp", - "documentation":"This is the time the resource testing plan was created.
" + "documentation":"The time the resource testing plan was created.
" }, "RestoreTestingPlanArn":{ "shape":"String", @@ -7368,7 +7382,7 @@ }, "UpdateTime":{ "shape":"Timestamp", - "documentation":"This is the time the update completed for the restore testing plan.
" + "documentation":"The time the update completed for the restore testing plan.
" } } }, @@ -7392,7 +7406,7 @@ }, "RestoreTestingSelectionName":{ "shape":"String", - "documentation":"This is the required restore testing selection name of the restore testing selection you wish to update.
", + "documentation":"The required restore testing selection name of the restore testing selection you wish to update.
", "location":"uri", "locationName":"RestoreTestingSelectionName" } @@ -7410,7 +7424,7 @@ "members":{ "CreationTime":{ "shape":"Timestamp", - "documentation":"This is the time the resource testing selection was updated successfully.
" + "documentation":"The time the resource testing selection was updated successfully.
" }, "RestoreTestingPlanArn":{ "shape":"String", @@ -7418,15 +7432,15 @@ }, "RestoreTestingPlanName":{ "shape":"String", - "documentation":"This is the restore testing plan with which the updated restore testing selection is associated.
" + "documentation":"The restore testing plan with which the updated restore testing selection is associated.
" }, "RestoreTestingSelectionName":{ "shape":"String", - "documentation":"This is the returned restore testing selection name.
" + "documentation":"The returned restore testing selection name.
" }, "UpdateTime":{ "shape":"Timestamp", - "documentation":"This is the time the update completed for the restore testing selection.
" + "documentation":"The time the update completed for the restore testing selection.
" } } }, diff --git a/sdk/src/Services/Backup/Generated/Model/AdvancedBackupSetting.cs b/sdk/src/Services/Backup/Generated/Model/AdvancedBackupSetting.cs index 152fdd267536..422d55644850 100644 --- a/sdk/src/Services/Backup/Generated/Model/AdvancedBackupSetting.cs +++ b/sdk/src/Services/Backup/Generated/Model/AdvancedBackupSetting.cs @@ -30,7 +30,7 @@ namespace Amazon.Backup.Model { ///