From abd2514fc74bce33a88ae476dd5f570a0d1ad22d Mon Sep 17 00:00:00 2001 From: awstools Date: Fri, 30 Aug 2024 18:21:53 +0000 Subject: [PATCH] feat(client-backup): The latest update introduces two new attributes, VaultType and VaultState, to the DescribeBackupVault and ListBackupVaults APIs. The VaultState attribute reflects the current status of the vault, while the VaultType attribute indicates the specific category of the vault. --- .../src/commands/CancelLegalHoldCommand.ts | 4 +- .../src/commands/CreateLegalHoldCommand.ts | 8 +- ...ateLogicallyAirGappedBackupVaultCommand.ts | 2 +- .../CreateRestoreTestingPlanCommand.ts | 9 +- .../commands/DescribeBackupVaultCommand.ts | 1 + .../ListBackupPlanTemplatesCommand.ts | 3 +- .../src/commands/ListBackupPlansCommand.ts | 4 +- .../src/commands/ListBackupVaultsCommand.ts | 2 + .../ListRecoveryPointsByResourceCommand.ts | 2 +- .../src/commands/ListTagsCommand.ts | 6 +- .../PutBackupVaultLockConfigurationCommand.ts | 3 +- .../src/commands/StopBackupJobCommand.ts | 4 +- .../src/commands/TagResourceCommand.ts | 3 + .../src/commands/UntagResourceCommand.ts | 3 + .../src/commands/UpdateBackupPlanCommand.ts | 4 +- .../src/commands/UpdateFrameworkCommand.ts | 3 +- .../UpdateRecoveryPointLifecycleCommand.ts | 11 +- .../src/commands/UpdateReportPlanCommand.ts | 3 +- .../UpdateRestoreTestingSelectionCommand.ts | 10 +- clients/client-backup/src/models/models_0.ts | 1120 +++++++++-------- .../src/protocols/Aws_restJson1.ts | 3 + codegen/sdk-codegen/aws-models/backup.json | 538 ++++---- 22 files changed, 891 insertions(+), 855 deletions(-) diff --git a/clients/client-backup/src/commands/CancelLegalHoldCommand.ts b/clients/client-backup/src/commands/CancelLegalHoldCommand.ts index dcc71ea24898..6dbdc8191833 100644 --- a/clients/client-backup/src/commands/CancelLegalHoldCommand.ts +++ b/clients/client-backup/src/commands/CancelLegalHoldCommand.ts @@ -28,8 +28,8 @@ export interface CancelLegalHoldCommandInput extends CancelLegalHoldInput {} export interface CancelLegalHoldCommandOutput extends CancelLegalHoldOutput, __MetadataBearer {} /** - *

This action removes the specified legal hold on a recovery point. - * This action can only be performed by a user with sufficient permissions.

+ *

Removes the specified legal hold on a recovery point. This action can only be performed + * by a user with sufficient permissions.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-backup/src/commands/CreateLegalHoldCommand.ts b/clients/client-backup/src/commands/CreateLegalHoldCommand.ts index 2c361c146ec2..ff5844a8ba2d 100644 --- a/clients/client-backup/src/commands/CreateLegalHoldCommand.ts +++ b/clients/client-backup/src/commands/CreateLegalHoldCommand.ts @@ -32,10 +32,10 @@ export interface CreateLegalHoldCommandInput extends CreateLegalHoldInput {} export interface CreateLegalHoldCommandOutput extends CreateLegalHoldOutput, __MetadataBearer {} /** - *

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.

+ *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-backup/src/commands/CreateLogicallyAirGappedBackupVaultCommand.ts b/clients/client-backup/src/commands/CreateLogicallyAirGappedBackupVaultCommand.ts index ca6537a10428..2830359b6aa0 100644 --- a/clients/client-backup/src/commands/CreateLogicallyAirGappedBackupVaultCommand.ts +++ b/clients/client-backup/src/commands/CreateLogicallyAirGappedBackupVaultCommand.ts @@ -37,7 +37,7 @@ export interface CreateLogicallyAirGappedBackupVaultCommandOutput __MetadataBearer {} /** - *

This request creates a logical container to where backups may be copied.

+ *

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.

diff --git a/clients/client-backup/src/commands/CreateRestoreTestingPlanCommand.ts b/clients/client-backup/src/commands/CreateRestoreTestingPlanCommand.ts index e176e07665da..a9d28e5409f2 100644 --- a/clients/client-backup/src/commands/CreateRestoreTestingPlanCommand.ts +++ b/clients/client-backup/src/commands/CreateRestoreTestingPlanCommand.ts @@ -32,11 +32,10 @@ export interface CreateRestoreTestingPlanCommandInput extends CreateRestoreTesti export interface CreateRestoreTestingPlanCommandOutput extends CreateRestoreTestingPlanOutput, __MetadataBearer {} /** - *

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.

+ *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-backup/src/commands/DescribeBackupVaultCommand.ts b/clients/client-backup/src/commands/DescribeBackupVaultCommand.ts index 8f62341d6983..5012078d559e 100644 --- a/clients/client-backup/src/commands/DescribeBackupVaultCommand.ts +++ b/clients/client-backup/src/commands/DescribeBackupVaultCommand.ts @@ -45,6 +45,7 @@ export interface DescribeBackupVaultCommandOutput extends DescribeBackupVaultOut * // BackupVaultName: "STRING_VALUE", * // BackupVaultArn: "STRING_VALUE", * // VaultType: "BACKUP_VAULT" || "LOGICALLY_AIR_GAPPED_BACKUP_VAULT", + * // VaultState: "CREATING" || "AVAILABLE" || "FAILED", * // EncryptionKeyArn: "STRING_VALUE", * // CreationDate: new Date("TIMESTAMP"), * // CreatorRequestId: "STRING_VALUE", diff --git a/clients/client-backup/src/commands/ListBackupPlanTemplatesCommand.ts b/clients/client-backup/src/commands/ListBackupPlanTemplatesCommand.ts index db68f8fe5454..f93aeef6101e 100644 --- a/clients/client-backup/src/commands/ListBackupPlanTemplatesCommand.ts +++ b/clients/client-backup/src/commands/ListBackupPlanTemplatesCommand.ts @@ -28,8 +28,7 @@ export interface ListBackupPlanTemplatesCommandInput extends ListBackupPlanTempl export interface ListBackupPlanTemplatesCommandOutput extends ListBackupPlanTemplatesOutput, __MetadataBearer {} /** - *

Returns metadata of your saved backup plan templates, including the template ID, name, - * and the creation and deletion dates.

+ *

Lists the backup plan templates.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-backup/src/commands/ListBackupPlansCommand.ts b/clients/client-backup/src/commands/ListBackupPlansCommand.ts index 6f0aa1fcdcd6..65d374b71b33 100644 --- a/clients/client-backup/src/commands/ListBackupPlansCommand.ts +++ b/clients/client-backup/src/commands/ListBackupPlansCommand.ts @@ -28,9 +28,7 @@ export interface ListBackupPlansCommandInput extends ListBackupPlansInput {} export interface ListBackupPlansCommandOutput extends ListBackupPlansOutput, __MetadataBearer {} /** - *

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.

+ *

Lists the active backup plans for the account.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-backup/src/commands/ListBackupVaultsCommand.ts b/clients/client-backup/src/commands/ListBackupVaultsCommand.ts index a4767cfba4f7..14a833c078a6 100644 --- a/clients/client-backup/src/commands/ListBackupVaultsCommand.ts +++ b/clients/client-backup/src/commands/ListBackupVaultsCommand.ts @@ -49,6 +49,8 @@ export interface ListBackupVaultsCommandOutput extends ListBackupVaultsOutput, _ * // { // BackupVaultListMember * // BackupVaultName: "STRING_VALUE", * // BackupVaultArn: "STRING_VALUE", + * // VaultType: "BACKUP_VAULT" || "LOGICALLY_AIR_GAPPED_BACKUP_VAULT", + * // VaultState: "CREATING" || "AVAILABLE" || "FAILED", * // CreationDate: new Date("TIMESTAMP"), * // EncryptionKeyArn: "STRING_VALUE", * // CreatorRequestId: "STRING_VALUE", diff --git a/clients/client-backup/src/commands/ListRecoveryPointsByResourceCommand.ts b/clients/client-backup/src/commands/ListRecoveryPointsByResourceCommand.ts index aaeffcb1c0d6..c9ca79cc943e 100644 --- a/clients/client-backup/src/commands/ListRecoveryPointsByResourceCommand.ts +++ b/clients/client-backup/src/commands/ListRecoveryPointsByResourceCommand.ts @@ -33,7 +33,7 @@ export interface ListRecoveryPointsByResourceCommandOutput __MetadataBearer {} /** - *

Returns detailed information about all the recovery points of the type specified by a + *

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 diff --git a/clients/client-backup/src/commands/ListTagsCommand.ts b/clients/client-backup/src/commands/ListTagsCommand.ts index ea0de1f6882a..ec73bd3d02ba 100644 --- a/clients/client-backup/src/commands/ListTagsCommand.ts +++ b/clients/client-backup/src/commands/ListTagsCommand.ts @@ -28,12 +28,8 @@ export interface ListTagsCommandInput extends ListTagsInput {} export interface ListTagsCommandOutput extends ListTagsOutput, __MetadataBearer {} /** - *

Returns a list of key-value pairs assigned to a target recovery point, backup plan, or + *

Returns the tags assigned to the resource, such as 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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-backup/src/commands/PutBackupVaultLockConfigurationCommand.ts b/clients/client-backup/src/commands/PutBackupVaultLockConfigurationCommand.ts index 1c553a6f72eb..a3bad96fe991 100644 --- a/clients/client-backup/src/commands/PutBackupVaultLockConfigurationCommand.ts +++ b/clients/client-backup/src/commands/PutBackupVaultLockConfigurationCommand.ts @@ -40,10 +40,11 @@ export interface PutBackupVaultLockConfigurationCommandOutput extends __Metadata *

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 + * Cohasset Associates * Compliance Assessment. *

* + *

For more information, see Backup Vault Lock.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-backup/src/commands/StopBackupJobCommand.ts b/clients/client-backup/src/commands/StopBackupJobCommand.ts index bd1ba7015967..f16cc14fd0b5 100644 --- a/clients/client-backup/src/commands/StopBackupJobCommand.ts +++ b/clients/client-backup/src/commands/StopBackupJobCommand.ts @@ -30,8 +30,8 @@ export interface StopBackupJobCommandOutput extends __MetadataBearer {} /** *

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, + * 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.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-backup/src/commands/TagResourceCommand.ts b/clients/client-backup/src/commands/TagResourceCommand.ts index 9064711e78ce..bae231cc4845 100644 --- a/clients/client-backup/src/commands/TagResourceCommand.ts +++ b/clients/client-backup/src/commands/TagResourceCommand.ts @@ -30,6 +30,9 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} /** *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-backup/src/commands/UntagResourceCommand.ts b/clients/client-backup/src/commands/UntagResourceCommand.ts index e5ac8b9bd7e4..a40972273525 100644 --- a/clients/client-backup/src/commands/UntagResourceCommand.ts +++ b/clients/client-backup/src/commands/UntagResourceCommand.ts @@ -30,6 +30,9 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} /** *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-backup/src/commands/UpdateBackupPlanCommand.ts b/clients/client-backup/src/commands/UpdateBackupPlanCommand.ts index 6a20fafac15f..9bc3d93bf037 100644 --- a/clients/client-backup/src/commands/UpdateBackupPlanCommand.ts +++ b/clients/client-backup/src/commands/UpdateBackupPlanCommand.ts @@ -32,9 +32,7 @@ export interface UpdateBackupPlanCommandInput extends UpdateBackupPlanInput {} export interface UpdateBackupPlanCommandOutput extends UpdateBackupPlanOutput, __MetadataBearer {} /** - *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-backup/src/commands/UpdateFrameworkCommand.ts b/clients/client-backup/src/commands/UpdateFrameworkCommand.ts index 2e22e5eb8a95..133d068d998e 100644 --- a/clients/client-backup/src/commands/UpdateFrameworkCommand.ts +++ b/clients/client-backup/src/commands/UpdateFrameworkCommand.ts @@ -28,8 +28,7 @@ export interface UpdateFrameworkCommandInput extends UpdateFrameworkInput {} export interface UpdateFrameworkCommandOutput extends UpdateFrameworkOutput, __MetadataBearer {} /** - *

Updates an existing framework identified by its FrameworkName with the - * input document in JSON format.

+ *

Updates the specified framework.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-backup/src/commands/UpdateRecoveryPointLifecycleCommand.ts b/clients/client-backup/src/commands/UpdateRecoveryPointLifecycleCommand.ts index 5a7fa3244600..2fd2f60e3cb0 100644 --- a/clients/client-backup/src/commands/UpdateRecoveryPointLifecycleCommand.ts +++ b/clients/client-backup/src/commands/UpdateRecoveryPointLifecycleCommand.ts @@ -37,14 +37,17 @@ export interface UpdateRecoveryPointLifecycleCommandOutput *

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.

- *

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.

+ * + *

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.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-backup/src/commands/UpdateReportPlanCommand.ts b/clients/client-backup/src/commands/UpdateReportPlanCommand.ts index bd9c11d71c13..65e90c4d0eb0 100644 --- a/clients/client-backup/src/commands/UpdateReportPlanCommand.ts +++ b/clients/client-backup/src/commands/UpdateReportPlanCommand.ts @@ -28,8 +28,7 @@ export interface UpdateReportPlanCommandInput extends UpdateReportPlanInput {} export interface UpdateReportPlanCommandOutput extends UpdateReportPlanOutput, __MetadataBearer {} /** - *

Updates an existing report plan identified by its ReportPlanName with the - * input document in JSON format.

+ *

Updates the specified report plan.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-backup/src/commands/UpdateRestoreTestingSelectionCommand.ts b/clients/client-backup/src/commands/UpdateRestoreTestingSelectionCommand.ts index 5ac9b0d0c503..6fe04e160960 100644 --- a/clients/client-backup/src/commands/UpdateRestoreTestingSelectionCommand.ts +++ b/clients/client-backup/src/commands/UpdateRestoreTestingSelectionCommand.ts @@ -37,14 +37,10 @@ export interface UpdateRestoreTestingSelectionCommandOutput __MetadataBearer {} /** - *

Most elements except the RestoreTestingSelectionName + *

Updates the specified restore testing selection.

+ *

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.

+ *

You can use either protected resource ARNs or conditions, but not both.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-backup/src/models/models_0.ts b/clients/client-backup/src/models/models_0.ts index fe3bb7532066..74d6cc8bb995 100644 --- a/clients/client-backup/src/models/models_0.ts +++ b/clients/client-backup/src/models/models_0.ts @@ -4,7 +4,7 @@ import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from " import { BackupServiceException as __BaseException } from "./BackupServiceException"; /** - *

A list of backup options for each resource type.

+ *

The backup options for each resource type.

* @public */ export interface AdvancedBackupSetting { @@ -176,15 +176,14 @@ export interface BackupJob { /** *

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.

+ * Region where they are created.

* @public */ BackupVaultName?: string; /** *

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, - * arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

+ * arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

* @public */ BackupVaultArn?: string; @@ -330,14 +329,14 @@ export interface BackupJob { IsParent?: boolean; /** - *

This is the non-unique name of the resource that + *

The non-unique name of the resource that * belongs to the specified backup.

* @public */ ResourceName?: string; /** - *

This is the date on which the backup + *

The date on which the backup * job was initiated.

* @public */ @@ -460,36 +459,36 @@ export interface BackupJobSummary { } /** - *

Contains an array of Transition objects specifying how long in days before - * a recovery point transitions to cold storage or is deleted.

+ *

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 cannot + * 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 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 + *

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.

* @public */ export interface Lifecycle { /** - *

Specifies the number of days after creation that a recovery point is moved to cold + *

The number of days after creation that a recovery point is moved to cold * storage.

* @public */ MoveToColdStorageAfterDays?: number; /** - *

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.

* @public */ DeleteAfterDays?: number; /** - *

Optional Boolean. If this is true, this setting will - * instruct your backup plan to transition supported resources to + *

If the value is true, your backup plan transitions supported resources to * archive (cold) storage tier in accordance with your lifecycle settings.

* @public */ @@ -502,16 +501,17 @@ export interface Lifecycle { */ export interface CopyAction { /** - *

Contains an array of Transition objects specifying how long in days before - * a recovery point transitions to cold storage or is deleted.

+ *

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 cannot + * 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 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 + *

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.

* @public */ Lifecycle?: Lifecycle; @@ -519,7 +519,7 @@ export interface CopyAction { /** *

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.

+ * arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

* @public */ DestinationBackupVaultArn: string | undefined; @@ -540,8 +540,7 @@ export interface BackupRule { /** *

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.

+ * Region where they are created.

* @public */ TargetBackupVaultName: string | undefined; @@ -587,16 +586,14 @@ export interface BackupRule { * 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.

+ *

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.

* @public */ Lifecycle?: Lifecycle; /** - *

An array of key-value pair strings that are assigned to resources that are associated + *

The tags that are assigned to resources that are associated * with this rule when restored from backup.

* @public */ @@ -624,7 +621,7 @@ export interface BackupRule { EnableContinuousBackup?: boolean; /** - *

This is the timezone in which the schedule expression is set. By default, + *

The timezone in which the schedule expression is set. By default, * ScheduleExpressions are in UTC. You can modify this to a specified timezone.

* @public */ @@ -640,8 +637,10 @@ export interface BackupRule { */ export interface BackupPlan { /** - *

The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' - * characters.

+ *

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.

* @public */ BackupPlanName: string | undefined; @@ -675,8 +674,7 @@ export interface BackupRuleInput { /** *

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.

+ * Region where they are created.

* @public */ TargetBackupVaultName: string | undefined; @@ -718,19 +716,16 @@ export interface BackupRuleInput { *

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.

+ * 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).

* @public */ Lifecycle?: Lifecycle; /** - *

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 tags to assign to the resources.

* @public */ RecoveryPointTags?: Record; @@ -750,7 +745,7 @@ export interface BackupRuleInput { EnableContinuousBackup?: boolean; /** - *

This is the timezone in which the schedule expression is set. By default, + *

The timezone in which the schedule expression is set. By default, * ScheduleExpressions are in UTC. You can modify this to a specified timezone.

* @public */ @@ -844,7 +839,7 @@ export interface BackupPlansListMember { CreatorRequestId?: string; /** - *

The last time a job to back up resources was run with this rule. A date and time, in + *

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.

@@ -880,6 +875,8 @@ export interface BackupPlanTemplatesListMember { /** *

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".

* @public */ export interface ConditionParameter { @@ -982,9 +979,10 @@ export interface Condition { /** *

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.

+ *

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.

* @public */ export interface BackupSelection { @@ -1003,43 +1001,28 @@ export interface BackupSelection { IamRoleArn: string | undefined; /** - *

A list of Amazon Resource Names (ARNs) to assign to a backup plan. The maximum number of + *

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).

* @public */ Resources?: string[]; /** - *

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.

+ *

The conditions that you define to assign resources to your backup plans using tags. For example, + * "StringEquals": \{ "ConditionKey": "backup", "ConditionValue": "daily"\}.

*

- * ListOfTags differs from Conditions as follows:

- * + * ListOfTags supports only StringEquals. Condition operators are case sensitive.

+ *

If you specify multiple conditions, the resources much match any of the conditions (OR logic).

* @public */ ListOfTags?: Condition[]; /** - *

A list of Amazon Resource Names (ARNs) to exclude from a backup plan. The maximum number + *

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 @@ -1049,27 +1032,13 @@ export interface BackupSelection { NotResources?: string[]; /** - *

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.

+ *

The conditions that you define to assign resources to your backup plans using tags. For example, + * "StringEquals": \{ "ConditionKey": "aws:ResourceTag/backup", "ConditionValue": "daily" \}.

*

- * Conditions differs from ListOfTags as follows:

- * + * 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).

* @public */ Conditions?: Conditions; @@ -1152,6 +1121,35 @@ export const BackupVaultEvent = { */ export type BackupVaultEvent = (typeof BackupVaultEvent)[keyof typeof BackupVaultEvent]; +/** + * @public + * @enum + */ +export const VaultState = { + AVAILABLE: "AVAILABLE", + CREATING: "CREATING", + FAILED: "FAILED", +} as const; + +/** + * @public + */ +export type VaultState = (typeof VaultState)[keyof typeof VaultState]; + +/** + * @public + * @enum + */ +export const VaultType = { + BACKUP_VAULT: "BACKUP_VAULT", + LOGICALLY_AIR_GAPPED_BACKUP_VAULT: "LOGICALLY_AIR_GAPPED_BACKUP_VAULT", +} as const; + +/** + * @public + */ +export type VaultType = (typeof VaultType)[keyof typeof VaultType]; + /** *

Contains metadata about a backup vault.

* @public @@ -1160,19 +1158,30 @@ export interface BackupVaultListMember { /** *

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.

+ * Region where they are created.

* @public */ BackupVaultName?: string; /** *

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, - * arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

+ * arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

* @public */ BackupVaultArn?: string; + /** + *

The type of vault in which the described recovery point is stored.

+ * @public + */ + VaultType?: VaultType; + + /** + *

The current state of the vault.

+ * @public + */ + VaultState?: VaultState; + /** *

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 @@ -1271,10 +1280,8 @@ export interface BackupVaultListMember { * 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.

+ *

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.

* @public */ export interface CalculatedLifecycle { @@ -1296,20 +1303,19 @@ export interface CalculatedLifecycle { */ export interface CancelLegalHoldInput { /** - *

Legal hold ID required to remove the specified legal hold on a recovery point.

+ *

The ID of the legal hold.

* @public */ LegalHoldId: string | undefined; /** - *

String describing the reason for removing the legal hold.

+ *

A string the describes the reason for removing the legal hold.

* @public */ CancelDescription: string | undefined; /** - *

The integer amount in days specifying amount of days after this - * API operation to remove legal hold.

+ *

The integer amount, in days, after which to remove legal hold.

* @public */ RetainRecordInDays?: number; @@ -1546,7 +1552,7 @@ export class ConflictException extends __BaseException { } /** - *

A list of parameters for a control. A control can have zero, one, or more than one + *

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.

@@ -1597,7 +1603,10 @@ export interface ControlScope { /** *

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: + * 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"\}].

* @public */ @@ -1640,7 +1649,7 @@ export interface CopyJob { /** *

An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, - * arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

+ * arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

* @public */ SourceBackupVaultArn?: string; @@ -1654,7 +1663,7 @@ export interface CopyJob { /** *

An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for - * example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

+ * example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

* @public */ DestinationBackupVaultArn?: string; @@ -1744,7 +1753,7 @@ export interface CopyJob { IsParent?: boolean; /** - *

This is the identifier of a resource within a composite group, such as + *

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 @@ -1754,7 +1763,7 @@ export interface CopyJob { CompositeMemberIdentifier?: string; /** - *

This is the number of child (nested) copy jobs.

+ *

The number of child (nested) copy jobs.

* @public */ NumberOfChildJobs?: number; @@ -1767,7 +1776,7 @@ export interface CopyJob { ChildJobsInState?: Partial>; /** - *

This is the non-unique name of the resource that + *

The non-unique name of the resource that * belongs to the specified backup.

* @public */ @@ -1823,7 +1832,7 @@ export type CopyJobStatus = (typeof CopyJobStatus)[keyof typeof CopyJobStatus]; */ export interface CopyJobSummary { /** - *

This is the Amazon Web Services Regions within the job summary.

+ *

The Amazon Web Services Regions within the job summary.

* @public */ Region?: string; @@ -1894,16 +1903,14 @@ export interface CopyJobSummary { */ export interface CreateBackupPlanInput { /** - *

Specifies the body of a backup plan. Includes a BackupPlanName and one or + *

The body of a backup plan. Includes a BackupPlanName and one or * more sets of Rules.

* @public */ BackupPlan: BackupPlanInput | undefined; /** - *

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.

+ *

The tags to assign to the backup plan.

* @public */ BackupPlanTags?: Record; @@ -1923,7 +1930,7 @@ export interface CreateBackupPlanInput { */ export interface CreateBackupPlanOutput { /** - *

Uniquely identifies a backup plan.

+ *

The ID of the backup plan.

* @public */ BackupPlanId?: string; @@ -1952,7 +1959,7 @@ export interface CreateBackupPlanOutput { VersionId?: string; /** - *

A list of BackupOptions settings for a resource type. This option is only + *

The settings for a resource type. This option is only * available for Windows Volume Shadow Copy Service (VSS) backup jobs.

* @public */ @@ -2002,14 +2009,13 @@ export class LimitExceededException extends __BaseException { */ export interface CreateBackupSelectionInput { /** - *

Uniquely identifies the backup plan to be associated with the selection of - * resources.

+ *

The ID of the backup plan.

* @public */ BackupPlanId: string | undefined; /** - *

Specifies the body of a request to assign a set of resources to a backup plan.

+ *

The body of a request to assign a set of resources to a backup plan.

* @public */ BackupSelection: BackupSelection | undefined; @@ -2035,7 +2041,7 @@ export interface CreateBackupSelectionOutput { SelectionId?: string; /** - *

Uniquely identifies a backup plan.

+ *

The ID of the backup plan.

* @public */ BackupPlanId?: string; @@ -2063,8 +2069,7 @@ export interface CreateBackupVaultInput { BackupVaultName: string | undefined; /** - *

Metadata that you can assign to help organize the resources that you create. Each tag is - * a key-value pair.

+ *

The tags to assign to the backup vault.

* @public */ BackupVaultTags?: Record; @@ -2099,7 +2104,7 @@ export interface CreateBackupVaultOutput { /** *

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, - * arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

+ * arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

* @public */ BackupVaultArn?: string; @@ -2127,7 +2132,7 @@ export interface FrameworkControl { ControlName: string | undefined; /** - *

A list of ParameterName and ParameterValue pairs.

+ *

The name/value pairs.

* @public */ ControlInputParameters?: ControlInputParameter[]; @@ -2163,7 +2168,7 @@ export interface CreateFrameworkInput { FrameworkDescription?: string; /** - *

A list of the controls that make up the framework. Each control in the list has a name, + *

The controls that make up the framework. Each control in the list has a name, * input parameters, and scope.

* @public */ @@ -2178,8 +2183,7 @@ export interface CreateFrameworkInput { IdempotencyToken?: string; /** - *

Metadata that you can assign to help organize the frameworks that you create. Each tag - * is a key-value pair.

+ *

The tags to assign to the framework.

* @public */ FrameworkTags?: Record; @@ -2275,13 +2279,13 @@ export interface RecoveryPointSelection { */ export interface CreateLegalHoldInput { /** - *

This is the string title of the legal hold.

+ *

The title of the legal hold.

* @public */ Title: string | undefined; /** - *

This is the string description of the legal hold.

+ *

The description of the legal hold.

* @public */ Description: string | undefined; @@ -2295,8 +2299,7 @@ export interface CreateLegalHoldInput { IdempotencyToken?: string; /** - *

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

+ *

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

* @public */ RecoveryPointSelection?: RecoveryPointSelection; @@ -2331,46 +2334,43 @@ export type LegalHoldStatus = (typeof LegalHoldStatus)[keyof typeof LegalHoldSta */ export interface CreateLegalHoldOutput { /** - *

This is the string title of the legal hold returned after creating the legal hold.

+ *

The title of the legal hold.

* @public */ Title?: string; /** - *

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.

* @public */ Status?: LegalHoldStatus; /** - *

This is the returned string description of the legal hold.

+ *

The description of the legal hold.

* @public */ Description?: string; /** - *

Legal hold ID returned for the specified legal hold on a recovery point.

+ *

The ID of the legal hold.

* @public */ LegalHoldId?: string; /** - *

This is the ARN (Amazon Resource Number) of the created legal hold.

+ *

The Amazon Resource Name (ARN) of the legal hold.

* @public */ LegalHoldArn?: string; /** - *

Time in number format when legal hold was created.

+ *

The time when the legal hold was created.

* @public */ CreationDate?: Date; /** - *

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

+ *

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

* @public */ RecoveryPointSelection?: RecoveryPointSelection; @@ -2381,19 +2381,21 @@ export interface CreateLegalHoldOutput { */ export interface CreateLogicallyAirGappedBackupVaultInput { /** - *

This is the name of the vault that is being created.

+ *

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.

* @public */ BackupVaultName: string | undefined; /** - *

These are the tags that will be included in the newly-created vault.

+ *

The tags to assign to the vault.

* @public */ BackupVaultTags?: Record; /** - *

This is the ID of the creation request.

+ *

The ID of the creation request.

*

This parameter is optional. If used, this parameter must contain * 1 to 50 alphanumeric or '-_.' characters.

* @public @@ -2402,47 +2404,19 @@ export interface CreateLogicallyAirGappedBackupVaultInput { /** *

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.

+ * that the vault retains its recovery points.

+ *

The minimum value accepted is 7 days.

* @public */ MinRetentionDays: number | undefined; /** - *

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.

+ *

The maximum retention period that the vault retains its recovery points.

* @public */ MaxRetentionDays: number | undefined; } -/** - * @public - * @enum - */ -export const VaultState = { - AVAILABLE: "AVAILABLE", - CREATING: "CREATING", - FAILED: "FAILED", -} as const; - -/** - * @public - */ -export type VaultState = (typeof VaultState)[keyof typeof VaultState]; - /** * @public */ @@ -2450,14 +2424,13 @@ export interface CreateLogicallyAirGappedBackupVaultOutput { /** *

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.

+ * them and the Region where they are created.

* @public */ BackupVaultName?: string; /** - *

This is the ARN (Amazon Resource Name) of the vault being created.

+ *

The ARN (Amazon Resource Name) of the vault.

* @public */ BackupVaultArn?: string; @@ -2472,7 +2445,7 @@ export interface CreateLogicallyAirGappedBackupVaultOutput { CreationDate?: Date; /** - *

This is the current state of the vault.

+ *

The current state of the vault.

* @public */ VaultState?: VaultState; @@ -2538,7 +2511,7 @@ export interface ReportDeliveryChannel { S3KeyPrefix?: string; /** - *

A list of the format of your reports: CSV, JSON, or both. If + *

The format of your reports: CSV, JSON, or both. If * not specified, the default format is CSV.

* @public */ @@ -2575,6 +2548,7 @@ export interface ReportSetting { /** *

These are the accounts to be included in the report.

+ *

Use string value of ROOT to include all organizational units.

* @public */ Accounts?: string[]; @@ -2587,6 +2561,7 @@ export interface ReportSetting { /** *

These are the Regions to be included in the report.

+ *

Use the wildcard as the string value to include all Regions.

* @public */ Regions?: string[]; @@ -2633,8 +2608,7 @@ export interface CreateReportPlanInput { ReportSetting: ReportSetting | undefined; /** - *

Metadata that you can assign to help organize the report plans that you create. Each tag - * is a key-value pair.

+ *

The tags to assign to the report plan.

* @public */ ReportPlanTags?: Record; @@ -2706,10 +2680,35 @@ export type RestoreTestingRecoveryPointType = (typeof RestoreTestingRecoveryPointType)[keyof typeof RestoreTestingRecoveryPointType]; /** - *

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.

+ *

+ * 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.

* @public */ export interface RestoreTestingRecoveryPointSelection { @@ -2738,6 +2737,11 @@ export interface RestoreTestingRecoveryPointSelection { /** *

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.

* @public */ RecoveryPointTypes?: RestoreTestingRecoveryPointType[]; @@ -2755,9 +2759,35 @@ export interface RestoreTestingRecoveryPointSelection { */ export interface RestoreTestingPlanForCreate { /** - *

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.

+ *

+ * 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.

* @public */ RecoveryPointSelection: RestoreTestingRecoveryPointSelection | undefined; @@ -2823,10 +2853,7 @@ export interface CreateRestoreTestingPlanInput { RestoreTestingPlan: RestoreTestingPlanForCreate | undefined; /** - *

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: - * + - = . _ : /.

+ *

The tags to assign to the restore testing plan.

* @public */ Tags?: Record; @@ -2892,11 +2919,8 @@ export interface KeyValue { } /** - *

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.

* @public */ export interface ProtectedResourceConditions { @@ -2975,8 +2999,7 @@ export interface RestoreTestingSelectionForCreate { /** *

The type of Amazon Web Services resource included in a restore - * testing selection; for - * example, an Amazon EBS volume or + * testing selection; for example, an Amazon EBS volume or * an Amazon RDS database.

*

Supported resource types accepted include:

* * @public @@ -5570,8 +5588,7 @@ export interface ListBackupJobsInput { /** *

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.

+ * Amazon Web Services Region where they are created.

* @public */ ByBackupVaultName?: string; @@ -5629,23 +5646,24 @@ export interface ListBackupJobsInput { * *
  • *

    - * Redshift for Amazon Redshift

    + * RDS for Amazon Relational Database Service

    *
    • *
  • *

    - * RDS for Amazon Relational Database Service

    + * Redshift for Amazon Redshift

    *
    • *
  • *

    - * SAP HANA on Amazon EC2 for SAP HANA databases

    + * S3 for Amazon Simple Storage Service (Amazon S3)

    *
    • *
  • *

    - * Storage Gateway for Storage Gateway

    + * SAP HANA on Amazon EC2 for SAP HANA databases + * on Amazon Elastic Compute Cloud instances

    *
    • *
  • *

    - * S3 for Amazon S3

    + * Storage Gateway for Storage Gateway

    *
    • *
  • *

    @@ -5653,7 +5671,7 @@ export interface ListBackupJobsInput { *

    • *
  • *

    - * VirtualMachine for virtual machines

    + * VirtualMachine for VMware virtual machines

    *
    • * * @public @@ -5798,24 +5816,19 @@ export interface ListBackupJobSummariesInput { MessageCategory?: string; /** - *

    This is the period that sets the boundaries for returned - * results.

    - *

    Acceptable values include

    + *

    The period for the returned results.

    * * @public @@ -5823,8 +5836,7 @@ export interface ListBackupJobSummariesInput { AggregationPeriod?: AggregationPeriod; /** - *

    This parameter sets the maximum number of items - * to be returned.

    + *

    The maximum number of items to be returned.

    *

    The value is an integer. Range of accepted values is from * 1 to 500.

    * @public @@ -5846,31 +5858,25 @@ export interface ListBackupJobSummariesInput { */ export interface ListBackupJobSummariesOutput { /** - *

    This request returns a summary that contains - * Region, Account, State, ResourceType, MessageCategory, - * StartTime, EndTime, and Count of included jobs.

    + *

    The summary information.

    * @public */ BackupJobSummaries?: BackupJobSummary[]; /** - *

    This is the period that sets the boundaries for returned - * results.

    + *

    The period for the returned results.

    * * @public @@ -5928,8 +5934,7 @@ export interface ListBackupPlansOutput { NextToken?: string; /** - *

    An array of backup plan list items containing metadata about your saved backup - * plans.

    + *

    Information about the backup plans.

    * @public */ BackupPlansList?: BackupPlansListMember[]; @@ -5949,7 +5954,7 @@ export interface ListBackupPlanTemplatesInput { NextToken?: string; /** - *

    The maximum number of items to be returned.

    + *

    The maximum number of items to return.

    * @public */ MaxResults?: number; @@ -6206,23 +6211,24 @@ export interface ListCopyJobsInput { * *
  • *

    - * Redshift for Amazon Redshift

    + * RDS for Amazon Relational Database Service

    *
    • *
  • *

    - * RDS for Amazon Relational Database Service

    + * Redshift for Amazon Redshift

    *
    • *
  • *

    - * SAP HANA on Amazon EC2 for SAP HANA databases

    + * S3 for Amazon Simple Storage Service (Amazon S3)

    *
    • *
  • *

    - * Storage Gateway for Storage Gateway

    + * SAP HANA on Amazon EC2 for SAP HANA databases + * on Amazon Elastic Compute Cloud instances

    *
    • *
  • *

    - * S3 for Amazon S3

    + * Storage Gateway for Storage Gateway

    *
    • *
  • *

    @@ -6230,7 +6236,7 @@ export interface ListCopyJobsInput { *

    • *
  • *

    - * VirtualMachine for virtual machines

    + * VirtualMachine for VMware virtual machines

    *
    • * * @public @@ -6239,7 +6245,7 @@ export interface ListCopyJobsInput { /** *

    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. + * from; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault. *

    * @public */ @@ -6371,23 +6377,19 @@ export interface ListCopyJobSummariesInput { MessageCategory?: string; /** - *

    This is the period that sets the boundaries for returned - * results.

    + *

    The period for the returned results.

    * * @public @@ -6426,23 +6428,19 @@ export interface ListCopyJobSummariesOutput { CopyJobSummaries?: CopyJobSummary[]; /** - *

    This is the period that sets the boundaries for returned - * results.

    + *

    The period for the returned results.

    * * @public @@ -6536,7 +6534,7 @@ export interface Framework { */ export interface ListFrameworksOutput { /** - *

    A list of frameworks with details for each framework, including the framework name, + *

    The frameworks with details for each framework, including the framework name, * Amazon Resource Name (ARN), description, number of controls, creation time, and deployment * status.

    * @public @@ -6584,46 +6582,44 @@ export interface ListLegalHoldsInput { */ export interface LegalHold { /** - *

    This is the title of a legal hold.

    + *

    The title of a legal hold.

    * @public */ Title?: string; /** - *

    This is the status of the legal hold. Statuses can be - * ACTIVE, CREATING, CANCELED, and - * CANCELING.

    + *

    The status of the legal hold.

    * @public */ Status?: LegalHoldStatus; /** - *

    This is the description of a legal hold.

    + *

    The description of a legal hold.

    * @public */ Description?: string; /** - *

    ID of specific legal hold on one or more recovery points.

    + *

    The ID of the legal hold.

    * @public */ LegalHoldId?: string; /** - *

    This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example, + *

    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.

    * @public */ LegalHoldArn?: string; /** - *

    This is the time in number format when legal hold was created.

    + *

    The time when the legal hold was created.

    * @public */ CreationDate?: Date; /** - *

    This is the time in number format when legal hold was cancelled.

    + *

    The time when the legal hold was cancelled.

    * @public */ CancellationDate?: Date; @@ -6699,21 +6695,21 @@ export interface ProtectedResource { LastBackupTime?: Date; /** - *

    This is the non-unique name of the resource that + *

    The non-unique name of the resource that * belongs to the specified backup.

    * @public */ ResourceName?: string; /** - *

    This is the ARN (Amazon Resource Name) of the backup vault + *

    The ARN (Amazon Resource Name) of the backup vault * that contains the most recent backup recovery point.

    * @public */ LastBackupVaultArn?: string; /** - *

    This is the ARN (Amazon Resource Name) of the most + *

    The ARN (Amazon Resource Name) of the most * recent recovery point.

    * @public */ @@ -6747,13 +6743,13 @@ export interface ListProtectedResourcesOutput { */ export interface ListProtectedResourcesByBackupVaultInput { /** - *

    This is the list of protected resources by backup vault within the vault(s) you specify by name.

    + *

    The list of protected resources by backup vault within the vault(s) you specify by name.

    * @public */ BackupVaultName: string | undefined; /** - *

    This is the list of protected resources by backup vault within the vault(s) you specify by account ID.

    + *

    The list of protected resources by backup vault within the vault(s) you specify by account ID.

    * @public */ BackupVaultAccountId?: string; @@ -6801,8 +6797,7 @@ export interface ListRecoveryPointsByBackupVaultInput { /** *

    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.

    + * Region where they are created.

    * *

    Backup vault name might not be available when a supported service creates the * backup.

    @@ -6880,23 +6875,24 @@ export interface ListRecoveryPointsByBackupVaultInput { * *
  • *

    - * Redshift for Amazon Redshift

    + * RDS for Amazon Relational Database Service

    *
    • *
  • *

    - * RDS for Amazon Relational Database Service

    + * Redshift for Amazon Redshift

    *
    • *
  • *

    - * SAP HANA on Amazon EC2 for SAP HANA databases

    + * S3 for Amazon Simple Storage Service (Amazon S3)

    *
    • *
  • *

    - * Storage Gateway for Storage Gateway

    + * SAP HANA on Amazon EC2 for SAP HANA databases + * on Amazon Elastic Compute Cloud instances

    *
    • *
  • *

    - * S3 for Amazon S3

    + * Storage Gateway for Storage Gateway

    *
    • *
  • *

    @@ -6904,7 +6900,7 @@ export interface ListRecoveryPointsByBackupVaultInput { *

    • *
  • *

    - * VirtualMachine for virtual machines

    + * VirtualMachine for VMware virtual machines

    *
    • * * @public @@ -6952,15 +6948,14 @@ export interface RecoveryPointByBackupVault { /** *

    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.

    + * Region where they are created.

    * @public */ BackupVaultName?: string; /** *

    An ARN that uniquely identifies a backup vault; for example, - * arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

    + * arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

    * @public */ BackupVaultArn?: string; @@ -7009,7 +7004,7 @@ export interface RecoveryPointByBackupVault { Status?: RecoveryPointStatus; /** - *

    A message explaining the reason of the recovery point deletion failure.

    + *

    A message explaining the current status of the recovery point.

    * @public */ StatusMessage?: string; @@ -7053,9 +7048,8 @@ export interface RecoveryPointByBackupVault { * 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 + *

    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.

    * @public */ @@ -7085,14 +7079,14 @@ export interface RecoveryPointByBackupVault { LastRestoreTime?: Date; /** - *

    This is the Amazon Resource Name (ARN) of the parent (composite) + *

    The Amazon Resource Name (ARN) of the parent (composite) * recovery point.

    * @public */ ParentRecoveryPointArn?: string; /** - *

    This is the identifier of a resource within a composite group, such as + *

    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 @@ -7109,14 +7103,14 @@ export interface RecoveryPointByBackupVault { IsParent?: boolean; /** - *

    This is the non-unique name of the resource that + *

    The non-unique name of the resource that * belongs to the specified backup.

    * @public */ ResourceName?: string; /** - *

    This is the type of vault in which the described recovery point is stored.

    + *

    The type of vault in which the described recovery point is stored.

    * @public */ VaultType?: VaultType; @@ -7148,13 +7142,13 @@ export interface ListRecoveryPointsByBackupVaultOutput { */ export interface ListRecoveryPointsByLegalHoldInput { /** - *

    This is the ID of the legal hold.

    + *

    The ID of the legal hold.

    * @public */ LegalHoldId: string | undefined; /** - *

    This is the next item following a partial list of returned resources. For example, if a request + *

    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.

    @@ -7163,7 +7157,7 @@ export interface ListRecoveryPointsByLegalHoldInput { NextToken?: string; /** - *

    This is the maximum number of resource list items to be returned.

    + *

    The maximum number of resource list items to be returned.

    * @public */ MaxResults?: number; @@ -7178,28 +7172,28 @@ export interface ListRecoveryPointsByLegalHoldInput { */ export interface RecoveryPointMember { /** - *

    This is the Amazon Resource Name (ARN) of the parent (composite) + *

    The Amazon Resource Name (ARN) of the parent (composite) * recovery point.

    * @public */ RecoveryPointArn?: string; /** - *

    This is the Amazon Resource Name (ARN) that uniquely identifies + *

    The Amazon Resource Name (ARN) that uniquely identifies * a saved resource.

    * @public */ ResourceArn?: string; /** - *

    This is the Amazon Web Services resource type that is saved as + *

    The Amazon Web Services resource type that is saved as * a recovery point.

    * @public */ ResourceType?: string; /** - *

    This is the name of the backup vault + *

    The name of the backup vault * (the logical container in which backups are stored).

    * @public */ @@ -7211,14 +7205,13 @@ export interface RecoveryPointMember { */ export interface ListRecoveryPointsByLegalHoldOutput { /** - *

    This is a list of the recovery points returned by - * ListRecoveryPointsByLegalHold.

    + *

    The recovery points.

    * @public */ RecoveryPoints?: RecoveryPointMember[]; /** - *

    This return is the next item following a partial list of returned resources.

    + *

    The next item following a partial list of returned resources.

    * @public */ NextToken?: string; @@ -7294,7 +7287,7 @@ export interface RecoveryPointByResource { Status?: RecoveryPointStatus; /** - *

    A message explaining the reason of the recovery point deletion failure.

    + *

    A message explaining the current status of the recovery point.

    * @public */ StatusMessage?: string; @@ -7315,8 +7308,7 @@ export interface RecoveryPointByResource { /** *

    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.

    + * Region where they are created.

    * @public */ BackupVaultName?: string; @@ -7329,21 +7321,21 @@ export interface RecoveryPointByResource { IsParent?: boolean; /** - *

    This is the Amazon Resource Name (ARN) of the parent (composite) + *

    The Amazon Resource Name (ARN) of the parent (composite) * recovery point.

    * @public */ ParentRecoveryPointArn?: string; /** - *

    This is the non-unique name of the resource that + *

    The non-unique name of the resource that * belongs to the specified backup.

    * @public */ ResourceName?: string; /** - *

    This is the type of vault in which the described recovery point is + *

    The type of vault in which the described recovery point is * stored.

    * @public */ @@ -7467,7 +7459,7 @@ export interface ListReportPlansInput { */ export interface ListReportPlansOutput { /** - *

    A list of your report plans with detailed information for each plan. This information + *

    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.

    @@ -7510,8 +7502,7 @@ export interface ListRestoreJobsInput { ByAccountId?: string; /** - *

    Include this parameter to return only restore jobs for the - * specified resources:

    + *

    Include this parameter to return only restore jobs for the specified resources:

    *
      *
    • *

      @@ -7551,23 +7542,24 @@ export interface ListRestoreJobsInput { *

      • *
    • *

      - * Redshift for Amazon Redshift

      + * RDS for Amazon Relational Database Service

      *
      • *
    • *

      - * RDS for Amazon Relational Database Service

      + * Redshift for Amazon Redshift

      *
      • *
    • *

      - * SAP HANA on Amazon EC2 for SAP HANA databases

      + * S3 for Amazon Simple Storage Service (Amazon S3)

      *
      • *
    • *

      - * Storage Gateway for Storage Gateway

      + * SAP HANA on Amazon EC2 for SAP HANA databases + * on Amazon Elastic Compute Cloud instances

      *
      • *
    • *

      - * S3 for Amazon S3

      + * Storage Gateway for Storage Gateway

      *
      • *
    • *

      @@ -7575,7 +7567,7 @@ export interface ListRestoreJobsInput { *

      • *
    • *

      - * VirtualMachine for virtual machines

      + * VirtualMachine for VMware virtual machines

      *
      • *
    * @public @@ -7691,7 +7683,7 @@ export interface RestoreJobsListMember { BackupSizeInBytes?: number; /** - *

    Specifies the IAM role ARN used to create the target recovery point; for example, + *

    The IAM role ARN used to create the target recovery point; for example, * arn:aws:iam::123456789012:role/S3Access.

    * @public */ @@ -7734,7 +7726,7 @@ export interface RestoreJobsListMember { CreatedBy?: RestoreJobCreator; /** - *

    This is the status of validation run on the indicated + *

    The status of validation run on the indicated * restore job.

    * @public */ @@ -7914,24 +7906,19 @@ export interface ListRestoreJobSummariesInput { ResourceType?: string; /** - *

    This is the period that sets the boundaries for returned - * results.

    - *

    Acceptable values include

    + *

    The period for the returned results.

    *
      *
    • *

      - * ONE_DAY for daily job count - * for the prior 14 days.

      + * ONE_DAY - The daily job count for the prior 14 days.

      *
      • *
    • *

      - * SEVEN_DAYS for the aggregated - * job count for the prior 7 days.

      + * SEVEN_DAYS - The aggregated job count for the prior 7 days.

      *
      • *
    • *

      - * FOURTEEN_DAYS for aggregated - * job count for prior 14 days.

      + * FOURTEEN_DAYS - The aggregated job count for prior 14 days.

      *
      • *
    * @public @@ -8031,23 +8018,19 @@ export interface ListRestoreJobSummariesOutput { RestoreJobSummaries?: RestoreJobSummary[]; /** - *

    This is the period that sets the boundaries for returned - * results.

    + *

    The period for the returned results.

    *
      *
    • *

      - * ONE_DAY for daily job count - * for the prior 14 days.

      + * ONE_DAY - The daily job count for the prior 14 days.

      *
      • *
    • *

      - * SEVEN_DAYS for the aggregated - * job count for the prior 7 days.

      + * SEVEN_DAYS - The aggregated job count for the prior 7 days.

      *
      • *
    • *

      - * FOURTEEN_DAYS for aggregated - * job count for prior 14 days.

      + * FOURTEEN_DAYS - The aggregated job count for prior 14 days.

      *
      • *
    * @public @@ -8128,7 +8111,7 @@ export interface RestoreTestingPlanForList { RestoreTestingPlanArn: string | undefined; /** - *

    This is the restore testing plan name.

    + *

    The restore testing plan name.

    * @public */ RestoreTestingPlanName: string | undefined; @@ -8212,7 +8195,7 @@ export interface ListRestoreTestingSelectionsInput { */ export interface RestoreTestingSelectionForList { /** - *

    This is the date and time that a restore testing selection + *

    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, @@ -8326,8 +8309,7 @@ export interface ListTagsOutput { NextToken?: string; /** - *

    To help organize your resources, you can assign your own metadata to the resources you - * create. Each tag is a key-value pair.

    + *

    Information about the tags.

    * @public */ Tags?: Record; @@ -8340,8 +8322,7 @@ export interface PutBackupVaultAccessPolicyInput { /** *

    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.

    + * Region where they are created.

    * @public */ BackupVaultName: string | undefined; @@ -8369,8 +8350,9 @@ export interface PutBackupVaultLockConfigurationInput { * 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.

    + *

    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 @@ -8428,8 +8410,7 @@ export interface PutBackupVaultNotificationsInput { /** *

    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.

    + * Region where they are created.

    * @public */ BackupVaultName: string | undefined; @@ -8472,9 +8453,9 @@ export interface PutBackupVaultNotificationsInput { * * * - *

    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.

    + *

    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.

    *     * @public */ @@ -8492,7 +8473,7 @@ export interface PutRestoreValidationResultInput { RestoreJobId: string | undefined; /** - *

    This is the status of your restore validation.

    + *

    The status of your restore validation.

    * @public */ ValidationStatus: RestoreValidationStatus | undefined; @@ -8512,8 +8493,7 @@ export interface StartBackupJobInput { /** *

    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.

    + * Region where they are created.

    * @public */ BackupVaultName: string | undefined; @@ -8575,9 +8555,8 @@ export interface StartBackupJobInput { * 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 + *

    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).

    * @public @@ -8585,14 +8564,13 @@ export interface StartBackupJobInput { Lifecycle?: Lifecycle; /** - *

    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 tags to assign to the resources.

    * @public */ RecoveryPointTags?: Record; /** - *

    Specifies the backup option for a selected resource. This option is only available for + *

    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 @@ -8655,8 +8633,7 @@ export interface StartCopyJobInput { /** *

    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.

    + * identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.

    * @public */ SourceBackupVaultName: string | undefined; @@ -8664,7 +8641,7 @@ export interface StartCopyJobInput { /** *

    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.

    + * arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

    * @public */ DestinationBackupVaultArn: string | undefined; @@ -8685,16 +8662,17 @@ export interface StartCopyJobInput { IdempotencyToken?: string; /** - *

    Contains an array of Transition objects specifying how long in days before - * a recovery point transitions to cold storage or is deleted.

    + *

    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 cannot + * 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 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 + *

    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.

    * @public */ Lifecycle?: Lifecycle; @@ -8770,53 +8748,89 @@ export interface StartRestoreJobInput { RecoveryPointArn: string | undefined; /** - *

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

    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.

    - *

    You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:

    + *

    For more information about the metadata for each resource, see the following:

    * * @public @@ -8844,63 +8858,63 @@ export interface StartRestoreJobInput { *
      *
    • *

      - * Aurora for Amazon Aurora

      + * Aurora - Amazon Aurora

      *
      • *
    • *

      - * DocumentDB for Amazon DocumentDB (with MongoDB compatibility)

      + * DocumentDB - Amazon DocumentDB

      *
      • *
    • *

      - * CloudFormation for CloudFormation

      + * CloudFormation - CloudFormation

      *
      • *
    • *

      - * DynamoDB for Amazon DynamoDB

      + * DynamoDB - Amazon DynamoDB

      *
      • *
    • *

      - * EBS for Amazon Elastic Block Store

      + * EBS - Amazon Elastic Block Store

      *
      • *
    • *

      - * EC2 for Amazon Elastic Compute Cloud

      + * EC2 - Amazon Elastic Compute Cloud

      *
      • *
    • *

      - * EFS for Amazon Elastic File System

      + * EFS - Amazon Elastic File System

      *
      • *
    • *

      - * FSx for Amazon FSx

      + * FSx - Amazon FSx

      *
      • *
    • *

      - * Neptune for Amazon Neptune

      + * Neptune - Amazon Neptune

      *
      • *
    • *

      - * RDS for Amazon Relational Database Service

      + * RDS - Amazon Relational Database Service

      *
      • *
    • *

      - * Redshift for Amazon Redshift

      + * Redshift - Amazon Redshift

      *
      • *
    • *

      - * Storage Gateway for Storage Gateway

      + * Storage Gateway - Storage Gateway

      *
      • *
    • *

      - * S3 for Amazon S3

      + * S3 - Amazon Simple Storage Service

      *
      • *
    • *

      - * Timestream for Amazon Timestream

      + * Timestream - Amazon Timestream

      *
      • *
    • *

      - * VirtualMachine for virtual machines

      + * VirtualMachine - Virtual machines

      *
      • *
    * @public @@ -8945,6 +8959,11 @@ export interface TagResourceInput { /** *

    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.

    * @public */ ResourceArn: string | undefined; @@ -8965,12 +8984,17 @@ export interface UntagResourceInput { /** *

    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.

    * @public */ ResourceArn: string | undefined; /** - *

    A list of keys to identify which key-value tags to remove from a resource.

    + *

    The keys to identify which key-value tags to remove from a resource.

    * @public */ TagKeyList: string[] | undefined; @@ -8981,13 +9005,13 @@ export interface UntagResourceInput { */ export interface UpdateBackupPlanInput { /** - *

    Uniquely identifies a backup plan.

    + *

    The ID of the backup plan.

    * @public */ BackupPlanId: string | undefined; /** - *

    Specifies the body of a backup plan. Includes a BackupPlanName and one or + *

    The body of a backup plan. Includes a BackupPlanName and one or * more sets of Rules.

    * @public */ @@ -9052,7 +9076,7 @@ export interface UpdateFrameworkInput { FrameworkDescription?: string; /** - *

    A list of the controls that make up the framework. Each control in the list has a name, + *

    The controls that make up the framework. Each control in the list has a name, * input parameters, and scope.

    * @public */ @@ -9114,8 +9138,7 @@ export interface UpdateRecoveryPointLifecycleInput { /** *

    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.

    + * Region where they are created.

    * @public */ BackupVaultName: string | undefined; @@ -9146,7 +9169,7 @@ export interface UpdateRecoveryPointLifecycleInput { export interface UpdateRecoveryPointLifecycleOutput { /** *

    An ARN that uniquely identifies a backup vault; for example, - * arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

    + * arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

    * @public */ BackupVaultArn?: string; @@ -9166,10 +9189,8 @@ export interface UpdateRecoveryPointLifecycleOutput { * 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.

    + *

    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.

    * @public */ Lifecycle?: Lifecycle; @@ -9228,14 +9249,14 @@ export interface UpdateReportPlanInput { ReportPlanDescription?: string; /** - *

    A structure that contains information about where to deliver your reports, specifically + *

    The information about where to deliver your reports, specifically * your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

    * @public */ ReportDeliveryChannel?: ReportDeliveryChannel; /** - *

    Identifies the report template for the report. Reports are built using a report + *

    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 | @@ -9336,7 +9357,7 @@ export interface UpdateRestoreTestingPlanInput { RestoreTestingPlan: RestoreTestingPlanForUpdate | undefined; /** - *

    This is the restore testing plan name you wish to update.

    + *

    The name of the restore testing plan name.

    * @public */ RestoreTestingPlanName: string | undefined; @@ -9347,7 +9368,7 @@ export interface UpdateRestoreTestingPlanInput { */ export interface UpdateRestoreTestingPlanOutput { /** - *

    This is the time the resource testing plan was + *

    The time the resource testing plan was * created.

    * @public */ @@ -9367,7 +9388,7 @@ export interface UpdateRestoreTestingPlanOutput { RestoreTestingPlanName: string | undefined; /** - *

    This is the time the update completed for the restore + *

    The time the update completed for the restore * testing plan.

    * @public */ @@ -9397,11 +9418,8 @@ export interface RestoreTestingSelectionForUpdate { ProtectedResourceArns?: string[]; /** - *

    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.

    * @public */ ProtectedResourceConditions?: ProtectedResourceConditions; @@ -9448,7 +9466,7 @@ export interface UpdateRestoreTestingSelectionInput { RestoreTestingSelection: RestoreTestingSelectionForUpdate | undefined; /** - *

    This is the required restore testing selection name of the restore + *

    The required restore testing selection name of the restore * testing selection you wish to update.

    * @public */ @@ -9460,7 +9478,7 @@ export interface UpdateRestoreTestingSelectionInput { */ export interface UpdateRestoreTestingSelectionOutput { /** - *

    This is the time the resource testing selection was + *

    The time the resource testing selection was * updated successfully.

    * @public */ @@ -9473,20 +9491,20 @@ export interface UpdateRestoreTestingSelectionOutput { RestoreTestingPlanArn: string | undefined; /** - *

    This is the restore testing plan with which the updated restore + *

    The restore testing plan with which the updated restore * testing selection is associated.

    * @public */ RestoreTestingPlanName: string | undefined; /** - *

    This is the returned restore testing selection name.

    + *

    The returned restore testing selection name.

    * @public */ RestoreTestingSelectionName: string | undefined; /** - *

    This is the time the update completed for the restore + *

    The time the update completed for the restore * testing selection.

    * @public */ diff --git a/clients/client-backup/src/protocols/Aws_restJson1.ts b/clients/client-backup/src/protocols/Aws_restJson1.ts index 57734efaf34e..2a90d23675e6 100644 --- a/clients/client-backup/src/protocols/Aws_restJson1.ts +++ b/clients/client-backup/src/protocols/Aws_restJson1.ts @@ -2703,6 +2703,7 @@ export const de_DescribeBackupVaultCommand = async ( MaxRetentionDays: __expectLong, MinRetentionDays: __expectLong, NumberOfRecoveryPoints: __expectLong, + VaultState: __expectString, VaultType: __expectString, }); Object.assign(contents, doc); @@ -4815,6 +4816,8 @@ const de_BackupVaultListMember = (output: any, context: __SerdeContext): BackupV MaxRetentionDays: __expectLong, MinRetentionDays: __expectLong, NumberOfRecoveryPoints: __expectLong, + VaultState: __expectString, + VaultType: __expectString, }) as any; }; diff --git a/codegen/sdk-codegen/aws-models/backup.json b/codegen/sdk-codegen/aws-models/backup.json index 32651359065a..7f744bf96694 100644 --- a/codegen/sdk-codegen/aws-models/backup.json +++ b/codegen/sdk-codegen/aws-models/backup.json @@ -55,7 +55,7 @@ } }, "traits": { - "smithy.api#documentation": "

    A list of backup options for each resource type.

    " + "smithy.api#documentation": "

    The backup options for each resource type.

    " } }, "com.amazonaws.backup#AdvancedBackupSettings": { @@ -144,13 +144,13 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

    " + "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

    " } }, "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

    " + "smithy.api#documentation": "

    An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

    " } }, "RecoveryPointArn": { @@ -265,13 +265,13 @@ "ResourceName": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the non-unique name of the resource that \n belongs to the specified backup.

    " + "smithy.api#documentation": "

    The non-unique name of the resource that \n belongs to the specified backup.

    " } }, "InitiationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

    This is the date on which the backup \n job was initiated.

    " + "smithy.api#documentation": "

    The date on which the backup \n job was initiated.

    " } }, "MessageCategory": { @@ -520,7 +520,7 @@ "BackupPlanName": { "target": "com.amazonaws.backup#BackupPlanName", "traits": { - "smithy.api#documentation": "

    The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.'\n characters.

    ", + "smithy.api#documentation": "

    The display name of a backup plan. Must contain only alphanumeric or '-_.'\n special characters.

    \n

    If this is set in the console, it can contain 1 to 50 characters; if this \n is set through CLI or API, it can contain 1 to 200 characters.

    ", "smithy.api#required": {} } }, @@ -659,7 +659,7 @@ "LastExecutionDate": { "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

    The last time a job to back up resources was run with this rule. A date and time, in\n Unix format and Coordinated Universal Time (UTC). The value of\n LastExecutionDate is accurate to milliseconds. For example, the value\n 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    " + "smithy.api#documentation": "

    The last time this backup plan was run. A date and time, in\n Unix format and Coordinated Universal Time (UTC). The value of\n LastExecutionDate is accurate to milliseconds. For example, the value\n 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    " } }, "AdvancedBackupSettings": { @@ -686,7 +686,7 @@ "TargetBackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

    ", + "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

    ", "smithy.api#required": {} } }, @@ -711,13 +711,13 @@ "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { - "smithy.api#documentation": "

    The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

    \n

    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.

    \n

    Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" \n section of the \n Feature availability by resource table. Backup ignores this expression for\n other resource types.

    " + "smithy.api#documentation": "

    The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

    \n

    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.

    \n

    Resource types that can transition to cold storage are listed in the Feature availability \n by resource table. Backup ignores this expression for other resource types.

    " } }, "RecoveryPointTags": { "target": "com.amazonaws.backup#Tags", "traits": { - "smithy.api#documentation": "

    An array of key-value pair strings that are assigned to resources that are associated\n with this rule when restored from backup.

    " + "smithy.api#documentation": "

    The tags that are assigned to resources that are associated\n with this rule when restored from backup.

    " } }, "RuleId": { @@ -741,7 +741,7 @@ "ScheduleExpressionTimezone": { "target": "com.amazonaws.backup#Timezone", "traits": { - "smithy.api#documentation": "

    This is the timezone in which the schedule expression is set. By default, \n ScheduleExpressions are in UTC. You can modify this to a specified timezone.

    " + "smithy.api#documentation": "

    The timezone in which the schedule expression is set. By default, \n ScheduleExpressions are in UTC. You can modify this to a specified timezone.

    " } } }, @@ -762,7 +762,7 @@ "TargetBackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

    ", + "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

    ", "smithy.api#required": {} } }, @@ -787,13 +787,13 @@ "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { - "smithy.api#documentation": "

    The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup will transition and expire backups automatically according\n to the lifecycle that you define.

    \n

    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.

    \n

    Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" \n section of the \n Feature availability by resource table. Backup ignores this expression for\n other resource types.

    \n

    This parameter has a maximum value of 100 years (36,500 days).

    " + "smithy.api#documentation": "

    The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup will transition and expire backups automatically according\n to the lifecycle that you define.

    \n

    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold storage.

    \n

    Resource types that can transition to cold storage are listed in the Feature availability \n by resource table. Backup ignores this expression for other resource types.

    \n

    This parameter has a maximum value of 100 years (36,500 days).

    " } }, "RecoveryPointTags": { "target": "com.amazonaws.backup#Tags", "traits": { - "smithy.api#documentation": "

    To help organize your resources, you can assign your own metadata to the resources that\n you create. Each tag is a key-value pair.

    " + "smithy.api#documentation": "

    The tags to assign to the resources.

    " } }, "CopyActions": { @@ -811,7 +811,7 @@ "ScheduleExpressionTimezone": { "target": "com.amazonaws.backup#Timezone", "traits": { - "smithy.api#documentation": "

    This is the timezone in which the schedule expression is set. By default, \n ScheduleExpressions are in UTC. You can modify this to a specified timezone.

    " + "smithy.api#documentation": "

    The timezone in which the schedule expression is set. By default, \n ScheduleExpressions are in UTC. You can modify this to a specified timezone.

    " } } }, @@ -857,30 +857,30 @@ "Resources": { "target": "com.amazonaws.backup#ResourceArns", "traits": { - "smithy.api#documentation": "

    A list of Amazon Resource Names (ARNs) to assign to a backup plan. The maximum number of\n ARNs is 500 without wildcards, or 30 ARNs with wildcards.

    \n

    If you need to assign many resources to a backup plan, consider a different resource\n selection strategy, such as assigning all resources of a resource type or refining your\n resource selection using tags.

    " + "smithy.api#documentation": "

    The Amazon Resource Names (ARNs) of the resources to assign to a backup plan. The maximum number of\n ARNs is 500 without wildcards, or 30 ARNs with wildcards.

    \n

    If you need to assign many resources to a backup plan, consider a different resource\n selection strategy, such as assigning all resources of a resource type or refining your\n resource selection using tags.

    \n

    If you specify multiple ARNs, the resources much match any of the ARNs (OR logic).

    " } }, "ListOfTags": { "target": "com.amazonaws.backup#ListOfTags", "traits": { - "smithy.api#documentation": "

    A list of conditions that you define to assign resources to your backup plans using\n tags. For example, \"StringEquals\": {\n \"Key\": \"aws:ResourceTag/CreatedByCryo\",\n \"Value\": \"true\"\n },. Condition\n operators are case sensitive.

    \n

    \n ListOfTags differs from Conditions as follows:

    \n
      \n
    • \n

      When you specify more than one condition, you assign all resources that match AT\n LEAST ONE condition (using OR logic).

      \n
      • \n
    • \n

      \n ListOfTags only supports StringEquals.\n Conditions supports StringEquals,\n StringLike, StringNotEquals, and\n StringNotLike.

      \n
      • \n
    " + "smithy.api#documentation": "

    The conditions that you define to assign resources to your backup plans using tags. For example, \n \"StringEquals\": { \"ConditionKey\": \"backup\", \"ConditionValue\": \"daily\"}.

    \n

    \n ListOfTags supports only StringEquals. Condition operators are case sensitive.

    \n

    If you specify multiple conditions, the resources much match any of the conditions (OR logic).

    " } }, "NotResources": { "target": "com.amazonaws.backup#ResourceArns", "traits": { - "smithy.api#documentation": "

    A list of Amazon Resource Names (ARNs) to exclude from a backup plan. The maximum number\n of ARNs is 500 without wildcards, or 30 ARNs with wildcards.

    \n

    If you need to exclude many resources from a backup plan, consider a different resource\n selection strategy, such as assigning only one or a few resource types or refining your\n resource selection using tags.

    " + "smithy.api#documentation": "

    The Amazon Resource Names (ARNs) of the resources to exclude from a backup plan. The maximum number\n of ARNs is 500 without wildcards, or 30 ARNs with wildcards.

    \n

    If you need to exclude many resources from a backup plan, consider a different resource\n selection strategy, such as assigning only one or a few resource types or refining your\n resource selection using tags.

    " } }, "Conditions": { "target": "com.amazonaws.backup#Conditions", "traits": { - "smithy.api#documentation": "

    A list of conditions that you define to assign resources to your backup plans using\n tags. For example, \"StringEquals\": {\n \"Key\": \"aws:ResourceTag/CreatedByCryo\",\n \"Value\": \"true\"\n },. Condition\n operators are case sensitive.

    \n

    \n Conditions differs from ListOfTags as follows:

    \n
      \n
    • \n

      When you specify more than one condition, you only assign the resources that match\n ALL conditions (using AND logic).

      \n
      • \n
    • \n

      \n Conditions supports StringEquals,\n StringLike, StringNotEquals, and\n StringNotLike. ListOfTags only supports\n StringEquals.

      \n
      • \n
    " + "smithy.api#documentation": "

    The conditions that you define to assign resources to your backup plans using tags. For example, \n \"StringEquals\": { \"ConditionKey\": \"aws:ResourceTag/backup\", \"ConditionValue\": \"daily\" }.

    \n

    \n Conditions supports StringEquals,\n StringLike, StringNotEquals, and\n StringNotLike. Condition operators are case sensitive.

    \n

    If you specify multiple conditions, the resources much match all conditions (AND logic).

    " } } }, "traits": { - "smithy.api#documentation": "

    Used to specify a set of resources to a backup plan.

    \n

    Specifying your desired Conditions, ListOfTags, NotResources, \n and/or Resources is recommended. If none of these are specified, Backup will attempt to \n select all supported and opted-in storage resources, which could have unintended cost implications.

    " + "smithy.api#documentation": "

    Used to specify a set of resources to a backup plan.

    \n

    We recommend that you specify conditions, tags, or resources to include or exclude. \n Otherwise, Backup attempts to select all supported and opted-in storage resources, which \n could have unintended cost implications.

    \n

    For more information, see Assigning resources programmatically.

    " } }, "com.amazonaws.backup#BackupSelectionName": { @@ -1064,13 +1064,25 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

    " + "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

    " } }, "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

    " + "smithy.api#documentation": "

    An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

    " + } + }, + "VaultType": { + "target": "com.amazonaws.backup#VaultType", + "traits": { + "smithy.api#documentation": "

    The type of vault in which the described recovery point is stored.

    " + } + }, + "VaultState": { + "target": "com.amazonaws.backup#VaultState", + "traits": { + "smithy.api#documentation": "

    The current state of the vault.

    " } }, "CreationDate": { @@ -1159,7 +1171,7 @@ } }, "traits": { - "smithy.api#documentation": "

    Contains DeleteAt and MoveToColdStorageAt timestamps, which\n are used to specify a lifecycle for a recovery point.

    \n

    The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

    \n

    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.

    \n

    Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" \n section of the \n Feature availability by resource table. Backup ignores this expression for\n other resource types.

    " + "smithy.api#documentation": "

    Contains DeleteAt and MoveToColdStorageAt timestamps, which\n are used to specify a lifecycle for a recovery point.

    \n

    The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

    \n

    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.

    \n

    Resource types that can transition to cold storage are listed in the Feature availability \n by resource table. Backup ignores this expression for other resource types.

    " } }, "com.amazonaws.backup#CancelLegalHold": { @@ -1188,7 +1200,7 @@ } ], "traits": { - "smithy.api#documentation": "

    This action removes the specified legal hold on a recovery point. \n This action can only be performed by a user with sufficient permissions.

    ", + "smithy.api#documentation": "

    Removes the specified legal hold on a recovery point. This action can only be performed\n by a user with sufficient permissions.

    ", "smithy.api#http": { "method": "DELETE", "uri": "/legal-holds/{LegalHoldId}", @@ -1203,7 +1215,7 @@ "LegalHoldId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    Legal hold ID required to remove the specified legal hold on a recovery point.

    ", + "smithy.api#documentation": "

    The ID of the legal hold.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1211,7 +1223,7 @@ "CancelDescription": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    String describing the reason for removing the legal hold.

    ", + "smithy.api#documentation": "

    A string the describes the reason for removing the legal hold.

    ", "smithy.api#httpQuery": "cancelDescription", "smithy.api#required": {} } @@ -1219,7 +1231,7 @@ "RetainRecordInDays": { "target": "com.amazonaws.backup#Long", "traits": { - "smithy.api#documentation": "

    The integer amount in days specifying amount of days after this \n API operation to remove legal hold.

    ", + "smithy.api#documentation": "

    The integer amount, in days, after which to remove legal hold.

    ", "smithy.api#httpQuery": "retainRecordInDays" } } @@ -1296,7 +1308,7 @@ } }, "traits": { - "smithy.api#documentation": "

    Includes information about tags you define to assign tagged resources to a backup\n plan.

    " + "smithy.api#documentation": "

    Includes information about tags you define to assign tagged resources to a backup\n plan.

    \n

    Include the prefix aws:ResourceTag in your tags. \n For example, \"aws:ResourceTag/TagKey1\": \"Value1\".

    " } }, "com.amazonaws.backup#ConditionParameters": { @@ -1400,7 +1412,7 @@ } }, "traits": { - "smithy.api#documentation": "

    A list of parameters for a control. A control can have zero, one, or more than one\n parameter. An example of a control with two parameters is: \"backup plan frequency is at\n least daily and the retention period is at least 1 year\". The\n first parameter is daily. The second parameter is 1 year.

    " + "smithy.api#documentation": "

    The parameters for a control. A control can have zero, one, or more than one\n parameter. An example of a control with two parameters is: \"backup plan frequency is at\n least daily and the retention period is at least 1 year\". The\n first parameter is daily. The second parameter is 1 year.

    " } }, "com.amazonaws.backup#ControlInputParameters": { @@ -1430,7 +1442,7 @@ "Tags": { "target": "com.amazonaws.backup#stringMap", "traits": { - "smithy.api#documentation": "

    The tag key-value pair applied to those Amazon Web Services resources that you want to\n trigger an evaluation for a rule. A maximum of one key-value pair can be provided. The tag\n value is optional, but it cannot be an empty string. The structure to assign a tag is:\n [{\"Key\":\"string\",\"Value\":\"string\"}].

    " + "smithy.api#documentation": "

    The tag key-value pair applied to those Amazon Web Services resources that you want to\n trigger an evaluation for a rule. A maximum of one key-value pair can be provided. The tag\n value is optional, but it cannot be an empty string if you are creating or editing a \n framework from the console (though the value can be an empty string when included \n in a CloudFormation template).

    \n

    The structure to assign a tag is:\n [{\"Key\":\"string\",\"Value\":\"string\"}].

    " } } }, @@ -1447,7 +1459,7 @@ "DestinationBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for\n the copied backup. For example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

    ", + "smithy.api#documentation": "

    An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for\n the copied backup. For example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

    ", "smithy.api#required": {} } } @@ -1480,7 +1492,7 @@ "SourceBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

    " + "smithy.api#documentation": "

    An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

    " } }, "SourceRecoveryPointArn": { @@ -1492,7 +1504,7 @@ "DestinationBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for\n example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

    " + "smithy.api#documentation": "

    An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for\n example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

    " } }, "DestinationRecoveryPointArn": { @@ -1568,13 +1580,13 @@ "CompositeMemberIdentifier": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the identifier of a resource within a composite group, such as \n nested (child) recovery point belonging to a composite (parent) stack. The \n ID is transferred from \n the \n logical ID within a stack.

    " + "smithy.api#documentation": "

    The identifier of a resource within a composite group, such as \n nested (child) recovery point belonging to a composite (parent) stack. The \n ID is transferred from \n the \n logical ID within a stack.

    " } }, "NumberOfChildJobs": { "target": "com.amazonaws.backup#Long", "traits": { - "smithy.api#documentation": "

    This is the number of child (nested) copy jobs.

    " + "smithy.api#documentation": "

    The number of child (nested) copy jobs.

    " } }, "ChildJobsInState": { @@ -1586,7 +1598,7 @@ "ResourceName": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the non-unique name of the resource that \n belongs to the specified backup.

    " + "smithy.api#documentation": "

    The non-unique name of the resource that \n belongs to the specified backup.

    " } }, "MessageCategory": { @@ -1721,7 +1733,7 @@ "Region": { "target": "com.amazonaws.backup#Region", "traits": { - "smithy.api#documentation": "

    This is the Amazon Web Services Regions within the job summary.

    " + "smithy.api#documentation": "

    The Amazon Web Services Regions within the job summary.

    " } }, "AccountId": { @@ -1825,14 +1837,14 @@ "BackupPlan": { "target": "com.amazonaws.backup#BackupPlanInput", "traits": { - "smithy.api#documentation": "

    Specifies the body of a backup plan. Includes a BackupPlanName and one or\n more sets of Rules.

    ", + "smithy.api#documentation": "

    The body of a backup plan. Includes a BackupPlanName and one or\n more sets of Rules.

    ", "smithy.api#required": {} } }, "BackupPlanTags": { "target": "com.amazonaws.backup#Tags", "traits": { - "smithy.api#documentation": "

    To help organize your resources, you can assign your own metadata to the resources that\n you create. Each tag is a key-value pair. The specified tags are assigned to all backups\n created with this plan.

    " + "smithy.api#documentation": "

    The tags to assign to the backup plan.

    " } }, "CreatorRequestId": { @@ -1852,7 +1864,7 @@ "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    Uniquely identifies a backup plan.

    " + "smithy.api#documentation": "

    The ID of the backup plan.

    " } }, "BackupPlanArn": { @@ -1876,7 +1888,7 @@ "AdvancedBackupSettings": { "target": "com.amazonaws.backup#AdvancedBackupSettings", "traits": { - "smithy.api#documentation": "

    A list of BackupOptions settings for a resource type. This option is only\n available for Windows Volume Shadow Copy Service (VSS) backup jobs.

    " + "smithy.api#documentation": "

    The settings for a resource type. This option is only\n available for Windows Volume Shadow Copy Service (VSS) backup jobs.

    " } } }, @@ -1925,7 +1937,7 @@ "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    Uniquely identifies the backup plan to be associated with the selection of\n resources.

    ", + "smithy.api#documentation": "

    The ID of the backup plan.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1933,7 +1945,7 @@ "BackupSelection": { "target": "com.amazonaws.backup#BackupSelection", "traits": { - "smithy.api#documentation": "

    Specifies the body of a request to assign a set of resources to a backup plan.

    ", + "smithy.api#documentation": "

    The body of a request to assign a set of resources to a backup plan.

    ", "smithy.api#required": {} } }, @@ -1960,7 +1972,7 @@ "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    Uniquely identifies a backup plan.

    " + "smithy.api#documentation": "

    The ID of the backup plan.

    " } }, "CreationDate": { @@ -2023,7 +2035,7 @@ "BackupVaultTags": { "target": "com.amazonaws.backup#Tags", "traits": { - "smithy.api#documentation": "

    Metadata that you can assign to help organize the resources that you create. Each tag is\n a key-value pair.

    " + "smithy.api#documentation": "

    The tags to assign to the backup vault.

    " } }, "EncryptionKeyArn": { @@ -2055,7 +2067,7 @@ "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

    " + "smithy.api#documentation": "

    An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

    " } }, "CreationDate": { @@ -2123,7 +2135,7 @@ "FrameworkControls": { "target": "com.amazonaws.backup#FrameworkControls", "traits": { - "smithy.api#documentation": "

    A list of the controls that make up the framework. Each control in the list has a name,\n input parameters, and scope.

    ", + "smithy.api#documentation": "

    The controls that make up the framework. Each control in the list has a name,\n input parameters, and scope.

    ", "smithy.api#required": {} } }, @@ -2137,7 +2149,7 @@ "FrameworkTags": { "target": "com.amazonaws.backup#stringMap", "traits": { - "smithy.api#documentation": "

    Metadata that you can assign to help organize the frameworks that you create. Each tag\n is a key-value pair.

    " + "smithy.api#documentation": "

    The tags to assign to the framework.

    " } } }, @@ -2188,7 +2200,7 @@ } ], "traits": { - "smithy.api#documentation": "

    This action creates a legal hold on a recovery point (backup). A legal hold \n is a restraint on altering or deleting a backup until an authorized user cancels the \n legal hold. Any actions to delete or disassociate a recovery point will fail with \n an error if one or more active legal holds are on the recovery point.

    ", + "smithy.api#documentation": "

    Creates a legal hold on a recovery point (backup). A legal hold is a restraint on\n altering or deleting a backup until an authorized user cancels the legal hold. Any actions\n to delete or disassociate a recovery point will fail with an error if one or more active\n legal holds are on the recovery point.

    ", "smithy.api#http": { "method": "POST", "uri": "/legal-holds", @@ -2203,14 +2215,14 @@ "Title": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the string title of the legal hold.

    ", + "smithy.api#documentation": "

    The title of the legal hold.

    ", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the string description of the legal hold.

    ", + "smithy.api#documentation": "

    The description of the legal hold.

    ", "smithy.api#required": {} } }, @@ -2223,7 +2235,7 @@ "RecoveryPointSelection": { "target": "com.amazonaws.backup#RecoveryPointSelection", "traits": { - "smithy.api#documentation": "

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

    " + "smithy.api#documentation": "

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

    " } }, "Tags": { @@ -2243,43 +2255,43 @@ "Title": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the string title of the legal hold returned after creating the legal hold.

    " + "smithy.api#documentation": "

    The title of the legal hold.

    " } }, "Status": { "target": "com.amazonaws.backup#LegalHoldStatus", "traits": { - "smithy.api#documentation": "

    This displays the status of the legal hold returned after creating the legal hold. \n Statuses can be ACTIVE, PENDING, CANCELED, \n CANCELING, or FAILED.

    " + "smithy.api#documentation": "

    The status of the legal hold.

    " } }, "Description": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the returned string description of the legal hold.

    " + "smithy.api#documentation": "

    The description of the legal hold.

    " } }, "LegalHoldId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    Legal hold ID returned for the specified legal hold on a recovery point.

    " + "smithy.api#documentation": "

    The ID of the legal hold.

    " } }, "LegalHoldArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    This is the ARN (Amazon Resource Number) of the created legal hold.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the legal hold.

    " } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

    Time in number format when legal hold was created.

    " + "smithy.api#documentation": "

    The time when the legal hold was created.

    " } }, "RecoveryPointSelection": { "target": "com.amazonaws.backup#RecoveryPointSelection", "traits": { - "smithy.api#documentation": "

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

    " + "smithy.api#documentation": "

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

    " } } }, @@ -2316,7 +2328,7 @@ } ], "traits": { - "smithy.api#documentation": "

    This request creates a logical container to where backups may be copied.

    \n

    This request includes a name, the Region, the maximum number of retention days, the \n minimum number of retention days, and optionally can include tags and a creator request \n ID.

    \n \n

    Do not include sensitive data, such as passport numbers, in the name of a backup\n vault.

    \n     ", + "smithy.api#documentation": "

    Creates a logical container to where backups may be copied.

    \n

    This request includes a name, the Region, the maximum number of retention days, the \n minimum number of retention days, and optionally can include tags and a creator request \n ID.

    \n \n

    Do not include sensitive data, such as passport numbers, in the name of a backup\n vault.

    \n     ", "smithy.api#http": { "method": "PUT", "uri": "/logically-air-gapped-backup-vaults/{BackupVaultName}", @@ -2331,7 +2343,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    This is the name of the vault that is being created.

    ", + "smithy.api#documentation": "

    The name of a logical container where backups are stored. Logically air-gapped \n backup vaults are identified by names that are unique to the account used to create \n them and the Region where they are created.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2339,26 +2351,26 @@ "BackupVaultTags": { "target": "com.amazonaws.backup#Tags", "traits": { - "smithy.api#documentation": "

    These are the tags that will be included in the newly-created vault.

    " + "smithy.api#documentation": "

    The tags to assign to the vault.

    " } }, "CreatorRequestId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the ID of the creation request.

    \n

    This parameter is optional. If used, this parameter must contain \n 1 to 50 alphanumeric or '-_.' characters.

    " + "smithy.api#documentation": "

    The ID of the creation request.

    \n

    This parameter is optional. If used, this parameter must contain \n 1 to 50 alphanumeric or '-_.' characters.

    " } }, "MinRetentionDays": { "target": "com.amazonaws.backup#Long", "traits": { - "smithy.api#documentation": "

    This setting specifies the minimum retention period\n that the vault retains its recovery points. If this parameter is not specified, \n no minimum retention period is enforced.

    \n

    If specified, any backup or copy job to the vault must have a lifecycle policy with a\n retention period equal to or longer than the minimum retention period. If a job\n retention period is shorter than that minimum retention period, then the vault fails the\n backup or copy job, and you should either modify your lifecycle settings or use a different\n vault.

    ", + "smithy.api#documentation": "

    This setting specifies the minimum retention period\n that the vault retains its recovery points.

    \n

    The minimum value accepted is 7 days.

    ", "smithy.api#required": {} } }, "MaxRetentionDays": { "target": "com.amazonaws.backup#Long", "traits": { - "smithy.api#documentation": "

    This is the setting that specifies the maximum retention period\n that the vault retains its recovery points. If this parameter is not specified, Backup \n does not enforce a maximum retention period on the recovery points in the vault (allowing\n indefinite storage).

    \n

    If specified, any backup or copy job to the vault must have a lifecycle policy with a\n retention period equal to or shorter than the maximum retention period. If the job \n retention period is longer than that maximum retention period, then the vault fails the\n backup or copy job, and you should either modify your lifecycle settings or use a different\n vault.

    ", + "smithy.api#documentation": "

    The maximum retention period that the vault retains its recovery points.

    ", "smithy.api#required": {} } } @@ -2373,13 +2385,13 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    The name of a logical container where backups are stored. Logically air-gapped \n backup vaults are identified by names that are unique to the account used to create \n them and the Region where they are created. They consist of lowercase letters, numbers, \n and hyphens.

    " + "smithy.api#documentation": "

    The name of a logical container where backups are stored. Logically air-gapped \n backup vaults are identified by names that are unique to the account used to create \n them and the Region where they are created.

    " } }, "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    This is the ARN (Amazon Resource Name) of the vault being created.

    " + "smithy.api#documentation": "

    The ARN (Amazon Resource Name) of the vault.

    " } }, "CreationDate": { @@ -2391,7 +2403,7 @@ "VaultState": { "target": "com.amazonaws.backup#VaultState", "traits": { - "smithy.api#documentation": "

    This is the current state of the vault.

    " + "smithy.api#documentation": "

    The current state of the vault.

    " } } }, @@ -2467,7 +2479,7 @@ "ReportPlanTags": { "target": "com.amazonaws.backup#stringMap", "traits": { - "smithy.api#documentation": "

    Metadata that you can assign to help organize the report plans that you create. Each tag\n is a key-value pair.

    " + "smithy.api#documentation": "

    The tags to assign to the report plan.

    " } }, "IdempotencyToken": { @@ -2537,7 +2549,7 @@ } ], "traits": { - "smithy.api#documentation": "

    This is the first of two steps to create a restore testing \n plan; once this request is successful, finish the procedure with \n request CreateRestoreTestingSelection.

    \n

    You must include the parameter RestoreTestingPlan. You may \n optionally include CreatorRequestId and Tags.

    ", + "smithy.api#documentation": "

    Creates a restore testing plan.

    \n

    The first of two steps to create a restore testing \n plan. After this request is successful, finish the procedure using \n CreateRestoreTestingSelection.

    ", "smithy.api#http": { "method": "PUT", "uri": "/restore-testing/plans", @@ -2565,7 +2577,7 @@ "Tags": { "target": "com.amazonaws.backup#SensitiveStringMap", "traits": { - "smithy.api#documentation": "

    Optional tags to include. A tag is a key-value pair you can use to \n manage, filter, and search for your resources. Allowed characters include \n UTF-8 letters,numbers, spaces, and the following characters: \n + - = . _ : /.

    " + "smithy.api#documentation": "

    The tags to assign to the restore testing plan.

    " } } }, @@ -2675,28 +2687,28 @@ "CreationTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

    This is the time the resource testing selection was created successfully.

    ", + "smithy.api#documentation": "

    The time that the resource testing selection was created.

    ", "smithy.api#required": {} } }, "RestoreTestingPlanArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

    This is the ARN of the restore testing plan with which the restore \n testing selection is associated.

    ", + "smithy.api#documentation": "

    The ARN of the restore testing plan with which the restore \n testing selection is associated.

    ", "smithy.api#required": {} } }, "RestoreTestingPlanName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

    Unique string that is the name of the restore testing plan.

    \n

    The name cannot be changed after creation. The name consists of only \n alphanumeric characters and underscores. Maximum length is 50.

    ", + "smithy.api#documentation": "

    The name of the restore testing plan.

    \n

    The name cannot be changed after creation. The name consists of only \n alphanumeric characters and underscores. Maximum length is 50.

    ", "smithy.api#required": {} } }, "RestoreTestingSelectionName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

    This is the unique name of the restore testing selection that belongs to \n the related restore testing plan.

    ", + "smithy.api#documentation": "

    The name of the restore testing selection for the related restore testing plan.

    ", "smithy.api#required": {} } } @@ -4176,7 +4188,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

    ", + "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4275,7 +4287,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Region where they are\n created. They consist of lowercase letters, numbers, and hyphens.

    ", + "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Region where they are\n created.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4379,7 +4391,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

    ", + "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4636,13 +4648,13 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

    " + "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

    " } }, "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

    " + "smithy.api#documentation": "

    An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

    " } }, "RecoveryPointArn": { @@ -4769,19 +4781,19 @@ "ResourceName": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the non-unique name of the resource that \n belongs to the specified backup.

    " + "smithy.api#documentation": "

    The non-unique name of the resource that \n belongs to the specified backup.

    " } }, "InitiationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

    This is the date a backup job was initiated.

    " + "smithy.api#documentation": "

    The date a backup job was initiated.

    " } }, "MessageCategory": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the job count for the specified \n message category.

    \n

    Example strings may include AccessDenied, SUCCESS,\n AGGREGATE_ALL, and INVALIDPARAMETERS. View Monitoring\n for a list of accepted MessageCategory strings.

    " + "smithy.api#documentation": "

    The job count for the specified \n message category.

    \n

    Example strings may include AccessDenied, SUCCESS,\n AGGREGATE_ALL, and INVALIDPARAMETERS. View Monitoring\n for a list of accepted MessageCategory strings.

    " } } }, @@ -4827,7 +4839,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

    ", + "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4835,7 +4847,7 @@ "BackupVaultAccountId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the account ID of the specified backup vault.

    ", + "smithy.api#documentation": "

    The account ID of the specified backup vault.

    ", "smithy.api#httpQuery": "backupVaultAccountId" } } @@ -4850,19 +4862,25 @@ "BackupVaultName": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Region where they are\n created. They consist of lowercase letters, numbers, and hyphens.

    " + "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Region where they are\n created.

    " } }, "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

    " + "smithy.api#documentation": "

    An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

    " } }, "VaultType": { "target": "com.amazonaws.backup#VaultType", "traits": { - "smithy.api#documentation": "

    This is the type of vault described.

    " + "smithy.api#documentation": "

    The type of vault described.

    " + } + }, + "VaultState": { + "target": "com.amazonaws.backup#VaultState", + "traits": { + "smithy.api#documentation": "

    The current state of the vault.->

    " } }, "EncryptionKeyArn": { @@ -4899,7 +4917,7 @@ "MinRetentionDays": { "target": "com.amazonaws.backup#Long", "traits": { - "smithy.api#documentation": "

    The Backup Vault Lock setting that specifies the minimum retention period\n that the vault retains its recovery points. If this parameter is not specified, Vault Lock\n does not enforce a minimum retention period.

    \n

    If specified, any backup or copy job to the vault must have a lifecycle policy with a\n retention period equal to or longer than the minimum retention period. If the job's\n retention period is shorter than that minimum retention period, then the vault fails the\n backup or copy job, and you should either modify your lifecycle settings or use a different\n vault. Recovery points already stored in the vault prior to Vault Lock are not\n affected.

    " + "smithy.api#documentation": "

    The Backup Vault Lock setting that specifies the minimum retention period\n that the vault retains its recovery points. If this\n parameter is not specified, Vault Lock will not enforce a minimum retention period.

    \n

    If specified, any backup or copy job to the vault must have a lifecycle policy with a\n retention period equal to or longer than the minimum retention period. If the job's\n retention period is shorter than that minimum retention period, then the vault fails the\n backup or copy job, and you should either modify your lifecycle settings or use a different\n vault. Recovery points already stored in the vault prior to Vault Lock are not\n affected.

    " } }, "MaxRetentionDays": { @@ -5052,7 +5070,7 @@ "FrameworkControls": { "target": "com.amazonaws.backup#FrameworkControls", "traits": { - "smithy.api#documentation": "

    A list of the controls that make up the framework. Each control in the list has a name,\n input parameters, and scope.

    " + "smithy.api#documentation": "

    The controls that make up the framework. Each control in the list has a name,\n input parameters, and scope.

    " } }, "CreationTime": { @@ -5208,37 +5226,37 @@ "ResourceName": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the non-unique name of the resource that \n belongs to the specified backup.

    " + "smithy.api#documentation": "

    The name of the resource that belongs to the specified backup.

    " } }, "LastBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    This is the ARN (Amazon Resource Name) of the backup vault \n that contains the most recent backup recovery point.

    " + "smithy.api#documentation": "

    The ARN (Amazon Resource Name) of the backup vault \n that contains the most recent backup recovery point.

    " } }, "LastRecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    This is the ARN (Amazon Resource Name) of the most recent \n recovery point.

    " + "smithy.api#documentation": "

    The ARN (Amazon Resource Name) of the most recent \n recovery point.

    " } }, "LatestRestoreExecutionTimeMinutes": { "target": "com.amazonaws.backup#Long", "traits": { - "smithy.api#documentation": "

    This is the time in minutes the most recent restore \n job took to complete.

    " + "smithy.api#documentation": "

    The time, in minutes, that the most recent restore job took to complete.

    " } }, "LatestRestoreJobCreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

    This is the creation date of the most recent restore job.

    " + "smithy.api#documentation": "

    The creation date of the most recent restore job.

    " } }, "LatestRestoreRecoveryPointCreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

    This is the date the most recent recovery point was created.

    " + "smithy.api#documentation": "

    The date the most recent recovery point was created.

    " } } }, @@ -5284,7 +5302,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

    ", + "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5300,7 +5318,7 @@ "BackupVaultAccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { - "smithy.api#documentation": "

    This is the account ID of the specified backup vault.

    ", + "smithy.api#documentation": "

    The account ID of the specified backup vault.

    ", "smithy.api#httpQuery": "backupVaultAccountId" } } @@ -5321,19 +5339,19 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Region where they are\n created. They consist of lowercase letters, numbers, and hyphens.

    " + "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Region where they are\n created.

    " } }, "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    An ARN that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

    " + "smithy.api#documentation": "

    An ARN that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

    " } }, "SourceBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    An Amazon Resource Name (ARN) that uniquely identifies the source vault where the\n resource was originally backed up in; for example,\n arn:aws:backup:us-east-1:123456789012:vault:BackupVault. If the recovery is\n restored to the same Amazon Web Services account or Region, this value will be\n null.

    " + "smithy.api#documentation": "

    An Amazon Resource Name (ARN) that uniquely identifies the source vault where the\n resource was originally backed up in; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault. If the recovery is\n restored to the same Amazon Web Services account or Region, this value will be\n null.

    " } }, "ResourceArn": { @@ -5363,7 +5381,7 @@ "Status": { "target": "com.amazonaws.backup#RecoveryPointStatus", "traits": { - "smithy.api#documentation": "

    A status code specifying the state of the recovery point.

    \n

    \n PARTIAL status indicates Backup could not create the recovery\n point before the backup window closed. To increase your backup plan window using the API,\n see UpdateBackupPlan. You can also increase your backup plan window using the\n Console by choosing and editing your backup plan.

    \n

    \n EXPIRED status indicates that the recovery point has exceeded its retention\n period, but Backup lacks permission or is otherwise unable to delete it. To\n manually delete these recovery points, see Step 3:\n Delete the recovery points in the Clean up resources\n section of Getting started.

    \n

    \n STOPPED status occurs on a continuous backup where a user has taken some \n action that causes the continuous backup to be disabled. This can be caused by the removal\n of permissions, turning off versioning, turning off events being sent to EventBridge, \n or disabling the EventBridge rules that are put in place by Backup.

    \n

    To resolve STOPPED status, ensure that all requested permissions are in place and\n that versioning is enabled on the S3 bucket. Once these conditions are met, the next instance\n of a backup rule running will result in a new continuous recovery point being created. \n The recovery points with STOPPED status do not need to be deleted.

    \n

    For SAP HANA on Amazon EC2 STOPPED status occurs due to user action, application\n misconfiguration, or backup failure. To ensure that future continuous backups succeed,\n refer to the recovery point status and check SAP HANA for details.

    " + "smithy.api#documentation": "

    A status code specifying the state of the recovery point.

    \n

    \n PARTIAL status indicates Backup could not create the recovery\n point before the backup window closed. To increase your backup plan window using the API,\n see UpdateBackupPlan. You can also increase your backup plan window using the\n Console by choosing and editing your backup plan.

    \n

    \n EXPIRED status indicates that the recovery point has exceeded its retention\n period, but Backup lacks permission or is otherwise unable to delete it. To\n manually delete these recovery points, see Step 3:\n Delete the recovery points in the Clean up resources\n section of Getting started.

    \n

    \n STOPPED status occurs on a continuous backup where a user has taken some \n action that causes the continuous backup to be disabled. This can be caused by the removal\n of permissions, turning off versioning, turning off events being sent to EventBridge, \n or disabling the EventBridge rules that are put in place by Backup. For \n recovery points of Amazon S3, Amazon RDS, and Amazon Aurora resources, this status \n occurs when the retention period of a continuous backup rule is changed.

    \n

    To resolve STOPPED status, ensure that all requested permissions are in place and\n that versioning is enabled on the S3 bucket. Once these conditions are met, the next instance\n of a backup rule running will result in a new continuous recovery point being created. \n The recovery points with STOPPED status do not need to be deleted.

    \n

    For SAP HANA on Amazon EC2 STOPPED status occurs due to user action, application\n misconfiguration, or backup failure. To ensure that future continuous backups succeed,\n refer to the recovery point status and check SAP HANA for details.

    " } }, "StatusMessage": { @@ -5399,7 +5417,7 @@ "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { - "smithy.api#documentation": "

    The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

    \n

    Backups that are transitioned to cold storage must be stored in cold storage for a\n minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

    \n

    Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" \n section of the \n Feature availability by resource table. Backup ignores this expression for\n other resource types.

    " + "smithy.api#documentation": "

    The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

    \n

    Backups that are transitioned to cold storage must be stored in cold storage for a\n minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

    \n

    Resource types that can transition to cold storage are listed in the Feature \n availability by resource table. Backup ignores this expression for other resource types.

    " } }, "EncryptionKeyArn": { @@ -5436,7 +5454,7 @@ "CompositeMemberIdentifier": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the identifier of a resource within a composite group, such as \n nested (child) recovery point belonging to a composite (parent) stack. The \n ID is transferred from \n the \n logical ID within a stack.

    " + "smithy.api#documentation": "

    The identifier of a resource within a composite group, such as \n nested (child) recovery point belonging to a composite (parent) stack. The \n ID is transferred from the \n logical ID within a stack.

    " } }, "IsParent": { @@ -5449,13 +5467,13 @@ "ResourceName": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the non-unique name of the resource that \n belongs to the specified backup.

    " + "smithy.api#documentation": "

    The name of the resource that belongs to the specified backup.

    " } }, "VaultType": { "target": "com.amazonaws.backup#VaultType", "traits": { - "smithy.api#documentation": "

    This is the type of vault in which the described recovery point is stored.

    " + "smithy.api#documentation": "

    The type of vault in which the described recovery point is stored.

    " } } }, @@ -5498,13 +5516,13 @@ "ResourceTypeOptInPreference": { "target": "com.amazonaws.backup#ResourceTypeOptInPreference", "traits": { - "smithy.api#documentation": "

    Returns a list of all services along with the opt-in preferences in the Region.

    " + "smithy.api#documentation": "

    The services along with the opt-in preferences in the Region.

    " } }, "ResourceTypeManagementPreference": { "target": "com.amazonaws.backup#ResourceTypeManagementPreference", "traits": { - "smithy.api#documentation": "

    Returns whether Backup fully manages the backups for a resource type.

    \n

    For the benefits of full Backup management, see Full Backup management.

    \n

    For a list of resource types and whether each supports full Backup\n management, see the Feature\n availability by resource table.

    \n

    If \"DynamoDB\":false, you can enable full Backup management for\n DynamoDB backup by enabling \n Backup's advanced DynamoDB backup features.

    " + "smithy.api#documentation": "

    Returns whether Backup fully manages the backups for a resource type.

    \n

    For the benefits of full Backup management, see Full Backup \n management.

    \n

    For a list of resource types and whether each supports full Backup management, \n see the Feature availability by resource table.

    \n

    If \"DynamoDB\":false, you can enable full Backup management for\n DynamoDB backup by enabling \n Backup's advanced DynamoDB backup features.

    " } } }, @@ -5562,7 +5580,7 @@ "ReportJob": { "target": "com.amazonaws.backup#ReportJob", "traits": { - "smithy.api#documentation": "

    A list of information about a report job, including its completion and creation times,\n report destination, unique report job ID, Amazon Resource Name (ARN), report template,\n status, and status message.

    " + "smithy.api#documentation": "

    The information about a report job, including its completion and creation times,\n report destination, unique report job ID, Amazon Resource Name (ARN), report template,\n status, and status message.

    " } } }, @@ -5754,7 +5772,7 @@ "CreatedResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point\n is being restored. The format of the ARN depends on the resource type of the backed-up\n resource.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource that \n was created by the restore job.

    \n

    The format of the ARN depends on the resource type of the backed-up\n resource.

    " } }, "ResourceType": { @@ -5766,7 +5784,7 @@ "RecoveryPointCreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

    This is the creation date of the recovery point made by the specifed restore job.

    " + "smithy.api#documentation": "

    The creation date of the recovery point made by the specifed restore job.

    " } }, "CreatedBy": { @@ -5778,19 +5796,19 @@ "ValidationStatus": { "target": "com.amazonaws.backup#RestoreValidationStatus", "traits": { - "smithy.api#documentation": "

    This is the status of validation run on the indicated \n restore job.

    " + "smithy.api#documentation": "

    The status of validation run on the indicated \n restore job.

    " } }, "ValidationStatusMessage": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This describes the status of validation run on the \n indicated restore job.

    " + "smithy.api#documentation": "

    The status message.

    " } }, "DeletionStatus": { "target": "com.amazonaws.backup#RestoreDeletionStatus", "traits": { - "smithy.api#documentation": "

    This notes the status of the data generated by the restore test. \n The status may be Deleting, Failed, \n or Successful.

    " + "smithy.api#documentation": "

    The status of the data generated by the restore test.

    " } }, "DeletionStatusMessage": { @@ -5881,7 +5899,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    This is the name of a logical container where the child (nested) recovery point\n is stored. Backup vaults are identified by names that are unique to the account used \n to create them and the Amazon Web Services Region where they are created. They consist of lowercase \n letters, numbers, and hyphens.

    ", + "smithy.api#documentation": "

    The name of a logical container where the child (nested) recovery point\n is stored. Backup vaults are identified by names that are unique to the account used \n to create them and the Amazon Web Services Region where they are created.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5889,7 +5907,7 @@ "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    This is the Amazon Resource Name (ARN) that uniquely identifies the child \n (nested) recovery point; for example, \n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.\n

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) that uniquely identifies the child \n (nested) recovery point; for example, \n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.\n

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6048,7 +6066,7 @@ "ControlInputParameters": { "target": "com.amazonaws.backup#ControlInputParameters", "traits": { - "smithy.api#documentation": "

    A list of ParameterName and ParameterValue pairs.

    " + "smithy.api#documentation": "

    The name/value pairs.

    " } }, "ControlScope": { @@ -6321,7 +6339,7 @@ "LastExecutionDate": { "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

    The last time a job to back up resources was run with this backup plan. A date and time,\n in Unix format and Coordinated Universal Time (UTC). The value of\n LastExecutionDate is accurate to milliseconds. For example, the value\n 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    " + "smithy.api#documentation": "

    The last time this backup plan was run. A date and time,\n in Unix format and Coordinated Universal Time (UTC). The value of\n LastExecutionDate is accurate to milliseconds. For example, the value\n 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    " } }, "AdvancedBackupSettings": { @@ -6467,7 +6485,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

    ", + "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6483,13 +6501,13 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Region where they are\n created. They consist of lowercase letters, numbers, and hyphens.

    " + "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Region where they are\n created.

    " } }, "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

    " + "smithy.api#documentation": "

    An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

    " } }, "Policy": { @@ -6541,7 +6559,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

    ", + "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6557,13 +6575,13 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Region where they are\n created. They consist of lowercase letters, numbers, and hyphens.

    " + "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Region where they are\n created.

    " } }, "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

    " + "smithy.api#documentation": "

    An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

    " } }, "SNSTopicArn": { @@ -6621,7 +6639,7 @@ "LegalHoldId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the ID required to use GetLegalHold. This unique ID \n is associated with a specific legal hold.

    ", + "smithy.api#documentation": "

    The ID of the legal hold.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6637,61 +6655,61 @@ "Title": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the string title of the legal hold.

    " + "smithy.api#documentation": "

    The title of the legal hold.

    " } }, "Status": { "target": "com.amazonaws.backup#LegalHoldStatus", "traits": { - "smithy.api#documentation": "

    This is the status of the legal hold. Statuses can be \n ACTIVE, CREATING, CANCELED, and \n CANCELING.

    " + "smithy.api#documentation": "

    The status of the legal hold.

    " } }, "Description": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the returned string description of the legal hold.

    " + "smithy.api#documentation": "

    The description of the legal hold.

    " } }, "CancelDescription": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    String describing the reason for removing the legal hold.

    " + "smithy.api#documentation": "

    The reason for removing the legal hold.

    " } }, "LegalHoldId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the returned ID associated with a specified legal hold.

    " + "smithy.api#documentation": "

    The ID of the legal hold.

    " } }, "LegalHoldArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    This is the returned framework ARN for the specified legal hold. \n An Amazon Resource Name (ARN) uniquely identifies a resource. The format \n of the ARN depends on the resource type.

    " + "smithy.api#documentation": "

    The framework ARN for the specified legal hold. The format \n of the ARN depends on the resource type.

    " } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

    Time in number format when legal hold was created.

    " + "smithy.api#documentation": "

    The time when the legal hold was created.

    " } }, "CancellationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

    Time in number when legal hold was cancelled.

    " + "smithy.api#documentation": "

    The time when the legal hold was cancelled.

    " } }, "RetainRecordUntil": { "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

    This is the date and time until which the legal hold record will \n be retained.

    " + "smithy.api#documentation": "

    The date and time until which the legal hold record is retained.

    " } }, "RecoveryPointSelection": { "target": "com.amazonaws.backup#RecoveryPointSelection", "traits": { - "smithy.api#documentation": "

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

    " + "smithy.api#documentation": "

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

    " } } }, @@ -6737,7 +6755,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

    ", + "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6753,7 +6771,7 @@ "BackupVaultAccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { - "smithy.api#documentation": "

    This is the account ID of the specified backup vault.

    ", + "smithy.api#documentation": "

    The account ID of the specified backup vault.

    ", "smithy.api#httpQuery": "backupVaultAccountId" } } @@ -6768,7 +6786,7 @@ "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    An ARN that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

    " + "smithy.api#documentation": "

    An ARN that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

    " } }, "RecoveryPointArn": { @@ -6786,7 +6804,7 @@ "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

    This is the resource type associated with the recovery point.

    " + "smithy.api#documentation": "

    The resource type of the recovery point.

    " } } }, @@ -6898,7 +6916,7 @@ "BackupVaultAccountId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

    This is the account ID of the specified backup vault.

    ", + "smithy.api#documentation": "

    The account ID of the specified backup vault.

    ", "smithy.api#httpQuery": "BackupVaultAccountId" } }, @@ -7086,7 +7104,7 @@ "ResourceTypes": { "target": "com.amazonaws.backup#ResourceTypes", "traits": { - "smithy.api#documentation": "

    Contains a string with the supported Amazon Web Services resource types:

    \n
      \n
    • \n

      \n Aurora for Amazon Aurora

      \n
      • \n
    • \n

      \n DynamoDB for Amazon DynamoDB

      \n
      • \n
    • \n

      \n EBS for Amazon Elastic Block Store

      \n
      • \n
    • \n

      \n EC2 for Amazon Elastic Compute Cloud

      \n
      • \n
    • \n

      \n EFS for Amazon Elastic File System

      \n
      • \n
    • \n

      \n FSX for Amazon FSx

      \n
      • \n
    • \n

      \n RDS for Amazon Relational Database Service

      \n
      • \n
    • \n

      \n Storage Gateway for Storage Gateway

      \n
      • \n
    • \n

      \n DocDB for Amazon DocumentDB (with MongoDB compatibility)

      \n
      • \n
    • \n

      \n Neptune for Amazon Neptune

      \n
      • \n
    " + "smithy.api#documentation": "

    Contains a string with the supported Amazon Web Services resource types:

    \n
      \n
    • \n

      \n Aurora for Amazon Aurora

      \n
      • \n
    • \n

      \n CloudFormation for CloudFormation

      \n
      • \n
    • \n

      \n DocumentDB for Amazon DocumentDB (with MongoDB compatibility)

      \n
      • \n
    • \n

      \n DynamoDB for Amazon DynamoDB

      \n
      • \n
    • \n

      \n EBS for Amazon Elastic Block Store

      \n
      • \n
    • \n

      \n EC2 for Amazon Elastic Compute Cloud

      \n
      • \n
    • \n

      \n EFS for Amazon Elastic File System

      \n
      • \n
    • \n

      \n FSx for Amazon FSx

      \n
      • \n
    • \n

      \n Neptune for Amazon Neptune

      \n
      • \n
    • \n

      \n RDS for Amazon Relational Database Service

      \n
      • \n
    • \n

      \n Redshift for Amazon Redshift

      \n
      • \n
    • \n

      \n S3 for Amazon Simple Storage Service (Amazon S3)

      \n
      • \n
    • \n

      \n SAP HANA on Amazon EC2 for SAP HANA databases \n on Amazon Elastic Compute Cloud instances

      \n
      • \n
    • \n

      \n Storage Gateway for Storage Gateway

      \n
      • \n
    • \n

      \n Timestream for Amazon Timestream

      \n
      • \n
    • \n

      \n VirtualMachine for VMware virtual machines

      \n
      • \n
    " } } }, @@ -7236,43 +7254,43 @@ "Title": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the title of a legal hold.

    " + "smithy.api#documentation": "

    The title of a legal hold.

    " } }, "Status": { "target": "com.amazonaws.backup#LegalHoldStatus", "traits": { - "smithy.api#documentation": "

    This is the status of the legal hold. Statuses can be \n ACTIVE, CREATING, CANCELED, and \n CANCELING.

    " + "smithy.api#documentation": "

    The status of the legal hold.

    " } }, "Description": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the description of a legal hold.

    " + "smithy.api#documentation": "

    The description of a legal hold.

    " } }, "LegalHoldId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    ID of specific legal hold on one or more recovery points.

    " + "smithy.api#documentation": "

    The ID of the legal hold.

    " } }, "LegalHoldArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example, \n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the legal hold; for example, \n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

    " } }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

    This is the time in number format when legal hold was created.

    " + "smithy.api#documentation": "

    The time when the legal hold was created.

    " } }, "CancellationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

    This is the time in number format when legal hold was cancelled.

    " + "smithy.api#documentation": "

    The time when the legal hold was cancelled.

    " } } }, @@ -7321,24 +7339,24 @@ "MoveToColdStorageAfterDays": { "target": "com.amazonaws.backup#Long", "traits": { - "smithy.api#documentation": "

    Specifies the number of days after creation that a recovery point is moved to cold\n storage.

    " + "smithy.api#documentation": "

    The number of days after creation that a recovery point is moved to cold\n storage.

    " } }, "DeleteAfterDays": { "target": "com.amazonaws.backup#Long", "traits": { - "smithy.api#documentation": "

    Specifies the number of days after creation that a recovery point is deleted. Must be\n greater than 90 days plus MoveToColdStorageAfterDays.

    " + "smithy.api#documentation": "

    The number of days after creation that a recovery point is deleted. This value must be\n at least 90 days after the number of days specified in MoveToColdStorageAfterDays.

    " } }, "OptInToArchiveForSupportedResources": { "target": "com.amazonaws.backup#Boolean", "traits": { - "smithy.api#documentation": "

    Optional Boolean. If this is true, this setting will \n instruct your backup plan to transition supported resources to \n archive (cold) storage tier in accordance with your lifecycle settings.

    " + "smithy.api#documentation": "

    If the value is true, your backup plan transitions supported resources to \n archive (cold) storage tier in accordance with your lifecycle settings.

    " } } }, "traits": { - "smithy.api#documentation": "

    Contains an array of Transition objects specifying how long in days before\n a recovery point transitions to cold storage or is deleted.

    \n

    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, on the console, the “retention” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

    \n

    Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" \n section of the \n Feature availability by resource table. Backup ignores this expression for\n other resource types.

    " + "smithy.api#documentation": "

    Specifies the time period, in days, before a recovery point transitions to cold storage \n or is deleted.

    \n

    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, on the console, the retention setting must be 90 days greater than the\n transition to cold after days setting. The transition to cold after days setting can't\n be changed after a backup has been transitioned to cold.

    \n

    Resource types that can transition to cold storage are listed in the Feature \n availability by resource table. Backup ignores this expression for\n other resource types.

    \n

    To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, \n specify -1 for MoveToColdStorageAfterDays and DeleteAfterDays.

    " } }, "com.amazonaws.backup#LimitExceededException": { @@ -7432,14 +7450,14 @@ "AggregationPeriod": { "target": "com.amazonaws.backup#AggregationPeriod", "traits": { - "smithy.api#documentation": "

    This is the period that sets the boundaries for returned \n results.

    \n

    Acceptable values include

    \n
      \n
    • \n

      \n ONE_DAY for daily job count\n for the prior 14 days.

      \n
      • \n
    • \n

      \n SEVEN_DAYS for the aggregated \n job count for the prior 7 days.

      \n
      • \n
    • \n

      \n FOURTEEN_DAYS for aggregated \n job count for prior 14 days.

      \n
      • \n
    ", + "smithy.api#documentation": "

    The period for the returned results.

    \n
      \n
    • \n

      \n ONE_DAY - The daily job count for the prior 14 days.

      \n
      • \n
    • \n

      \n SEVEN_DAYS - The aggregated job count for the prior 7 days.

      \n
      • \n
    • \n

      \n FOURTEEN_DAYS - The aggregated job count for prior 14 days.

      \n
      • \n
    ", "smithy.api#httpQuery": "AggregationPeriod" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { - "smithy.api#documentation": "

    This parameter sets the maximum number of items \n to be returned.

    \n

    The value is an integer. Range of accepted values is from \n 1 to 500.

    ", + "smithy.api#documentation": "

    The maximum number of items to be returned.

    \n

    The value is an integer. Range of accepted values is from \n 1 to 500.

    ", "smithy.api#httpQuery": "MaxResults" } }, @@ -7461,13 +7479,13 @@ "BackupJobSummaries": { "target": "com.amazonaws.backup#BackupJobSummaryList", "traits": { - "smithy.api#documentation": "

    This request returns a summary that contains \n Region, Account, State, ResourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

    " + "smithy.api#documentation": "

    The summary information.

    " } }, "AggregationPeriod": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the period that sets the boundaries for returned \n results.

    \n
      \n
    • \n

      \n ONE_DAY for daily job count\n for the prior 14 days.

      \n
      • \n
    • \n

      \n SEVEN_DAYS for the aggregated \n job count for the prior 7 days.

      \n
      • \n
    • \n

      \n FOURTEEN_DAYS for aggregated \n job count for prior 14 days.

      \n
      • \n
    " + "smithy.api#documentation": "

    The period for the returned results.

    \n
      \n
    • \n

      \n ONE_DAY - The daily job count for the prior 14 days.

      \n
      • \n
    • \n

      \n SEVEN_DAYS - The aggregated job count for the prior 7 days.

      \n
      • \n
    • \n

      \n FOURTEEN_DAYS - The aggregated job count for prior 14 days.

      \n
      • \n
    " } }, "NextToken": { @@ -7547,7 +7565,7 @@ "ByBackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    Returns only backup jobs that will be stored in the specified backup vault. Backup\n vaults are identified by names that are unique to the account used to create them and the\n Amazon Web Services Region where they are created. They consist of lowercase letters,\n numbers, and hyphens.

    ", + "smithy.api#documentation": "

    Returns only backup jobs that will be stored in the specified backup vault. Backup\n vaults are identified by names that are unique to the account used to create them and the\n Amazon Web Services Region where they are created.

    ", "smithy.api#httpQuery": "backupVaultName" } }, @@ -7568,7 +7586,7 @@ "ByResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

    Returns only backup jobs for the specified resources:

    \n
      \n
    • \n

      \n Aurora for Amazon Aurora

      \n
      • \n
    • \n

      \n CloudFormation for CloudFormation

      \n
      • \n
    • \n

      \n DocumentDB for Amazon DocumentDB (with MongoDB compatibility)

      \n
      • \n
    • \n

      \n DynamoDB for Amazon DynamoDB

      \n
      • \n
    • \n

      \n EBS for Amazon Elastic Block Store

      \n
      • \n
    • \n

      \n EC2 for Amazon Elastic Compute Cloud

      \n
      • \n
    • \n

      \n EFS for Amazon Elastic File System

      \n
      • \n
    • \n

      \n FSx for Amazon FSx

      \n
      • \n
    • \n

      \n Neptune for Amazon Neptune

      \n
      • \n
    • \n

      \n Redshift for Amazon Redshift

      \n
      • \n
    • \n

      \n RDS for Amazon Relational Database Service

      \n
      • \n
    • \n

      \n SAP HANA on Amazon EC2 for SAP HANA databases

      \n
      • \n
    • \n

      \n Storage Gateway for Storage Gateway

      \n
      • \n
    • \n

      \n S3 for Amazon S3

      \n
      • \n
    • \n

      \n Timestream for Amazon Timestream

      \n
      • \n
    • \n

      \n VirtualMachine for virtual machines

      \n
      • \n
    ", + "smithy.api#documentation": "

    Returns only backup jobs for the specified resources:

    \n
      \n
    • \n

      \n Aurora for Amazon Aurora

      \n
      • \n
    • \n

      \n CloudFormation for CloudFormation

      \n
      • \n
    • \n

      \n DocumentDB for Amazon DocumentDB (with MongoDB compatibility)

      \n
      • \n
    • \n

      \n DynamoDB for Amazon DynamoDB

      \n
      • \n
    • \n

      \n EBS for Amazon Elastic Block Store

      \n
      • \n
    • \n

      \n EC2 for Amazon Elastic Compute Cloud

      \n
      • \n
    • \n

      \n EFS for Amazon Elastic File System

      \n
      • \n
    • \n

      \n FSx for Amazon FSx

      \n
      • \n
    • \n

      \n Neptune for Amazon Neptune

      \n
      • \n
    • \n

      \n RDS for Amazon Relational Database Service

      \n
      • \n
    • \n

      \n Redshift for Amazon Redshift

      \n
      • \n
    • \n

      \n S3 for Amazon Simple Storage Service (Amazon S3)

      \n
      • \n
    • \n

      \n SAP HANA on Amazon EC2 for SAP HANA databases \n on Amazon Elastic Compute Cloud instances

      \n
      • \n
    • \n

      \n Storage Gateway for Storage Gateway

      \n
      • \n
    • \n

      \n Timestream for Amazon Timestream

      \n
      • \n
    • \n

      \n VirtualMachine for VMware virtual machines

      \n
      • \n
    ", "smithy.api#httpQuery": "resourceType" } }, @@ -7655,7 +7673,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns metadata of your saved backup plan templates, including the template ID, name,\n and the creation and deletion dates.

    ", + "smithy.api#documentation": "

    Lists the backup plan templates.

    ", "smithy.api#http": { "method": "GET", "uri": "/backup/template/plans", @@ -7682,7 +7700,7 @@ "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { - "smithy.api#documentation": "

    The maximum number of items to be returned.

    ", + "smithy.api#documentation": "

    The maximum number of items to return.

    ", "smithy.api#httpQuery": "maxResults" } } @@ -7822,7 +7840,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns a list of all active backup plans for an authenticated account. The list\n contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion\n dates, version IDs, plan names, and creator request IDs.

    ", + "smithy.api#documentation": "

    Lists the active backup plans for the account.

    ", "smithy.api#http": { "method": "GET", "uri": "/backup/plans", @@ -7878,7 +7896,7 @@ "BackupPlansList": { "target": "com.amazonaws.backup#BackupPlansList", "traits": { - "smithy.api#documentation": "

    An array of backup plan list items containing metadata about your saved backup\n plans.

    " + "smithy.api#documentation": "

    Information about the backup plans.

    " } } }, @@ -8133,7 +8151,7 @@ "AggregationPeriod": { "target": "com.amazonaws.backup#AggregationPeriod", "traits": { - "smithy.api#documentation": "

    This is the period that sets the boundaries for returned \n results.

    \n
      \n
    • \n

      \n ONE_DAY for daily job count\n for the prior 14 days.

      \n
      • \n
    • \n

      \n SEVEN_DAYS for the aggregated \n job count for the prior 7 days.

      \n
      • \n
    • \n

      \n FOURTEEN_DAYS for aggregated \n job count for prior 14 days.

      \n
      • \n
    ", + "smithy.api#documentation": "

    The period for the returned results.

    \n
      \n
    • \n

      \n ONE_DAY - The daily job count for the prior 14 days.

      \n
      • \n
    • \n

      \n SEVEN_DAYS - The aggregated job count for the prior 7 days.

      \n
      • \n
    • \n

      \n FOURTEEN_DAYS - The aggregated job count for prior 14 days.

      \n
      • \n
    ", "smithy.api#httpQuery": "AggregationPeriod" } }, @@ -8168,7 +8186,7 @@ "AggregationPeriod": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the period that sets the boundaries for returned \n results.

    \n
      \n
    • \n

      \n ONE_DAY for daily job count\n for the prior 14 days.

      \n
      • \n
    • \n

      \n SEVEN_DAYS for the aggregated \n job count for the prior 7 days.

      \n
      • \n
    • \n

      \n FOURTEEN_DAYS for aggregated \n job count for prior 14 days.

      \n
      • \n
    " + "smithy.api#documentation": "

    The period for the returned results.

    \n
      \n
    • \n

      \n ONE_DAY - The daily job count for the prior 14 days.

      \n
      • \n
    • \n

      \n SEVEN_DAYS - The aggregated job count for the prior 7 days.

      \n
      • \n
    • \n

      \n FOURTEEN_DAYS - The aggregated job count for prior 14 days.

      \n
      • \n
    " } }, "NextToken": { @@ -8261,14 +8279,14 @@ "ByResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

    Returns only backup jobs for the specified resources:

    \n
      \n
    • \n

      \n Aurora for Amazon Aurora

      \n
      • \n
    • \n

      \n CloudFormation for CloudFormation

      \n
      • \n
    • \n

      \n DocumentDB for Amazon DocumentDB (with MongoDB compatibility)

      \n
      • \n
    • \n

      \n DynamoDB for Amazon DynamoDB

      \n
      • \n
    • \n

      \n EBS for Amazon Elastic Block Store

      \n
      • \n
    • \n

      \n EC2 for Amazon Elastic Compute Cloud

      \n
      • \n
    • \n

      \n EFS for Amazon Elastic File System

      \n
      • \n
    • \n

      \n FSx for Amazon FSx

      \n
      • \n
    • \n

      \n Neptune for Amazon Neptune

      \n
      • \n
    • \n

      \n Redshift for Amazon Redshift

      \n
      • \n
    • \n

      \n RDS for Amazon Relational Database Service

      \n
      • \n
    • \n

      \n SAP HANA on Amazon EC2 for SAP HANA databases

      \n
      • \n
    • \n

      \n Storage Gateway for Storage Gateway

      \n
      • \n
    • \n

      \n S3 for Amazon S3

      \n
      • \n
    • \n

      \n Timestream for Amazon Timestream

      \n
      • \n
    • \n

      \n VirtualMachine for virtual machines

      \n
      • \n
    ", + "smithy.api#documentation": "

    Returns only backup jobs for the specified resources:

    \n
      \n
    • \n

      \n Aurora for Amazon Aurora

      \n
      • \n
    • \n

      \n CloudFormation for CloudFormation

      \n
      • \n
    • \n

      \n DocumentDB for Amazon DocumentDB (with MongoDB compatibility)

      \n
      • \n
    • \n

      \n DynamoDB for Amazon DynamoDB

      \n
      • \n
    • \n

      \n EBS for Amazon Elastic Block Store

      \n
      • \n
    • \n

      \n EC2 for Amazon Elastic Compute Cloud

      \n
      • \n
    • \n

      \n EFS for Amazon Elastic File System

      \n
      • \n
    • \n

      \n FSx for Amazon FSx

      \n
      • \n
    • \n

      \n Neptune for Amazon Neptune

      \n
      • \n
    • \n

      \n RDS for Amazon Relational Database Service

      \n
      • \n
    • \n

      \n Redshift for Amazon Redshift

      \n
      • \n
    • \n

      \n S3 for Amazon Simple Storage Service (Amazon S3)

      \n
      • \n
    • \n

      \n SAP HANA on Amazon EC2 for SAP HANA databases \n on Amazon Elastic Compute Cloud instances

      \n
      • \n
    • \n

      \n Storage Gateway for Storage Gateway

      \n
      • \n
    • \n

      \n Timestream for Amazon Timestream

      \n
      • \n
    • \n

      \n VirtualMachine for VMware virtual machines

      \n
      • \n
    ", "smithy.api#httpQuery": "resourceType" } }, "ByDestinationVaultArn": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy\n from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.\n

    ", + "smithy.api#documentation": "

    An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy\n from; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.\n

    ", "smithy.api#httpQuery": "destinationVaultArn" } }, @@ -8390,7 +8408,7 @@ "Frameworks": { "target": "com.amazonaws.backup#FrameworkList", "traits": { - "smithy.api#documentation": "

    A list of frameworks with details for each framework, including the framework name,\n Amazon Resource Name (ARN), description, number of controls, creation time, and deployment\n status.

    " + "smithy.api#documentation": "

    The frameworks with details for each framework, including the framework name,\n Amazon Resource Name (ARN), description, number of controls, creation time, and deployment\n status.

    " } }, "NextToken": { @@ -8556,7 +8574,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    This is the list of protected resources by backup vault within the vault(s) you specify by name.

    ", + "smithy.api#documentation": "

    The list of protected resources by backup vault within the vault(s) you specify by name.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8564,7 +8582,7 @@ "BackupVaultAccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { - "smithy.api#documentation": "

    This is the list of protected resources by backup vault within the vault(s) you specify by account ID.

    ", + "smithy.api#documentation": "

    The list of protected resources by backup vault within the vault(s) you specify by account ID.

    ", "smithy.api#httpQuery": "backupVaultAccountId" } }, @@ -8693,7 +8711,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

    \n \n

    Backup vault name might not be available when a supported service creates the\n backup.

    \n     ", + "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

    \n \n

    Backup vault name might not be available when a supported service creates the\n backup.

    \n     ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8729,7 +8747,7 @@ "ByResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

    Returns only recovery points that match the specified resource type(s):

    \n
      \n
    • \n

      \n Aurora for Amazon Aurora

      \n
      • \n
    • \n

      \n CloudFormation for CloudFormation

      \n
      • \n
    • \n

      \n DocumentDB for Amazon DocumentDB (with MongoDB compatibility)

      \n
      • \n
    • \n

      \n DynamoDB for Amazon DynamoDB

      \n
      • \n
    • \n

      \n EBS for Amazon Elastic Block Store

      \n
      • \n
    • \n

      \n EC2 for Amazon Elastic Compute Cloud

      \n
      • \n
    • \n

      \n EFS for Amazon Elastic File System

      \n
      • \n
    • \n

      \n FSx for Amazon FSx

      \n
      • \n
    • \n

      \n Neptune for Amazon Neptune

      \n
      • \n
    • \n

      \n Redshift for Amazon Redshift

      \n
      • \n
    • \n

      \n RDS for Amazon Relational Database Service

      \n
      • \n
    • \n

      \n SAP HANA on Amazon EC2 for SAP HANA databases

      \n
      • \n
    • \n

      \n Storage Gateway for Storage Gateway

      \n
      • \n
    • \n

      \n S3 for Amazon S3

      \n
      • \n
    • \n

      \n Timestream for Amazon Timestream

      \n
      • \n
    • \n

      \n VirtualMachine for virtual machines

      \n
      • \n
    ", + "smithy.api#documentation": "

    Returns only recovery points that match the specified resource type(s):

    \n
      \n
    • \n

      \n Aurora for Amazon Aurora

      \n
      • \n
    • \n

      \n CloudFormation for CloudFormation

      \n
      • \n
    • \n

      \n DocumentDB for Amazon DocumentDB (with MongoDB compatibility)

      \n
      • \n
    • \n

      \n DynamoDB for Amazon DynamoDB

      \n
      • \n
    • \n

      \n EBS for Amazon Elastic Block Store

      \n
      • \n
    • \n

      \n EC2 for Amazon Elastic Compute Cloud

      \n
      • \n
    • \n

      \n EFS for Amazon Elastic File System

      \n
      • \n
    • \n

      \n FSx for Amazon FSx

      \n
      • \n
    • \n

      \n Neptune for Amazon Neptune

      \n
      • \n
    • \n

      \n RDS for Amazon Relational Database Service

      \n
      • \n
    • \n

      \n Redshift for Amazon Redshift

      \n
      • \n
    • \n

      \n S3 for Amazon Simple Storage Service (Amazon S3)

      \n
      • \n
    • \n

      \n SAP HANA on Amazon EC2 for SAP HANA databases \n on Amazon Elastic Compute Cloud instances

      \n
      • \n
    • \n

      \n Storage Gateway for Storage Gateway

      \n
      • \n
    • \n

      \n Timestream for Amazon Timestream

      \n
      • \n
    • \n

      \n VirtualMachine for VMware virtual machines

      \n
      • \n
    ", "smithy.api#httpQuery": "resourceType" } }, @@ -8827,7 +8845,7 @@ "LegalHoldId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the ID of the legal hold.

    ", + "smithy.api#documentation": "

    The ID of the legal hold.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8835,14 +8853,14 @@ "NextToken": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the next item following a partial list of returned resources. For example, if a request\n is made to return MaxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

    ", + "smithy.api#documentation": "

    The next item following a partial list of returned resources. For example, if a request\n is made to return MaxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

    ", "smithy.api#httpQuery": "nextToken" } }, "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { - "smithy.api#documentation": "

    This is the maximum number of resource list items to be returned.

    ", + "smithy.api#documentation": "

    The maximum number of resource list items to be returned.

    ", "smithy.api#httpQuery": "maxResults" } } @@ -8857,13 +8875,13 @@ "RecoveryPoints": { "target": "com.amazonaws.backup#RecoveryPointsList", "traits": { - "smithy.api#documentation": "

    This is a list of the recovery points returned by \n ListRecoveryPointsByLegalHold.

    " + "smithy.api#documentation": "

    The recovery points.

    " } }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This return is the next item following a partial list of returned resources.

    " + "smithy.api#documentation": "

    The next item following a partial list of returned resources.

    " } } }, @@ -8894,7 +8912,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns detailed information about all the recovery points of the type specified by a\n resource Amazon Resource Name (ARN).

    \n \n

    For Amazon EFS and Amazon EC2, this action only lists recovery points\n created by Backup.

    \n     ", + "smithy.api#documentation": "

    The information about the recovery points of the type specified by a\n resource Amazon Resource Name (ARN).

    \n \n

    For Amazon EFS and Amazon EC2, this action only lists recovery points\n created by Backup.

    \n     ", "smithy.api#http": { "method": "GET", "uri": "/resources/{ResourceArn}/recovery-points", @@ -9128,7 +9146,7 @@ "ReportPlans": { "target": "com.amazonaws.backup#ReportPlanList", "traits": { - "smithy.api#documentation": "

    A list of your report plans with detailed information for each plan. This information\n includes the Amazon Resource Name (ARN), report plan name, description, settings, delivery\n channel, deployment status, creation time, and last times the report plan attempted to and\n successfully ran.

    " + "smithy.api#documentation": "

    The report plans with detailed information for each plan. This information\n includes the Amazon Resource Name (ARN), report plan name, description, settings, delivery\n channel, deployment status, creation time, and last times the report plan attempted to and\n successfully ran.

    " } }, "NextToken": { @@ -9199,7 +9217,7 @@ "AggregationPeriod": { "target": "com.amazonaws.backup#AggregationPeriod", "traits": { - "smithy.api#documentation": "

    This is the period that sets the boundaries for returned \n results.

    \n

    Acceptable values include

    \n
      \n
    • \n

      \n ONE_DAY for daily job count\n for the prior 14 days.

      \n
      • \n
    • \n

      \n SEVEN_DAYS for the aggregated \n job count for the prior 7 days.

      \n
      • \n
    • \n

      \n FOURTEEN_DAYS for aggregated \n job count for prior 14 days.

      \n
      • \n
    ", + "smithy.api#documentation": "

    The period for the returned results.

    \n
      \n
    • \n

      \n ONE_DAY - The daily job count for the prior 14 days.

      \n
      • \n
    • \n

      \n SEVEN_DAYS - The aggregated job count for the prior 7 days.

      \n
      • \n
    • \n

      \n FOURTEEN_DAYS - The aggregated job count for prior 14 days.

      \n
      • \n
    ", "smithy.api#httpQuery": "AggregationPeriod" } }, @@ -9234,7 +9252,7 @@ "AggregationPeriod": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the period that sets the boundaries for returned \n results.

    \n
      \n
    • \n

      \n ONE_DAY for daily job count\n for the prior 14 days.

      \n
      • \n
    • \n

      \n SEVEN_DAYS for the aggregated \n job count for the prior 7 days.

      \n
      • \n
    • \n

      \n FOURTEEN_DAYS for aggregated \n job count for prior 14 days.

      \n
      • \n
    " + "smithy.api#documentation": "

    The period for the returned results.

    \n
      \n
    • \n

      \n ONE_DAY - The daily job count for the prior 14 days.

      \n
      • \n
    • \n

      \n SEVEN_DAYS - The aggregated job count for the prior 7 days.

      \n
      • \n
    • \n

      \n FOURTEEN_DAYS - The aggregated job count for prior 14 days.

      \n
      • \n
    " } }, "NextToken": { @@ -9421,7 +9439,7 @@ "ByResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

    Include this parameter to return only restore jobs for the \n specified resources:

    \n
      \n
    • \n

      \n Aurora for Amazon Aurora

      \n
      • \n
    • \n

      \n CloudFormation for CloudFormation

      \n
      • \n
    • \n

      \n DocumentDB for Amazon DocumentDB (with MongoDB compatibility)

      \n
      • \n
    • \n

      \n DynamoDB for Amazon DynamoDB

      \n
      • \n
    • \n

      \n EBS for Amazon Elastic Block Store

      \n
      • \n
    • \n

      \n EC2 for Amazon Elastic Compute Cloud

      \n
      • \n
    • \n

      \n EFS for Amazon Elastic File System

      \n
      • \n
    • \n

      \n FSx for Amazon FSx

      \n
      • \n
    • \n

      \n Neptune for Amazon Neptune

      \n
      • \n
    • \n

      \n Redshift for Amazon Redshift

      \n
      • \n
    • \n

      \n RDS for Amazon Relational Database Service

      \n
      • \n
    • \n

      \n SAP HANA on Amazon EC2 for SAP HANA databases

      \n
      • \n
    • \n

      \n Storage Gateway for Storage Gateway

      \n
      • \n
    • \n

      \n S3 for Amazon S3

      \n
      • \n
    • \n

      \n Timestream for Amazon Timestream

      \n
      • \n
    • \n

      \n VirtualMachine for virtual machines

      \n
      • \n
    ", + "smithy.api#documentation": "

    Include this parameter to return only restore jobs for the specified resources:

    \n
      \n
    • \n

      \n Aurora for Amazon Aurora

      \n
      • \n
    • \n

      \n CloudFormation for CloudFormation

      \n
      • \n
    • \n

      \n DocumentDB for Amazon DocumentDB (with MongoDB compatibility)

      \n
      • \n
    • \n

      \n DynamoDB for Amazon DynamoDB

      \n
      • \n
    • \n

      \n EBS for Amazon Elastic Block Store

      \n
      • \n
    • \n

      \n EC2 for Amazon Elastic Compute Cloud

      \n
      • \n
    • \n

      \n EFS for Amazon Elastic File System

      \n
      • \n
    • \n

      \n FSx for Amazon FSx

      \n
      • \n
    • \n

      \n Neptune for Amazon Neptune

      \n
      • \n
    • \n

      \n RDS for Amazon Relational Database Service

      \n
      • \n
    • \n

      \n Redshift for Amazon Redshift

      \n
      • \n
    • \n

      \n S3 for Amazon Simple Storage Service (Amazon S3)

      \n
      • \n
    • \n

      \n SAP HANA on Amazon EC2 for SAP HANA databases \n on Amazon Elastic Compute Cloud instances

      \n
      • \n
    • \n

      \n Storage Gateway for Storage Gateway

      \n
      • \n
    • \n

      \n Timestream for Amazon Timestream

      \n
      • \n
    • \n

      \n VirtualMachine for VMware virtual machines

      \n
      • \n
    ", "smithy.api#httpQuery": "resourceType" } }, @@ -9692,7 +9710,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns a list of key-value pairs assigned to a target recovery point, backup plan, or\n backup vault.

    \n

    \n ListTags only works for resource types that support full Backup\n management of their backups. Those resource types are listed in the \"Full Backup management\" section of the Feature\n availability by resource table.

    ", + "smithy.api#documentation": "

    Returns the tags assigned to the resource, such as a target recovery point, backup plan, or\n backup vault.

    ", "smithy.api#http": { "method": "GET", "uri": "/tags/{ResourceArn}", @@ -9748,7 +9766,7 @@ "Tags": { "target": "com.amazonaws.backup#Tags", "traits": { - "smithy.api#documentation": "

    To help organize your resources, you can assign your own metadata to the resources you\n create. Each tag is a key-value pair.

    " + "smithy.api#documentation": "

    Information about the tags.

    " } } }, @@ -9861,19 +9879,19 @@ "ResourceName": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the non-unique name of the resource that \n belongs to the specified backup.

    " + "smithy.api#documentation": "

    The non-unique name of the resource that \n belongs to the specified backup.

    " } }, "LastBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    This is the ARN (Amazon Resource Name) of the backup vault \n that contains the most recent backup recovery point.

    " + "smithy.api#documentation": "

    The ARN (Amazon Resource Name) of the backup vault \n that contains the most recent backup recovery point.

    " } }, "LastRecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    This is the ARN (Amazon Resource Name) of the most \n recent recovery point.

    " + "smithy.api#documentation": "

    The ARN (Amazon Resource Name) of the most \n recent recovery point.

    " } } }, @@ -9898,7 +9916,7 @@ } }, "traits": { - "smithy.api#documentation": "

    A list of conditions that you define for resources in \n your restore testing plan using tags.

    \n

    For example, \n \"StringEquals\": { \"Key\": \"aws:ResourceTag/CreatedByCryo\", \"Value\": \"true\" },. \n Condition operators are case sensitive.

    " + "smithy.api#documentation": "

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

    " } }, "com.amazonaws.backup#ProtectedResourcesList": { @@ -9945,7 +9963,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

    ", + "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9987,7 +10005,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Applies Backup Vault Lock to a backup vault, preventing attempts to delete\n any recovery point stored in or created in a backup vault. Vault Lock also prevents\n attempts to update the lifecycle policy that controls the retention period of any recovery\n point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and\n maximum retention period for future backup and copy jobs that target a backup vault.

    \n \n

    Backup Vault Lock has been assessed by Cohasset Associates for use in environments \n that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about \n how Backup Vault Lock relates to these regulations, see the \n Cohasset Associates \n Compliance Assessment.\n

    \n     ", + "smithy.api#documentation": "

    Applies Backup Vault Lock to a backup vault, preventing attempts to delete\n any recovery point stored in or created in a backup vault. Vault Lock also prevents\n attempts to update the lifecycle policy that controls the retention period of any recovery\n point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and\n maximum retention period for future backup and copy jobs that target a backup vault.

    \n \n

    Backup Vault Lock has been assessed by Cohasset Associates for use in environments \n that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about \n how Backup Vault Lock relates to these regulations, see the \n Cohasset Associates \n Compliance Assessment.\n

    \n     \n

    For more information, see Backup Vault Lock.

    ", "smithy.api#http": { "method": "PUT", "uri": "/backup-vaults/{BackupVaultName}/vault-lock", @@ -10010,7 +10028,7 @@ "MinRetentionDays": { "target": "com.amazonaws.backup#Long", "traits": { - "smithy.api#documentation": "

    The Backup Vault Lock configuration that specifies the minimum retention\n period that the vault retains its recovery points. This setting can be useful if, for\n example, your organization's policies require you to retain certain data for at least seven\n years (2555 days).

    \n

    If this parameter is not specified, Vault Lock will not enforce a minimum retention\n period.

    \n

    If this parameter is specified, any backup or copy job to the vault must have a\n lifecycle policy with a retention period equal to or longer than the minimum retention\n period. If the job's retention period is shorter than that minimum retention period, then\n the vault fails that backup or copy job, and you should either modify your lifecycle\n settings or use a different vault. The shortest minimum retention period\n you can specify is 1 day. Recovery points already saved in the vault prior to\n Vault Lock are not affected.

    " + "smithy.api#documentation": "

    The Backup Vault Lock configuration that specifies the minimum retention\n period that the vault retains its recovery points. This setting can be useful if, for\n example, your organization's policies require you to retain certain data for at least seven\n years (2555 days).

    \n

    This parameter is required when a vault lock is created through CloudFormation;\n otherwise, this parameter is optional. If this parameter is not specified, Vault Lock will\n not enforce a minimum retention period.

    \n

    If this parameter is specified, any backup or copy job to the vault must have a\n lifecycle policy with a retention period equal to or longer than the minimum retention\n period. If the job's retention period is shorter than that minimum retention period, then\n the vault fails that backup or copy job, and you should either modify your lifecycle\n settings or use a different vault. The shortest minimum retention period\n you can specify is 1 day. Recovery points already saved in the vault prior to\n Vault Lock are not affected.

    " } }, "MaxRetentionDays": { @@ -10068,7 +10086,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

    ", + "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10083,7 +10101,7 @@ "BackupVaultEvents": { "target": "com.amazonaws.backup#BackupVaultEvents", "traits": { - "smithy.api#documentation": "

    An array of events that indicate the status of jobs to back up resources to the backup\n vault.

    \n

    For common use cases and code samples, see Using Amazon SNS to\n track Backup events.

    \n

    The following events are supported:

    \n
      \n
    • \n

      \n BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED\n

      \n
      • \n
    • \n

      \n COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL |\n COPY_JOB_FAILED\n

      \n
      • \n
    • \n

      \n RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED |\n RECOVERY_POINT_MODIFIED\n

      \n
      • \n
    • \n

      \n S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED\n

      \n
      • \n
    \n \n

    The list below shows items that are deprecated events (for reference) and are no longer \n in use. They are no longer supported and will not return statuses or notifications. \n Refer to the list above for current supported events.

    \n     ", + "smithy.api#documentation": "

    An array of events that indicate the status of jobs to back up resources to the backup\n vault.

    \n

    For common use cases and code samples, see Using Amazon SNS to\n track Backup events.

    \n

    The following events are supported:

    \n
      \n
    • \n

      \n BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED\n

      \n
      • \n
    • \n

      \n COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL |\n COPY_JOB_FAILED\n

      \n
      • \n
    • \n

      \n RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED |\n RECOVERY_POINT_MODIFIED\n

      \n
      • \n
    • \n

      \n S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED\n

      \n
      • \n
    \n \n

    The list below includes both supported events and deprecated events that are no longer\n in use (for reference). Deprecated events do not return statuses or notifications. \n Refer to the list above for the supported events.

    \n     ", "smithy.api#required": {} } } @@ -10141,7 +10159,7 @@ "ValidationStatus": { "target": "com.amazonaws.backup#RestoreValidationStatus", "traits": { - "smithy.api#documentation": "

    This is the status of your restore validation.

    ", + "smithy.api#documentation": "

    The status of your restore validation.

    ", "smithy.api#required": {} } }, @@ -10168,13 +10186,13 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

    " + "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

    " } }, "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    An ARN that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

    " + "smithy.api#documentation": "

    An ARN that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

    " } }, "SourceBackupVaultArn": { @@ -10216,7 +10234,7 @@ "StatusMessage": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    A message explaining the reason of the recovery point deletion failure.

    " + "smithy.api#documentation": "

    A message explaining the current status of the recovery point.

    " } }, "CreationDate": { @@ -10246,7 +10264,7 @@ "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { - "smithy.api#documentation": "

    The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

    \n

    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.

    \n

    Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" \n section of the \n Feature availability by resource table. Backup ignores this expression for\n other resource types.

    " + "smithy.api#documentation": "

    The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

    \n

    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.

    \n

    Resource types that can transition to cold storage are listed in the Feature \n availability by resource table. Backup ignores this expression for\n other resource types.

    " } }, "EncryptionKeyArn": { @@ -10271,13 +10289,13 @@ "ParentRecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    This is the Amazon Resource Name (ARN) of the parent (composite) \n recovery point.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the parent (composite) \n recovery point.

    " } }, "CompositeMemberIdentifier": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the identifier of a resource within a composite group, such as \n nested (child) recovery point belonging to a composite (parent) stack. The \n ID is transferred from \n the \n logical ID within a stack.

    " + "smithy.api#documentation": "

    The identifier of a resource within a composite group, such as \n nested (child) recovery point belonging to a composite (parent) stack. The \n ID is transferred from \n the \n logical ID within a stack.

    " } }, "IsParent": { @@ -10290,13 +10308,13 @@ "ResourceName": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the non-unique name of the resource that \n belongs to the specified backup.

    " + "smithy.api#documentation": "

    The non-unique name of the resource that \n belongs to the specified backup.

    " } }, "VaultType": { "target": "com.amazonaws.backup#VaultType", "traits": { - "smithy.api#documentation": "

    This is the type of vault in which the described recovery point is stored.

    " + "smithy.api#documentation": "

    The type of vault in which the described recovery point is stored.

    " } } }, @@ -10334,7 +10352,7 @@ "StatusMessage": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    A message explaining the reason of the recovery point deletion failure.

    " + "smithy.api#documentation": "

    A message explaining the current status of the recovery point.

    " } }, "EncryptionKeyArn": { @@ -10352,7 +10370,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

    " + "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

    " } }, "IsParent": { @@ -10365,19 +10383,19 @@ "ParentRecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    This is the Amazon Resource Name (ARN) of the parent (composite) \n recovery point.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the parent (composite) \n recovery point.

    " } }, "ResourceName": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    This is the non-unique name of the resource that \n belongs to the specified backup.

    " + "smithy.api#documentation": "

    The non-unique name of the resource that \n belongs to the specified backup.

    " } }, "VaultType": { "target": "com.amazonaws.backup#VaultType", "traits": { - "smithy.api#documentation": "

    This is the type of vault in which the described recovery point is \n stored.

    " + "smithy.api#documentation": "

    The type of vault in which the described recovery point is \n stored.

    " } } }, @@ -10429,25 +10447,25 @@ "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    This is the Amazon Resource Name (ARN) of the parent (composite) \n recovery point.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the parent (composite) \n recovery point.

    " } }, "ResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    This is the Amazon Resource Name (ARN) that uniquely identifies \n a saved resource.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) that uniquely identifies \n a saved resource.

    " } }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

    This is the Amazon Web Services resource type that is saved as \n a recovery point.

    " + "smithy.api#documentation": "

    The Amazon Web Services resource type that is saved as \n a recovery point.

    " } }, "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    This is the name of the backup vault \n (the logical container in which backups are stored).

    " + "smithy.api#documentation": "

    The name of the backup vault \n (the logical container in which backups are stored).

    " } } }, @@ -10535,7 +10553,7 @@ "Formats": { "target": "com.amazonaws.backup#FormatList", "traits": { - "smithy.api#documentation": "

    A list of the format of your reports: CSV, JSON, or both. If\n not specified, the default format is CSV.

    " + "smithy.api#documentation": "

    The format of your reports: CSV, JSON, or both. If\n not specified, the default format is CSV.

    " } } }, @@ -10742,7 +10760,7 @@ "Accounts": { "target": "com.amazonaws.backup#stringList", "traits": { - "smithy.api#documentation": "

    These are the accounts to be included in the report.

    " + "smithy.api#documentation": "

    These are the accounts to be included in the report.

    \n

    Use string value of ROOT to include all organizational units.

    " } }, "OrganizationUnits": { @@ -10754,7 +10772,7 @@ "Regions": { "target": "com.amazonaws.backup#stringList", "traits": { - "smithy.api#documentation": "

    These are the Regions to be included in the report.

    " + "smithy.api#documentation": "

    These are the Regions to be included in the report.

    \n

    Use the wildcard as the string value to include all Regions.

    " } } }, @@ -11088,7 +11106,7 @@ "IamRoleArn": { "target": "com.amazonaws.backup#IAMRoleArn", "traits": { - "smithy.api#documentation": "

    Specifies the IAM role ARN used to create the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

    " + "smithy.api#documentation": "

    The IAM role ARN used to create the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

    " } }, "ExpectedCompletionTimeMinutes": { @@ -11124,7 +11142,7 @@ "ValidationStatus": { "target": "com.amazonaws.backup#RestoreValidationStatus", "traits": { - "smithy.api#documentation": "

    This is the status of validation run on the indicated \n restore job.

    " + "smithy.api#documentation": "

    The status of validation run on the indicated \n restore job.

    " } }, "ValidationStatusMessage": { @@ -11156,7 +11174,7 @@ "RecoveryPointSelection": { "target": "com.amazonaws.backup#RestoreTestingRecoveryPointSelection", "traits": { - "smithy.api#documentation": "

    Required: Algorithm; Required: Recovery point types; IncludeVaults \n (one or more). Optional: SelectionWindowDays ('30' if not specified); \n ExcludeVaults (list of selectors), defaults to empty list if not listed.

    ", + "smithy.api#documentation": "

    \n RecoveryPointSelection has five parameters (three required and two\n optional). The values you specify determine which recovery point is included in the restore\n test. You must indicate with Algorithm if you want the latest recovery point\n within your SelectionWindowDays or if you want a random recovery point, and\n you must indicate through IncludeVaults from which vaults the recovery points\n can be chosen.

    \n

    \n Algorithm (required) Valid values:\n \"LATEST_WITHIN_WINDOW\" or \"RANDOM_WITHIN_WINDOW\".

    \n

    \n Recovery point types (required) Valid values:\n \"SNAPSHOT\" and/or \"CONTINUOUS\". Include SNAPSHOT\n to restore only snapshot recovery points; include CONTINUOUS to restore\n continuous recovery points (point in time restore / PITR); use both to restore either a\n snapshot or a continuous recovery point. The recovery point will be determined by the value\n for Algorithm.

    \n

    \n IncludeVaults (required). You must include one or more\n backup vaults. Use the wildcard [\"*\"] or specific ARNs.

    \n

    \n SelectionWindowDays (optional) Value must be an\n integer (in days) from 1 to 365. If not included, the value defaults to\n 30.

    \n

    \n ExcludeVaults (optional). You can choose to input one\n or more specific backup vault ARNs to exclude those vaults' contents from restore\n eligibility. Or, you can include a list of selectors. If this parameter and its value are\n not included, it defaults to empty list.

    ", "smithy.api#required": {} } }, @@ -11237,7 +11255,7 @@ "RestoreTestingPlanName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

    This is the restore testing plan name.

    ", + "smithy.api#documentation": "

    The restore testing plan name.

    ", "smithy.api#required": {} } }, @@ -11298,7 +11316,7 @@ "RestoreTestingPlanName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

    This is the restore testing plan name.

    ", + "smithy.api#documentation": "

    The restore testing plan name.

    ", "smithy.api#required": {} } }, @@ -11390,7 +11408,7 @@ "RecoveryPointTypes": { "target": "com.amazonaws.backup#RestoreTestingRecoveryPointTypeList", "traits": { - "smithy.api#documentation": "

    These are the types of recovery points.

    " + "smithy.api#documentation": "

    These are the types of recovery points.

    \n

    Include SNAPSHOT\n to restore only snapshot recovery points; include CONTINUOUS to restore\n continuous recovery points (point in time restore / PITR); use both to restore either a\n snapshot or a continuous recovery point. The recovery point will be determined by the value\n for Algorithm.

    " } }, "SelectionWindowDays": { @@ -11402,7 +11420,7 @@ } }, "traits": { - "smithy.api#documentation": "

    Required: Algorithm; Required: Recovery point types; \n IncludeVaults(one or more). Optional: SelectionWindowDays \n ('30' if not specified);ExcludeVaults (list of selectors), \n defaults to empty list if not listed.

    " + "smithy.api#documentation": "

    \n RecoveryPointSelection has five parameters (three required and two\n optional). The values you specify determine which recovery point is included in the restore\n test. You must indicate with Algorithm if you want the latest recovery point\n within your SelectionWindowDays or if you want a random recovery point, and\n you must indicate through IncludeVaults from which vaults the recovery points\n can be chosen.

    \n

    \n Algorithm (required) Valid values:\n \"LATEST_WITHIN_WINDOW\" or \"RANDOM_WITHIN_WINDOW\".

    \n

    \n Recovery point types (required) Valid values:\n \"SNAPSHOT\" and/or \"CONTINUOUS\". Include SNAPSHOT\n to restore only snapshot recovery points; include CONTINUOUS to restore\n continuous recovery points (point in time restore / PITR); use both to restore either a\n snapshot or a continuous recovery point. The recovery point will be determined by the value\n for Algorithm.

    \n

    \n IncludeVaults (required). You must include one or more\n backup vaults. Use the wildcard [\"*\"] or specific ARNs.

    \n

    \n SelectionWindowDays (optional) Value must be an\n integer (in days) from 1 to 365. If not included, the value defaults to\n 30.

    \n

    \n ExcludeVaults (optional). You can choose to input one\n or more specific backup vault ARNs to exclude those vaults' contents from restore\n eligibility. Or, you can include a list of selectors. If this parameter and its value are\n not included, it defaults to empty list.

    " } }, "com.amazonaws.backup#RestoreTestingRecoveryPointSelectionAlgorithm": { @@ -11470,7 +11488,7 @@ "ProtectedResourceType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

    The type of Amazon Web Services resource included in a restore \n testing selection; for \n example, an Amazon EBS volume or \n an Amazon RDS database.

    \n

    Supported resource types accepted include:

    \n
      \n
    • \n

      \n Aurora for Amazon Aurora

      \n
      • \n
    • \n

      \n DocumentDB for Amazon DocumentDB (with MongoDB compatibility)

      \n
      • \n
    • \n

      \n DynamoDB for Amazon DynamoDB

      \n
      • \n
    • \n

      \n EBS for Amazon Elastic Block Store

      \n
      • \n
    • \n

      \n EC2 for Amazon Elastic Compute Cloud

      \n
      • \n
    • \n

      \n EFS for Amazon Elastic File System

      \n
      • \n
    • \n

      \n FSx for Amazon FSx

      \n
      • \n
    • \n

      \n Neptune for Amazon Neptune

      \n
      • \n
    • \n

      \n RDS for Amazon Relational Database Service

      \n
      • \n
    • \n

      \n S3 for Amazon S3

      \n
      • \n
    ", + "smithy.api#documentation": "

    The type of Amazon Web Services resource included in a restore \n testing selection; for example, an Amazon EBS volume or \n an Amazon RDS database.

    \n

    Supported resource types accepted include:

    \n
      \n
    • \n

      \n Aurora for Amazon Aurora

      \n
      • \n
    • \n

      \n DocumentDB for Amazon DocumentDB (with MongoDB compatibility)

      \n
      • \n
    • \n

      \n DynamoDB for Amazon DynamoDB

      \n
      • \n
    • \n

      \n EBS for Amazon Elastic Block Store

      \n
      • \n
    • \n

      \n EC2 for Amazon Elastic Compute Cloud

      \n
      • \n
    • \n

      \n EFS for Amazon Elastic File System

      \n
      • \n
    • \n

      \n FSx for Amazon FSx

      \n
      • \n
    • \n

      \n Neptune for Amazon Neptune

      \n
      • \n
    • \n

      \n RDS for Amazon Relational Database Service

      \n
      • \n
    • \n

      \n S3 for Amazon S3

      \n
      • \n
    ", "smithy.api#required": {} } }, @@ -11483,7 +11501,7 @@ "RestoreTestingSelectionName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

    This is the unique name of the restore testing selection \n that belongs to the related restore testing plan.

    ", + "smithy.api#documentation": "

    The unique name of the restore testing selection \n that belongs to the related restore testing plan.

    ", "smithy.api#required": {} } }, @@ -11557,7 +11575,7 @@ "RestoreTestingSelectionName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

    This is the unique name of the restore testing selection that \n belongs to the related restore testing plan.

    ", + "smithy.api#documentation": "

    The unique name of the restore testing selection that \n belongs to the related restore testing plan.

    ", "smithy.api#required": {} } }, @@ -11579,7 +11597,7 @@ "CreationTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

    This is the date and time that a restore testing selection \n was created, in Unix format and Coordinated Universal Time (UTC). \n The value of CreationTime is accurate to milliseconds. \n For example, the value 1516925490.087 represents Friday, \n January 26,2018 12:11:30.087 AM.

    ", + "smithy.api#documentation": "

    The date and time that a restore testing selection \n was created, in Unix format and Coordinated Universal Time (UTC). \n The value of CreationTime is accurate to milliseconds. \n For example, the value 1516925490.087 represents Friday, \n January 26,2018 12:11:30.087 AM.

    ", "smithy.api#required": {} } }, @@ -11641,7 +11659,7 @@ "ProtectedResourceConditions": { "target": "com.amazonaws.backup#ProtectedResourceConditions", "traits": { - "smithy.api#documentation": "

    A list of conditions that you define for resources in \n your restore testing plan using tags.

    \n

    For example, \n \"StringEquals\": { \"Key\": \"aws:ResourceTag/CreatedByCryo\", \"Value\": \"true\" },. \n Condition operators are case sensitive.

    " + "smithy.api#documentation": "

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

    " } }, "RestoreMetadataOverrides": { @@ -11780,7 +11798,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

    ", + "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

    ", "smithy.api#required": {} } }, @@ -11819,19 +11837,19 @@ "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { - "smithy.api#documentation": "

    The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup will transition and expire backups automatically according\n to the lifecycle that you define.

    \n

    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.

    \n

    Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" \n section of the \n Feature availability by resource table. Backup ignores this expression for\n other resource types.

    \n

    This parameter has a maximum value of 100 years (36,500 days).

    " + "smithy.api#documentation": "

    The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup will transition and expire backups automatically according\n to the lifecycle that you define.

    \n

    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.

    \n

    Resource types that can transition to cold storage are listed in the Feature \n availability by resource table. Backup ignores this expression for\n other resource types.

    \n

    This parameter has a maximum value of 100 years (36,500 days).

    " } }, "RecoveryPointTags": { "target": "com.amazonaws.backup#Tags", "traits": { - "smithy.api#documentation": "

    To help organize your resources, you can assign your own metadata to the resources that\n you create. Each tag is a key-value pair.

    " + "smithy.api#documentation": "

    The tags to assign to the resources.

    " } }, "BackupOptions": { "target": "com.amazonaws.backup#BackupOptions", "traits": { - "smithy.api#documentation": "

    Specifies the backup option for a selected resource. This option is only available for\n Windows Volume Shadow Copy Service (VSS) backup jobs.

    \n

    Valid values: Set to \"WindowsVSS\":\"enabled\" to enable the\n WindowsVSS backup option and create a Windows VSS backup. Set to\n \"WindowsVSS\"\"disabled\" to create a regular backup. The\n WindowsVSS option is not enabled by default.

    " + "smithy.api#documentation": "

    The backup option for a selected resource. This option is only available for\n Windows Volume Shadow Copy Service (VSS) backup jobs.

    \n

    Valid values: Set to \"WindowsVSS\":\"enabled\" to enable the\n WindowsVSS backup option and create a Windows VSS backup. Set to\n \"WindowsVSS\"\"disabled\" to create a regular backup. The\n WindowsVSS option is not enabled by default.

    " } } }, @@ -11923,14 +11941,14 @@ "SourceBackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    The name of a logical source container where backups are stored. Backup vaults are\n 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,\n and hyphens.

    ", + "smithy.api#documentation": "

    The name of a logical source container where backups are stored. Backup vaults are\n identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.

    ", "smithy.api#required": {} } }, "DestinationBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to\n copy to; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

    ", + "smithy.api#documentation": "

    An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to\n copy to; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

    ", "smithy.api#required": {} } }, @@ -12099,7 +12117,7 @@ "Metadata": { "target": "com.amazonaws.backup#Metadata", "traits": { - "smithy.api#documentation": "

    A set of metadata key-value pairs. Contains information, such as a resource name,\n required to restore a recovery point.

    \n

    You can get configuration metadata about a resource at the time it was backed up by\n calling GetRecoveryPointRestoreMetadata. However, values in addition to those\n provided by GetRecoveryPointRestoreMetadata might be required to restore a\n resource. For example, you might need to provide a new resource name if the original\n already exists.

    \n

    You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:

    \n
      \n
    • \n

      \n file-system-id: The ID of the Amazon EFS file system that is\n backed up by Backup. Returned in\n GetRecoveryPointRestoreMetadata.

      \n
      • \n
    • \n

      \n Encrypted: A Boolean value that, if true, specifies that the file\n system is encrypted. If KmsKeyId is specified, Encrypted\n must be set to true.

      \n
      • \n
    • \n

      \n KmsKeyId: Specifies the Amazon Web Services KMS key that is used to\n 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.

      \n
      • \n
    • \n

      \n PerformanceMode: Specifies the throughput mode of the file\n system.

      \n
      • \n
    • \n

      \n CreationToken: A user-supplied value that ensures the uniqueness\n (idempotency) of the request.

      \n
      • \n
    • \n

      \n newFileSystem: A Boolean value that, if true, specifies that the\n recovery point is restored to a new Amazon EFS file system.

      \n
      • \n
    • \n

      \n ItemsToRestore: An array of one to five strings where each string is\n a file path. Use ItemsToRestore to restore specific files or directories\n rather than the entire file system. This parameter is optional. For example,\n \"itemsToRestore\":\"[\\\"/my.test\\\"]\".

      \n
      • \n
    ", + "smithy.api#documentation": "

    A set of metadata key-value pairs.

    \n

    You can get configuration metadata about a resource at the time it was backed up by\n calling GetRecoveryPointRestoreMetadata. However, values in addition to those\n provided by GetRecoveryPointRestoreMetadata might be required to restore a\n resource. For example, you might need to provide a new resource name if the original\n already exists.

    \n

    For more information about the metadata for each resource, see the following:

    \n ", "smithy.api#required": {} } }, @@ -12118,7 +12136,7 @@ "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

    Starts a job to restore a recovery point for one of the following resources:

    \n
      \n
    • \n

      \n Aurora for Amazon Aurora

      \n
      • \n
    • \n

      \n DocumentDB for Amazon DocumentDB (with MongoDB compatibility)

      \n
      • \n
    • \n

      \n CloudFormation for CloudFormation

      \n
      • \n
    • \n

      \n DynamoDB for Amazon DynamoDB

      \n
      • \n
    • \n

      \n EBS for Amazon Elastic Block Store

      \n
      • \n
    • \n

      \n EC2 for Amazon Elastic Compute Cloud

      \n
      • \n
    • \n

      \n EFS for Amazon Elastic File System

      \n
      • \n
    • \n

      \n FSx for Amazon FSx

      \n
      • \n
    • \n

      \n Neptune for Amazon Neptune

      \n
      • \n
    • \n

      \n RDS for Amazon Relational Database Service

      \n
      • \n
    • \n

      \n Redshift for Amazon Redshift

      \n
      • \n
    • \n

      \n Storage Gateway for Storage Gateway

      \n
      • \n
    • \n

      \n S3 for Amazon S3

      \n
      • \n
    • \n

      \n Timestream for Amazon Timestream

      \n
      • \n
    • \n

      \n VirtualMachine for virtual machines

      \n
      • \n
    " + "smithy.api#documentation": "

    Starts a job to restore a recovery point for one of the following resources:

    \n
      \n
    • \n

      \n Aurora - Amazon Aurora

      \n
      • \n
    • \n

      \n DocumentDB - Amazon DocumentDB

      \n
      • \n
    • \n

      \n CloudFormation - CloudFormation

      \n
      • \n
    • \n

      \n DynamoDB - Amazon DynamoDB

      \n
      • \n
    • \n

      \n EBS - Amazon Elastic Block Store

      \n
      • \n
    • \n

      \n EC2 - Amazon Elastic Compute Cloud

      \n
      • \n
    • \n

      \n EFS - Amazon Elastic File System

      \n
      • \n
    • \n

      \n FSx - Amazon FSx

      \n
      • \n
    • \n

      \n Neptune - Amazon Neptune

      \n
      • \n
    • \n

      \n RDS - Amazon Relational Database Service

      \n
      • \n
    • \n

      \n Redshift - Amazon Redshift

      \n
      • \n
    • \n

      \n Storage Gateway - Storage Gateway

      \n
      • \n
    • \n

      \n S3 - Amazon Simple Storage Service

      \n
      • \n
    • \n

      \n Timestream - Amazon Timestream

      \n
      • \n
    • \n

      \n VirtualMachine - Virtual machines

      \n
      • \n
    " } }, "CopySourceTagsToRestoredResource": { @@ -12173,7 +12191,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Attempts to cancel a job to create a one-time backup of a resource.

    \n

    This action is not supported for the following services:\n Amazon FSx for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp ONTAP\n , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, \n and Amazon Neptune.

    ", + "smithy.api#documentation": "

    Attempts to cancel a job to create a one-time backup of a resource.

    \n

    This action is not supported for the following services:\n Amazon FSx for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp ONTAP,\n Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, \n and Amazon Neptune.

    ", "smithy.api#http": { "method": "POST", "uri": "/backup-jobs/{BackupJobId}", @@ -12258,7 +12276,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault\n identified by an Amazon Resource Name (ARN).

    ", + "smithy.api#documentation": "

    Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault\n identified by an Amazon Resource Name (ARN).

    \n

    This API is supported for recovery points for resource types \n including Aurora, Amazon DocumentDB. Amazon EBS, \n Amazon FSx, Neptune, and Amazon RDS.

    ", "smithy.api#http": { "method": "POST", "uri": "/tags/{ResourceArn}", @@ -12273,7 +12291,7 @@ "ResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    An ARN that uniquely identifies a resource. The format of the ARN depends on the type of\n the tagged resource.

    ", + "smithy.api#documentation": "

    An ARN that uniquely identifies a resource. The format of the ARN depends on the type of\n the tagged resource.

    \n

    ARNs that do not include backup are incompatible with tagging. \n TagResource and UntagResource with invalid ARNs will \n result in an error. Acceptable ARN content can include \n arn:aws:backup:us-east. Invalid ARN content may look like \n arn:aws:ec2:us-east.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12331,7 +12349,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Removes a set of key-value pairs from a recovery point, backup plan, or backup vault\n identified by an Amazon Resource Name (ARN)

    ", + "smithy.api#documentation": "

    Removes a set of key-value pairs from a recovery point, backup plan, or backup vault\n identified by an Amazon Resource Name (ARN)

    \n

    This API is not supported for recovery points for resource types \n including Aurora, Amazon DocumentDB. Amazon EBS, \n Amazon FSx, Neptune, and Amazon RDS.

    ", "smithy.api#http": { "method": "POST", "uri": "/untag/{ResourceArn}", @@ -12346,7 +12364,7 @@ "ResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    An ARN that uniquely identifies a resource. The format of the ARN depends on the type of\n the tagged resource.

    ", + "smithy.api#documentation": "

    An ARN that uniquely identifies a resource. The format of the ARN depends on the type of\n the tagged resource.

    \n

    ARNs that do not include backup are incompatible with tagging. \n TagResource and UntagResource with invalid ARNs will \n result in an error. Acceptable ARN content can include \n arn:aws:backup:us-east. Invalid ARN content may look like \n arn:aws:ec2:us-east.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12354,7 +12372,7 @@ "TagKeyList": { "target": "com.amazonaws.backup#TagKeyList", "traits": { - "smithy.api#documentation": "

    A list of keys to identify which key-value tags to remove from a resource.

    ", + "smithy.api#documentation": "

    The keys to identify which key-value tags to remove from a resource.

    ", "smithy.api#required": {} } } @@ -12386,7 +12404,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Updates an existing backup plan identified by its backupPlanId with the\n input document in JSON format. The new version is uniquely identified by a\n VersionId.

    ", + "smithy.api#documentation": "

    Updates the specified backup plan. The new version is uniquely identified by its ID.

    ", "smithy.api#http": { "method": "POST", "uri": "/backup/plans/{BackupPlanId}", @@ -12401,7 +12419,7 @@ "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

    Uniquely identifies a backup plan.

    ", + "smithy.api#documentation": "

    The ID of the backup plan.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12409,7 +12427,7 @@ "BackupPlan": { "target": "com.amazonaws.backup#BackupPlanInput", "traits": { - "smithy.api#documentation": "

    Specifies the body of a backup plan. Includes a BackupPlanName and one or\n more sets of Rules.

    ", + "smithy.api#documentation": "

    The body of a backup plan. Includes a BackupPlanName and one or\n more sets of Rules.

    ", "smithy.api#required": {} } } @@ -12488,7 +12506,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Updates an existing framework identified by its FrameworkName with the\n input document in JSON format.

    ", + "smithy.api#documentation": "

    Updates the specified framework.

    ", "smithy.api#http": { "method": "PUT", "uri": "/audit/frameworks/{FrameworkName}", @@ -12517,7 +12535,7 @@ "FrameworkControls": { "target": "com.amazonaws.backup#FrameworkControls", "traits": { - "smithy.api#documentation": "

    A list of the controls that make up the framework. Each control in the list has a name,\n input parameters, and scope.

    " + "smithy.api#documentation": "

    The controls that make up the framework. Each control in the list has a name,\n input parameters, and scope.

    " } }, "IdempotencyToken": { @@ -12629,7 +12647,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Sets the transition lifecycle of a recovery point.

    \n

    The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

    \n

    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.

    \n

    Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" \n section of the \n Feature availability by resource table. Backup ignores this expression for\n other resource types.

    \n

    This operation does not support continuous backups.

    ", + "smithy.api#documentation": "

    Sets the transition lifecycle of a recovery point.

    \n

    The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

    \n

    Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for\n other resource types.

    \n

    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.

    \n \n

    If your lifecycle currently uses the parameters DeleteAfterDays and \n MoveToColdStorageAfterDays, include these parameters and their values when you call \n this operation. Not including them may result in your plan updating with null values.

    \n     \n

    This operation does not support continuous backups.

    ", "smithy.api#http": { "method": "POST", "uri": "/backup-vaults/{BackupVaultName}/recovery-points/{RecoveryPointArn}", @@ -12644,7 +12662,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

    ", + "smithy.api#documentation": "

    The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12674,7 +12692,7 @@ "BackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

    An ARN that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

    " + "smithy.api#documentation": "

    An ARN that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

    " } }, "RecoveryPointArn": { @@ -12686,7 +12704,7 @@ "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { - "smithy.api#documentation": "

    The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

    \n

    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.

    \n

    Resource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" \n section of the \n Feature availability by resource table. Backup ignores this expression for\n other resource types.

    " + "smithy.api#documentation": "

    The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

    \n

    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.

    \n

    Resource types that can transition to cold storage are listed in the Feature availability \n by resource table. Backup ignores this expression for other resource types.

    " } }, "CalculatedLifecycle": { @@ -12774,7 +12792,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Updates an existing report plan identified by its ReportPlanName with the\n input document in JSON format.

    ", + "smithy.api#documentation": "

    Updates the specified report plan.

    ", "smithy.api#http": { "method": "PUT", "uri": "/audit/report-plans/{ReportPlanName}", @@ -12803,13 +12821,13 @@ "ReportDeliveryChannel": { "target": "com.amazonaws.backup#ReportDeliveryChannel", "traits": { - "smithy.api#documentation": "

    A structure that contains information about where to deliver your reports, specifically\n your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

    " + "smithy.api#documentation": "

    The information about where to deliver your reports, specifically\n your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

    " } }, "ReportSetting": { "target": "com.amazonaws.backup#ReportSetting", "traits": { - "smithy.api#documentation": "

    Identifies the report template for the report. Reports are built using a report\n template. The report templates are:

    \n

    \n RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT |\n COPY_JOB_REPORT | RESTORE_JOB_REPORT\n

    \n

    If the report template is RESOURCE_COMPLIANCE_REPORT or\n CONTROL_COMPLIANCE_REPORT, this API resource also describes the report\n coverage by Amazon Web Services Regions and frameworks.

    " + "smithy.api#documentation": "

    The report template for the report. Reports are built using a report\n template. The report templates are:

    \n

    \n RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT |\n COPY_JOB_REPORT | RESTORE_JOB_REPORT\n

    \n

    If the report template is RESOURCE_COMPLIANCE_REPORT or\n CONTROL_COMPLIANCE_REPORT, this API resource also describes the report\n coverage by Amazon Web Services Regions and frameworks.

    " } }, "IdempotencyToken": { @@ -12898,7 +12916,7 @@ "RestoreTestingPlanName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

    This is the restore testing plan name you wish to update.

    ", + "smithy.api#documentation": "

    The name of the restore testing plan name.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12914,7 +12932,7 @@ "CreationTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

    This is the time the resource testing plan was \n created.

    ", + "smithy.api#documentation": "

    The time the resource testing plan was \n created.

    ", "smithy.api#required": {} } }, @@ -12935,7 +12953,7 @@ "UpdateTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

    This is the time the update completed for the restore \n testing plan.

    ", + "smithy.api#documentation": "

    The time the update completed for the restore \n testing plan.

    ", "smithy.api#required": {} } } @@ -12970,7 +12988,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Most elements except the RestoreTestingSelectionName \n can be updated with this request.

    \n

    \n RestoreTestingSelection can use either protected \n resource ARNs or conditions, but not both. That is, if your selection \n has ProtectedResourceArns, requesting an update with the \n parameter ProtectedResourceConditions will be \n unsuccessful.

    ", + "smithy.api#documentation": "

    Updates the specified restore testing selection.

    \n

    Most elements except the RestoreTestingSelectionName \n can be updated with this request.

    \n

    You can use either protected resource ARNs or conditions, but not both.

    ", "smithy.api#http": { "method": "PUT", "uri": "/restore-testing/plans/{RestoreTestingPlanName}/selections/{RestoreTestingSelectionName}", @@ -13000,7 +13018,7 @@ "RestoreTestingSelectionName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

    This is the required restore testing selection name of the restore \n testing selection you wish to update.

    ", + "smithy.api#documentation": "

    The required restore testing selection name of the restore \n testing selection you wish to update.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -13016,7 +13034,7 @@ "CreationTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

    This is the time the resource testing selection was \n updated successfully.

    ", + "smithy.api#documentation": "

    The time the resource testing selection was \n updated successfully.

    ", "smithy.api#required": {} } }, @@ -13030,21 +13048,21 @@ "RestoreTestingPlanName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

    This is the restore testing plan with which the updated restore \n testing selection is associated.

    ", + "smithy.api#documentation": "

    The restore testing plan with which the updated restore \n testing selection is associated.

    ", "smithy.api#required": {} } }, "RestoreTestingSelectionName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

    This is the returned restore testing selection name.

    ", + "smithy.api#documentation": "

    The returned restore testing selection name.

    ", "smithy.api#required": {} } }, "UpdateTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

    This is the time the update completed for the restore \n testing selection.

    ", + "smithy.api#documentation": "

    The time the update completed for the restore \n testing selection.

    ", "smithy.api#required": {} } }