Skip to content

Commit

Permalink
feat(client-backup): Add Support for Backup Indexing
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Dec 17, 2024
1 parent a4d166e commit e03d20d
Show file tree
Hide file tree
Showing 21 changed files with 1,816 additions and 4 deletions.
24 changes: 24 additions & 0 deletions clients/client-backup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -543,6 +543,14 @@ GetLegalHold

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/backup/command/GetLegalHoldCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-backup/Interface/GetLegalHoldCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-backup/Interface/GetLegalHoldCommandOutput/)

</details>
<details>
<summary>
GetRecoveryPointIndexDetails
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/backup/command/GetRecoveryPointIndexDetailsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-backup/Interface/GetRecoveryPointIndexDetailsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-backup/Interface/GetRecoveryPointIndexDetailsCommandOutput/)

</details>
<details>
<summary>
Expand Down Expand Up @@ -671,6 +679,14 @@ ListFrameworks

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/backup/command/ListFrameworksCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-backup/Interface/ListFrameworksCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-backup/Interface/ListFrameworksCommandOutput/)

</details>
<details>
<summary>
ListIndexedRecoveryPoints
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/backup/command/ListIndexedRecoveryPointsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-backup/Interface/ListIndexedRecoveryPointsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-backup/Interface/ListIndexedRecoveryPointsCommandOutput/)

</details>
<details>
<summary>
Expand Down Expand Up @@ -895,6 +911,14 @@ UpdateGlobalSettings

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/backup/command/UpdateGlobalSettingsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-backup/Interface/UpdateGlobalSettingsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-backup/Interface/UpdateGlobalSettingsCommandOutput/)

</details>
<details>
<summary>
UpdateRecoveryPointIndexSettings
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/backup/command/UpdateRecoveryPointIndexSettingsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-backup/Interface/UpdateRecoveryPointIndexSettingsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-backup/Interface/UpdateRecoveryPointIndexSettingsCommandOutput/)

