Skip to content

Commit

Permalink
feat(client-backup): The latest update introduces two new attributes,…
Browse files Browse the repository at this point in the history
… 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.
  • Loading branch information
awstools committed Aug 30, 2024
1 parent fd2bbc5 commit abd2514
Show file tree
Hide file tree
Showing 22 changed files with 891 additions and 855 deletions.
4 changes: 2 additions & 2 deletions clients/client-backup/src/commands/CancelLegalHoldCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ export interface CancelLegalHoldCommandInput extends CancelLegalHoldInput {}
export interface CancelLegalHoldCommandOutput extends CancelLegalHoldOutput, __MetadataBearer {}

/**
* <p>This action removes the specified legal hold on a recovery point.
* This action can only be performed by a user with sufficient permissions.</p>
* <p>Removes the specified legal hold on a recovery point. This action can only be performed
* by a user with sufficient permissions.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
8 changes: 4 additions & 4 deletions clients/client-backup/src/commands/CreateLegalHoldCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@ export interface CreateLegalHoldCommandInput extends CreateLegalHoldInput {}
export interface CreateLegalHoldCommandOutput extends CreateLegalHoldOutput, __MetadataBearer {}

/**
* <p>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.</p>
* <p>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.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export interface CreateLogicallyAirGappedBackupVaultCommandOutput
__MetadataBearer {}

/**
* <p>This request creates a logical container to where backups may be copied.</p>
* <p>Creates a logical container to where backups may be copied.</p>
* <p>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.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,10 @@ export interface CreateRestoreTestingPlanCommandInput extends CreateRestoreTesti
export interface CreateRestoreTestingPlanCommandOutput extends CreateRestoreTestingPlanOutput, __MetadataBearer {}

/**
* <p>This is the first of two steps to create a restore testing
* plan; once this request is successful, finish the procedure with
* request CreateRestoreTestingSelection.</p>
* <p>You must include the parameter RestoreTestingPlan. You may
* optionally include CreatorRequestId and Tags.</p>
* <p>Creates a restore testing plan.</p>
* <p>The first of two steps to create a restore testing
* plan. After this request is successful, finish the procedure using
* CreateRestoreTestingSelection.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,7 @@ export interface ListBackupPlanTemplatesCommandInput extends ListBackupPlanTempl
export interface ListBackupPlanTemplatesCommandOutput extends ListBackupPlanTemplatesOutput, __MetadataBearer {}

/**
* <p>Returns metadata of your saved backup plan templates, including the template ID, name,
* and the creation and deletion dates.</p>
* <p>Lists the backup plan templates.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
4 changes: 1 addition & 3 deletions clients/client-backup/src/commands/ListBackupPlansCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,7 @@ export interface ListBackupPlansCommandInput extends ListBackupPlansInput {}
export interface ListBackupPlansCommandOutput extends ListBackupPlansOutput, __MetadataBearer {}

/**
* <p>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.</p>
* <p>Lists the active backup plans for the account.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
2 changes: 2 additions & 0 deletions clients/client-backup/src/commands/ListBackupVaultsCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ export interface ListRecoveryPointsByResourceCommandOutput
__MetadataBearer {}

/**
* <p>Returns detailed information about all the recovery points of the type specified by a
* <p>The information about the recovery points of the type specified by a
* resource Amazon Resource Name (ARN).</p>
* <note>
* <p>For Amazon EFS and Amazon EC2, this action only lists recovery points
Expand Down
6 changes: 1 addition & 5 deletions clients/client-backup/src/commands/ListTagsCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,8 @@ export interface ListTagsCommandInput extends ListTagsInput {}
export interface ListTagsCommandOutput extends ListTagsOutput, __MetadataBearer {}

/**
* <p>Returns a list of key-value pairs assigned to a target recovery point, backup plan, or
* <p>Returns the tags assigned to the resource, such as a target recovery point, backup plan, or
* backup vault.</p>
* <p>
* <code>ListTags</code> 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 <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource"> Feature
* availability by resource</a> table.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,11 @@ export interface PutBackupVaultLockConfigurationCommandOutput extends __Metadata
* <p>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
* <a href="samples/cohassetreport.zip">Cohasset Associates
* <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/samples/cohassetreport.zip">Cohasset Associates
* Compliance Assessment.</a>
* </p>
* </note>
* <p>For more information, see <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html">Backup Vault Lock</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
4 changes: 2 additions & 2 deletions clients/client-backup/src/commands/StopBackupJobCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ export interface StopBackupJobCommandOutput extends __MetadataBearer {}
/**
* <p>Attempts to cancel a job to create a one-time backup of a resource.</p>
* <p>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.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
3 changes: 3 additions & 0 deletions clients/client-backup/src/commands/TagResourceCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ export interface TagResourceCommandOutput extends __MetadataBearer {}
/**
* <p>Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault
* identified by an Amazon Resource Name (ARN).</p>
* <p>This API is supported for recovery points for resource types
* including Aurora, Amazon DocumentDB. Amazon EBS,
* Amazon FSx, Neptune, and Amazon RDS.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
3 changes: 3 additions & 0 deletions clients/client-backup/src/commands/UntagResourceCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {}
/**
* <p>Removes a set of key-value pairs from a recovery point, backup plan, or backup vault
* identified by an Amazon Resource Name (ARN)</p>
* <p>This API is not supported for recovery points for resource types
* including Aurora, Amazon DocumentDB. Amazon EBS,
* Amazon FSx, Neptune, and Amazon RDS.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,7 @@ export interface UpdateBackupPlanCommandInput extends UpdateBackupPlanInput {}
export interface UpdateBackupPlanCommandOutput extends UpdateBackupPlanOutput, __MetadataBearer {}

/**
* <p>Updates an existing backup plan identified by its <code>backupPlanId</code> with the
* input document in JSON format. The new version is uniquely identified by a
* <code>VersionId</code>.</p>
* <p>Updates the specified backup plan. The new version is uniquely identified by its ID.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
3 changes: 1 addition & 2 deletions clients/client-backup/src/commands/UpdateFrameworkCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,7 @@ export interface UpdateFrameworkCommandInput extends UpdateFrameworkInput {}
export interface UpdateFrameworkCommandOutput extends UpdateFrameworkOutput, __MetadataBearer {}

/**
* <p>Updates an existing framework identified by its <code>FrameworkName</code> with the
* input document in JSON format.</p>
* <p>Updates the specified framework.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,17 @@ export interface UpdateRecoveryPointLifecycleCommandOutput
* <p>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.</p>
* <p>Resource types that can transition to cold storage are listed in the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource">Feature availability by resource</a> table. Backup ignores this expression for
* other resource types.</p>
* <p>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.</p>
* <p>Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage"
* section of the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource">
* Feature availability by resource</a> table. Backup ignores this expression for
* other resource types.</p>
* <important>
* <p>If your lifecycle currently uses the parameters <code>DeleteAfterDays</code> and
* <code>MoveToColdStorageAfterDays</code>, include these parameters and their values when you call
* this operation. Not including them may result in your plan updating with null values.</p>
* </important>
* <p>This operation does not support continuous backups.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,7 @@ export interface UpdateReportPlanCommandInput extends UpdateReportPlanInput {}
export interface UpdateReportPlanCommandOutput extends UpdateReportPlanOutput, __MetadataBearer {}

/**
* <p>Updates an existing report plan identified by its <code>ReportPlanName</code> with the
* input document in JSON format.</p>
* <p>Updates the specified report plan.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,10 @@ export interface UpdateRestoreTestingSelectionCommandOutput
__MetadataBearer {}

/**
* <p>Most elements except the <code>RestoreTestingSelectionName</code>
* <p>Updates the specified restore testing selection.</p>
* <p>Most elements except the <code>RestoreTestingSelectionName</code>
* can be updated with this request.</p>
* <p>
* <code>RestoreTestingSelection</code> can use either protected
* resource ARNs or conditions, but not both. That is, if your selection
* has <code>ProtectedResourceArns</code>, requesting an update with the
* parameter <code>ProtectedResourceConditions</code> will be
* unsuccessful.</p>
* <p>You can use either protected resource ARNs or conditions, but not both.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Loading

0 comments on commit abd2514

Please sign in to comment.