</details>
<details>
<summary>
Expand Down
70 changes: 70 additions & 0 deletions clients/client-backup/src/Backup.ts
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,11 @@ import {
GetLegalHoldCommandInput,
GetLegalHoldCommandOutput,
} from "./commands/GetLegalHoldCommand";
import {
GetRecoveryPointIndexDetailsCommand,
GetRecoveryPointIndexDetailsCommandInput,
GetRecoveryPointIndexDetailsCommandOutput,
} from "./commands/GetRecoveryPointIndexDetailsCommand";
import {
GetRecoveryPointRestoreMetadataCommand,
GetRecoveryPointRestoreMetadataCommandInput,
Expand Down Expand Up @@ -293,6 +298,11 @@ import {
ListFrameworksCommandInput,
ListFrameworksCommandOutput,
} from "./commands/ListFrameworksCommand";
import {
ListIndexedRecoveryPointsCommand,
ListIndexedRecoveryPointsCommandInput,
ListIndexedRecoveryPointsCommandOutput,
} from "./commands/ListIndexedRecoveryPointsCommand";
import {
ListLegalHoldsCommand,
ListLegalHoldsCommandInput,
Expand Down Expand Up @@ -425,6 +435,11 @@ import {
UpdateGlobalSettingsCommandInput,
UpdateGlobalSettingsCommandOutput,
} from "./commands/UpdateGlobalSettingsCommand";
import {
UpdateRecoveryPointIndexSettingsCommand,
UpdateRecoveryPointIndexSettingsCommandInput,
UpdateRecoveryPointIndexSettingsCommandOutput,
} from "./commands/UpdateRecoveryPointIndexSettingsCommand";
import {
UpdateRecoveryPointLifecycleCommand,
UpdateRecoveryPointLifecycleCommandInput,
Expand Down Expand Up @@ -494,6 +509,7 @@ const commands = {
GetBackupVaultAccessPolicyCommand,
GetBackupVaultNotificationsCommand,
GetLegalHoldCommand,
GetRecoveryPointIndexDetailsCommand,
GetRecoveryPointRestoreMetadataCommand,
GetRestoreJobMetadataCommand,
GetRestoreTestingInferredMetadataCommand,
Expand All @@ -510,6 +526,7 @@ const commands = {
ListCopyJobsCommand,
ListCopyJobSummariesCommand,
ListFrameworksCommand,
ListIndexedRecoveryPointsCommand,
ListLegalHoldsCommand,
ListProtectedResourcesCommand,
ListProtectedResourcesByBackupVaultCommand,
Expand Down Expand Up @@ -538,6 +555,7 @@ const commands = {
UpdateBackupPlanCommand,
UpdateFrameworkCommand,
UpdateGlobalSettingsCommand,
UpdateRecoveryPointIndexSettingsCommand,
UpdateRecoveryPointLifecycleCommand,
UpdateRegionSettingsCommand,
UpdateReportPlanCommand,
Expand Down Expand Up @@ -1235,6 +1253,23 @@ export interface Backup {
cb: (err: any, data?: GetLegalHoldCommandOutput) => void
): void;

/**
* @see {@link GetRecoveryPointIndexDetailsCommand}
*/
getRecoveryPointIndexDetails(
args: GetRecoveryPointIndexDetailsCommandInput,
options?: __HttpHandlerOptions
): Promise<GetRecoveryPointIndexDetailsCommandOutput>;
getRecoveryPointIndexDetails(
args: GetRecoveryPointIndexDetailsCommandInput,
cb: (err: any, data?: GetRecoveryPointIndexDetailsCommandOutput) => void
): void;
getRecoveryPointIndexDetails(
args: GetRecoveryPointIndexDetailsCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: GetRecoveryPointIndexDetailsCommandOutput) => void
): void;

/**
* @see {@link GetRecoveryPointRestoreMetadataCommand}
*/
Expand Down Expand Up @@ -1501,6 +1536,24 @@ export interface Backup {
cb: (err: any, data?: ListFrameworksCommandOutput) => void
): void;

/**
* @see {@link ListIndexedRecoveryPointsCommand}
*/
listIndexedRecoveryPoints(): Promise<ListIndexedRecoveryPointsCommandOutput>;
listIndexedRecoveryPoints(
args: ListIndexedRecoveryPointsCommandInput,
options?: __HttpHandlerOptions
): Promise<ListIndexedRecoveryPointsCommandOutput>;
listIndexedRecoveryPoints(
args: ListIndexedRecoveryPointsCommandInput,
cb: (err: any, data?: ListIndexedRecoveryPointsCommandOutput) => void
): void;
listIndexedRecoveryPoints(
args: ListIndexedRecoveryPointsCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: ListIndexedRecoveryPointsCommandOutput) => void
): void;

/**
* @see {@link ListLegalHoldsCommand}
*/
Expand Down Expand Up @@ -1931,6 +1984,23 @@ export interface Backup {
cb: (err: any, data?: UpdateGlobalSettingsCommandOutput) => void
): void;

/**
* @see {@link UpdateRecoveryPointIndexSettingsCommand}
*/
updateRecoveryPointIndexSettings(
args: UpdateRecoveryPointIndexSettingsCommandInput,
options?: __HttpHandlerOptions
): Promise<UpdateRecoveryPointIndexSettingsCommandOutput>;
updateRecoveryPointIndexSettings(
args: UpdateRecoveryPointIndexSettingsCommandInput,
cb: (err: any, data?: UpdateRecoveryPointIndexSettingsCommandOutput) => void
): void;
updateRecoveryPointIndexSettings(
args: UpdateRecoveryPointIndexSettingsCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: UpdateRecoveryPointIndexSettingsCommandOutput) => void
): void;

/**
* @see {@link UpdateRecoveryPointLifecycleCommand}
*/
Expand Down
18 changes: 18 additions & 0 deletions clients/client-backup/src/BackupClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,10 @@ import {
GetBackupVaultNotificationsCommandOutput,
} from "./commands/GetBackupVaultNotificationsCommand";
import { GetLegalHoldCommandInput, GetLegalHoldCommandOutput } from "./commands/GetLegalHoldCommand";
import {
GetRecoveryPointIndexDetailsCommandInput,
GetRecoveryPointIndexDetailsCommandOutput,
} from "./commands/GetRecoveryPointIndexDetailsCommand";
import {
GetRecoveryPointRestoreMetadataCommandInput,
GetRecoveryPointRestoreMetadataCommandOutput,
Expand Down Expand Up @@ -213,6 +217,10 @@ import {
ListCopyJobSummariesCommandOutput,
} from "./commands/ListCopyJobSummariesCommand";
import { ListFrameworksCommandInput, ListFrameworksCommandOutput } from "./commands/ListFrameworksCommand";
import {
ListIndexedRecoveryPointsCommandInput,
ListIndexedRecoveryPointsCommandOutput,
} from "./commands/ListIndexedRecoveryPointsCommand";
import { ListLegalHoldsCommandInput, ListLegalHoldsCommandOutput } from "./commands/ListLegalHoldsCommand";
import {
ListProtectedResourcesByBackupVaultCommandInput,
Expand Down Expand Up @@ -283,6 +291,10 @@ import {
UpdateGlobalSettingsCommandInput,
UpdateGlobalSettingsCommandOutput,
} from "./commands/UpdateGlobalSettingsCommand";
import {
UpdateRecoveryPointIndexSettingsCommandInput,
UpdateRecoveryPointIndexSettingsCommandOutput,
} from "./commands/UpdateRecoveryPointIndexSettingsCommand";
import {
UpdateRecoveryPointLifecycleCommandInput,
UpdateRecoveryPointLifecycleCommandOutput,
Expand Down Expand Up @@ -357,6 +369,7 @@ export type ServiceInputTypes =
| GetBackupVaultAccessPolicyCommandInput
| GetBackupVaultNotificationsCommandInput
| GetLegalHoldCommandInput
| GetRecoveryPointIndexDetailsCommandInput
| GetRecoveryPointRestoreMetadataCommandInput
| GetRestoreJobMetadataCommandInput
| GetRestoreTestingInferredMetadataCommandInput
Expand All @@ -373,6 +386,7 @@ export type ServiceInputTypes =
| ListCopyJobSummariesCommandInput
| ListCopyJobsCommandInput
| ListFrameworksCommandInput
| ListIndexedRecoveryPointsCommandInput
| ListLegalHoldsCommandInput
| ListProtectedResourcesByBackupVaultCommandInput
| ListProtectedResourcesCommandInput
Expand Down Expand Up @@ -401,6 +415,7 @@ export type ServiceInputTypes =
| UpdateBackupPlanCommandInput
| UpdateFrameworkCommandInput
| UpdateGlobalSettingsCommandInput
| UpdateRecoveryPointIndexSettingsCommandInput
| UpdateRecoveryPointLifecycleCommandInput
| UpdateRegionSettingsCommandInput
| UpdateReportPlanCommandInput
Expand Down Expand Up @@ -453,6 +468,7 @@ export type ServiceOutputTypes =
| GetBackupVaultAccessPolicyCommandOutput
| GetBackupVaultNotificationsCommandOutput
| GetLegalHoldCommandOutput
| GetRecoveryPointIndexDetailsCommandOutput
| GetRecoveryPointRestoreMetadataCommandOutput
| GetRestoreJobMetadataCommandOutput
| GetRestoreTestingInferredMetadataCommandOutput
Expand All @@ -469,6 +485,7 @@ export type ServiceOutputTypes =
| ListCopyJobSummariesCommandOutput
| ListCopyJobsCommandOutput
| ListFrameworksCommandOutput
| ListIndexedRecoveryPointsCommandOutput
| ListLegalHoldsCommandOutput
| ListProtectedResourcesByBackupVaultCommandOutput
| ListProtectedResourcesCommandOutput
Expand Down Expand Up @@ -497,6 +514,7 @@ export type ServiceOutputTypes =
| UpdateBackupPlanCommandOutput
| UpdateFrameworkCommandOutput
| UpdateGlobalSettingsCommandOutput
| UpdateRecoveryPointIndexSettingsCommandOutput
| UpdateRecoveryPointLifecycleCommandOutput
| UpdateRegionSettingsCommandOutput
| UpdateReportPlanCommandOutput
Expand Down
7 changes: 7 additions & 0 deletions clients/client-backup/src/commands/CreateBackupPlanCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,13 @@ export interface CreateBackupPlanCommandOutput extends CreateBackupPlanOutput, _
* ],
* EnableContinuousBackup: true || false,
* ScheduleExpressionTimezone: "STRING_VALUE",
* IndexActions: [ // IndexActions
* { // IndexAction
* ResourceTypes: [ // ResourceTypes
* "STRING_VALUE",
* ],
* },
* ],
* },
* ],
* AdvancedBackupSettings: [ // AdvancedBackupSettings
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ export interface DescribeRecoveryPointCommandOutput extends DescribeRecoveryPoin
* // IsParent: true || false,
* // ResourceName: "STRING_VALUE",
* // VaultType: "BACKUP_VAULT" || "LOGICALLY_AIR_GAPPED_BACKUP_VAULT",
* // IndexStatus: "PENDING" || "ACTIVE" || "FAILED" || "DELETING",
* // IndexStatusMessage: "STRING_VALUE",
* // };
*
* ```
Expand Down
7 changes: 7 additions & 0 deletions clients/client-backup/src/commands/GetBackupPlanCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,13 @@ export interface GetBackupPlanCommandOutput extends GetBackupPlanOutput, __Metad
* // ],
* // EnableContinuousBackup: true || false,
* // ScheduleExpressionTimezone: "STRING_VALUE",
* // IndexActions: [ // IndexActions
* // { // IndexAction
* // ResourceTypes: [ // ResourceTypes
* // "STRING_VALUE",
* // ],
* // },
* // ],
* // },
* // ],
* // AdvancedBackupSettings: [ // AdvancedBackupSettings
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,13 @@ export interface GetBackupPlanFromJSONCommandOutput extends GetBackupPlanFromJSO
* // ],
* // EnableContinuousBackup: true || false,
* // ScheduleExpressionTimezone: "STRING_VALUE",
* // IndexActions: [ // IndexActions
* // { // IndexAction
* // ResourceTypes: [ // ResourceTypes
* // "STRING_VALUE",
* // ],
* // },
* // ],
* // },
* // ],
* // AdvancedBackupSettings: [ // AdvancedBackupSettings
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,13 @@ export interface GetBackupPlanFromTemplateCommandOutput extends GetBackupPlanFro
* // ],
* // EnableContinuousBackup: true || false,
* // ScheduleExpressionTimezone: "STRING_VALUE",
* // IndexActions: [ // IndexActions
* // { // IndexAction
* // ResourceTypes: [ // ResourceTypes
* // "STRING_VALUE",
* // ],
* // },
* // ],
* // },
* // ],
* // AdvancedBackupSettings: [ // AdvancedBackupSettings
Expand Down
Loading

0 comments on commit e03d20d

Please sign in to comment.