@aws-sdk/client-backup 3.713.0 → 3.716.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -0
- package/dist-cjs/index.js +206 -4
- package/dist-cjs/runtimeConfig.js +8 -6
- package/dist-es/Backup.js +6 -0
- package/dist-es/commands/GetRecoveryPointIndexDetailsCommand.js +22 -0
- package/dist-es/commands/ListIndexedRecoveryPointsCommand.js +22 -0
- package/dist-es/commands/UpdateRecoveryPointIndexSettingsCommand.js +22 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/models_0.js +10 -0
- package/dist-es/pagination/ListIndexedRecoveryPointsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +135 -4
- package/dist-es/runtimeConfig.js +8 -6
- package/dist-types/Backup.d.ts +22 -0
- package/dist-types/BackupClient.d.ts +23 -2
- package/dist-types/commands/CreateBackupPlanCommand.d.ts +7 -0
- package/dist-types/commands/DescribeRecoveryPointCommand.d.ts +2 -0
- package/dist-types/commands/GetBackupPlanCommand.d.ts +7 -0
- package/dist-types/commands/GetBackupPlanFromJSONCommand.d.ts +7 -0
- package/dist-types/commands/GetBackupPlanFromTemplateCommand.d.ts +7 -0
- package/dist-types/commands/GetRecoveryPointIndexDetailsCommand.d.ts +94 -0
- package/dist-types/commands/ListIndexedRecoveryPointsCommand.d.ts +104 -0
- package/dist-types/commands/ListRecoveryPointsByBackupVaultCommand.d.ts +2 -0
- package/dist-types/commands/ListRecoveryPointsByResourceCommand.d.ts +2 -0
- package/dist-types/commands/StartBackupJobCommand.d.ts +1 -0
- package/dist-types/commands/UpdateBackupPlanCommand.d.ts +7 -0
- package/dist-types/commands/UpdateRecoveryPointIndexSettingsCommand.d.ts +95 -0
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +475 -0
- package/dist-types/pagination/ListIndexedRecoveryPointsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
- package/dist-types/runtimeConfig.browser.d.ts +1 -0
- package/dist-types/runtimeConfig.d.ts +1 -0
- package/dist-types/runtimeConfig.native.d.ts +1 -0
- package/dist-types/ts3.4/Backup.d.ts +52 -0
- package/dist-types/ts3.4/BackupClient.d.ts +19 -0
- package/dist-types/ts3.4/commands/GetRecoveryPointIndexDetailsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListIndexedRecoveryPointsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateRecoveryPointIndexSettingsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +75 -0
- package/dist-types/ts3.4/pagination/ListIndexedRecoveryPointsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -0
- package/package.json +19 -19
|
@@ -455,6 +455,29 @@ export interface CopyAction {
|
|
|
455
455
|
*/
|
|
456
456
|
DestinationBackupVaultArn: string | undefined;
|
|
457
457
|
}
|
|
458
|
+
/**
|
|
459
|
+
* <p>This is an optional array within a BackupRule.</p>
|
|
460
|
+
* <p>IndexAction consists of one ResourceTypes.</p>
|
|
461
|
+
* @public
|
|
462
|
+
*/
|
|
463
|
+
export interface IndexAction {
|
|
464
|
+
/**
|
|
465
|
+
* <p>0 or 1 index action will be accepted for each BackupRule.</p>
|
|
466
|
+
* <p>Valid values:</p>
|
|
467
|
+
* <ul>
|
|
468
|
+
* <li>
|
|
469
|
+
* <p>
|
|
470
|
+
* <code>EBS</code> for Amazon Elastic Block Store</p>
|
|
471
|
+
* </li>
|
|
472
|
+
* <li>
|
|
473
|
+
* <p>
|
|
474
|
+
* <code>S3</code> for Amazon Simple Storage Service (Amazon S3)</p>
|
|
475
|
+
* </li>
|
|
476
|
+
* </ul>
|
|
477
|
+
* @public
|
|
478
|
+
*/
|
|
479
|
+
ResourceTypes?: string[] | undefined;
|
|
480
|
+
}
|
|
458
481
|
/**
|
|
459
482
|
* <p>Specifies a scheduled task used to back up a selection of resources.</p>
|
|
460
483
|
* @public
|
|
@@ -546,6 +569,15 @@ export interface BackupRule {
|
|
|
546
569
|
* @public
|
|
547
570
|
*/
|
|
548
571
|
ScheduleExpressionTimezone?: string | undefined;
|
|
572
|
+
/**
|
|
573
|
+
* <p>IndexActions is an array you use to specify how backup data should
|
|
574
|
+
* be indexed.</p>
|
|
575
|
+
* <p>eEach BackupRule can have 0 or 1 IndexAction, as each backup can have up
|
|
576
|
+
* to one index associated with it.</p>
|
|
577
|
+
* <p>Within the array is ResourceType. Only one will be accepted for each BackupRule.</p>
|
|
578
|
+
* @public
|
|
579
|
+
*/
|
|
580
|
+
IndexActions?: IndexAction[] | undefined;
|
|
549
581
|
}
|
|
550
582
|
/**
|
|
551
583
|
* <p>Contains an optional backup plan display name and an array of <code>BackupRule</code>
|
|
@@ -657,6 +689,24 @@ export interface BackupRuleInput {
|
|
|
657
689
|
* @public
|
|
658
690
|
*/
|
|
659
691
|
ScheduleExpressionTimezone?: string | undefined;
|
|
692
|
+
/**
|
|
693
|
+
* <p>There can up to one IndexAction in each BackupRule, as each backup
|
|
694
|
+
* can have 0 or 1 backup index associated with it.</p>
|
|
695
|
+
* <p>Within the array is ResourceTypes. Only 1 resource type will
|
|
696
|
+
* be accepted for each BackupRule. Valid values:</p>
|
|
697
|
+
* <ul>
|
|
698
|
+
* <li>
|
|
699
|
+
* <p>
|
|
700
|
+
* <code>EBS</code> for Amazon Elastic Block Store</p>
|
|
701
|
+
* </li>
|
|
702
|
+
* <li>
|
|
703
|
+
* <p>
|
|
704
|
+
* <code>S3</code> for Amazon Simple Storage Service (Amazon S3)</p>
|
|
705
|
+
* </li>
|
|
706
|
+
* </ul>
|
|
707
|
+
* @public
|
|
708
|
+
*/
|
|
709
|
+
IndexActions?: IndexAction[] | undefined;
|
|
660
710
|
}
|
|
661
711
|
/**
|
|
662
712
|
* <p>Contains an optional backup plan display name and an array of <code>BackupRule</code>
|
|
@@ -3452,6 +3502,20 @@ export interface DescribeRecoveryPointInput {
|
|
|
3452
3502
|
*/
|
|
3453
3503
|
BackupVaultAccountId?: string | undefined;
|
|
3454
3504
|
}
|
|
3505
|
+
/**
|
|
3506
|
+
* @public
|
|
3507
|
+
* @enum
|
|
3508
|
+
*/
|
|
3509
|
+
export declare const IndexStatus: {
|
|
3510
|
+
readonly ACTIVE: "ACTIVE";
|
|
3511
|
+
readonly DELETING: "DELETING";
|
|
3512
|
+
readonly FAILED: "FAILED";
|
|
3513
|
+
readonly PENDING: "PENDING";
|
|
3514
|
+
};
|
|
3515
|
+
/**
|
|
3516
|
+
* @public
|
|
3517
|
+
*/
|
|
3518
|
+
export type IndexStatus = (typeof IndexStatus)[keyof typeof IndexStatus];
|
|
3455
3519
|
/**
|
|
3456
3520
|
* @public
|
|
3457
3521
|
* @enum
|
|
@@ -3666,6 +3730,23 @@ export interface DescribeRecoveryPointOutput {
|
|
|
3666
3730
|
* @public
|
|
3667
3731
|
*/
|
|
3668
3732
|
VaultType?: VaultType | undefined;
|
|
3733
|
+
/**
|
|
3734
|
+
* <p>This is the current status for the backup index associated with the specified recovery
|
|
3735
|
+
* point.</p>
|
|
3736
|
+
* <p>Statuses are: <code>PENDING</code> | <code>ACTIVE</code> | <code>FAILED</code> |
|
|
3737
|
+
* <code>DELETING</code>
|
|
3738
|
+
* </p>
|
|
3739
|
+
* <p>A recovery point with an index that has the status of <code>ACTIVE</code> can be
|
|
3740
|
+
* included in a search.</p>
|
|
3741
|
+
* @public
|
|
3742
|
+
*/
|
|
3743
|
+
IndexStatus?: IndexStatus | undefined;
|
|
3744
|
+
/**
|
|
3745
|
+
* <p>A string in the form of a detailed message explaining the status of a backup index
|
|
3746
|
+
* associated with the recovery point.</p>
|
|
3747
|
+
* @public
|
|
3748
|
+
*/
|
|
3749
|
+
IndexStatusMessage?: string | undefined;
|
|
3669
3750
|
}
|
|
3670
3751
|
/**
|
|
3671
3752
|
* @public
|
|
@@ -4457,6 +4538,96 @@ export interface GetLegalHoldOutput {
|
|
|
4457
4538
|
*/
|
|
4458
4539
|
RecoveryPointSelection?: RecoveryPointSelection | undefined;
|
|
4459
4540
|
}
|
|
4541
|
+
/**
|
|
4542
|
+
* @public
|
|
4543
|
+
*/
|
|
4544
|
+
export interface GetRecoveryPointIndexDetailsInput {
|
|
4545
|
+
/**
|
|
4546
|
+
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
4547
|
+
* by names that are unique to the account used to create them and the Region where they are
|
|
4548
|
+
* created.</p>
|
|
4549
|
+
* <p>Accepted characters include lowercase letters, numbers, and hyphens.</p>
|
|
4550
|
+
* @public
|
|
4551
|
+
*/
|
|
4552
|
+
BackupVaultName: string | undefined;
|
|
4553
|
+
/**
|
|
4554
|
+
* <p>An ARN that uniquely identifies a recovery point; for example,
|
|
4555
|
+
* <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
|
|
4556
|
+
* @public
|
|
4557
|
+
*/
|
|
4558
|
+
RecoveryPointArn: string | undefined;
|
|
4559
|
+
}
|
|
4560
|
+
/**
|
|
4561
|
+
* @public
|
|
4562
|
+
*/
|
|
4563
|
+
export interface GetRecoveryPointIndexDetailsOutput {
|
|
4564
|
+
/**
|
|
4565
|
+
* <p>An ARN that uniquely identifies a recovery point; for example,
|
|
4566
|
+
* <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
|
|
4567
|
+
* @public
|
|
4568
|
+
*/
|
|
4569
|
+
RecoveryPointArn?: string | undefined;
|
|
4570
|
+
/**
|
|
4571
|
+
* <p>An ARN that uniquely identifies the backup vault where the recovery
|
|
4572
|
+
* point index is stored.</p>
|
|
4573
|
+
* <p>For example,
|
|
4574
|
+
* <code>arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault</code>.</p>
|
|
4575
|
+
* @public
|
|
4576
|
+
*/
|
|
4577
|
+
BackupVaultArn?: string | undefined;
|
|
4578
|
+
/**
|
|
4579
|
+
* <p>A string of the Amazon Resource Name (ARN) that uniquely identifies
|
|
4580
|
+
* the source resource.</p>
|
|
4581
|
+
* @public
|
|
4582
|
+
*/
|
|
4583
|
+
SourceResourceArn?: string | undefined;
|
|
4584
|
+
/**
|
|
4585
|
+
* <p>The date and time that a backup index was created, in Unix format and Coordinated
|
|
4586
|
+
* Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds.
|
|
4587
|
+
* For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
4588
|
+
* AM.</p>
|
|
4589
|
+
* @public
|
|
4590
|
+
*/
|
|
4591
|
+
IndexCreationDate?: Date | undefined;
|
|
4592
|
+
/**
|
|
4593
|
+
* <p>The date and time that a backup index was deleted, in Unix format and Coordinated
|
|
4594
|
+
* Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds.
|
|
4595
|
+
* For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
4596
|
+
* AM.</p>
|
|
4597
|
+
* @public
|
|
4598
|
+
*/
|
|
4599
|
+
IndexDeletionDate?: Date | undefined;
|
|
4600
|
+
/**
|
|
4601
|
+
* <p>The date and time that a backup index finished creation, in Unix format and Coordinated
|
|
4602
|
+
* Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds.
|
|
4603
|
+
* For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
4604
|
+
* AM.</p>
|
|
4605
|
+
* @public
|
|
4606
|
+
*/
|
|
4607
|
+
IndexCompletionDate?: Date | undefined;
|
|
4608
|
+
/**
|
|
4609
|
+
* <p>This is the current status for the backup index associated
|
|
4610
|
+
* with the specified recovery point.</p>
|
|
4611
|
+
* <p>Statuses are: <code>PENDING</code> | <code>ACTIVE</code> | <code>FAILED</code> | <code>DELETING</code>
|
|
4612
|
+
* </p>
|
|
4613
|
+
* <p>A recovery point with an index that has the status of <code>ACTIVE</code>
|
|
4614
|
+
* can be included in a search.</p>
|
|
4615
|
+
* @public
|
|
4616
|
+
*/
|
|
4617
|
+
IndexStatus?: IndexStatus | undefined;
|
|
4618
|
+
/**
|
|
4619
|
+
* <p>A detailed message explaining the status of a backup index associated
|
|
4620
|
+
* with the recovery point.</p>
|
|
4621
|
+
* @public
|
|
4622
|
+
*/
|
|
4623
|
+
IndexStatusMessage?: string | undefined;
|
|
4624
|
+
/**
|
|
4625
|
+
* <p>Count of items within the backup index associated with the
|
|
4626
|
+
* recovery point.</p>
|
|
4627
|
+
* @public
|
|
4628
|
+
*/
|
|
4629
|
+
TotalItemsIndexed?: number | undefined;
|
|
4630
|
+
}
|
|
4460
4631
|
/**
|
|
4461
4632
|
* @public
|
|
4462
4633
|
*/
|
|
@@ -5783,6 +5954,172 @@ export interface ListFrameworksOutput {
|
|
|
5783
5954
|
*/
|
|
5784
5955
|
NextToken?: string | undefined;
|
|
5785
5956
|
}
|
|
5957
|
+
/**
|
|
5958
|
+
* @public
|
|
5959
|
+
*/
|
|
5960
|
+
export interface ListIndexedRecoveryPointsInput {
|
|
5961
|
+
/**
|
|
5962
|
+
* <p>The next item following a partial list of returned recovery points.</p>
|
|
5963
|
+
* <p>For example, if a request
|
|
5964
|
+
* is made to return <code>MaxResults</code> number of indexed recovery points, <code>NextToken</code>
|
|
5965
|
+
* allows you to return more items in your list starting at the location pointed to by the
|
|
5966
|
+
* next token.</p>
|
|
5967
|
+
* @public
|
|
5968
|
+
*/
|
|
5969
|
+
NextToken?: string | undefined;
|
|
5970
|
+
/**
|
|
5971
|
+
* <p>The maximum number of resource list items to be returned.</p>
|
|
5972
|
+
* @public
|
|
5973
|
+
*/
|
|
5974
|
+
MaxResults?: number | undefined;
|
|
5975
|
+
/**
|
|
5976
|
+
* <p>A string of the Amazon Resource Name (ARN) that uniquely identifies
|
|
5977
|
+
* the source resource.</p>
|
|
5978
|
+
* @public
|
|
5979
|
+
*/
|
|
5980
|
+
SourceResourceArn?: string | undefined;
|
|
5981
|
+
/**
|
|
5982
|
+
* <p>Returns only indexed recovery points that were created before the
|
|
5983
|
+
* specified date.</p>
|
|
5984
|
+
* @public
|
|
5985
|
+
*/
|
|
5986
|
+
CreatedBefore?: Date | undefined;
|
|
5987
|
+
/**
|
|
5988
|
+
* <p>Returns only indexed recovery points that were created after the
|
|
5989
|
+
* specified date.</p>
|
|
5990
|
+
* @public
|
|
5991
|
+
*/
|
|
5992
|
+
CreatedAfter?: Date | undefined;
|
|
5993
|
+
/**
|
|
5994
|
+
* <p>Returns a list of indexed recovery points for the specified
|
|
5995
|
+
* resource type(s).</p>
|
|
5996
|
+
* <p>Accepted values include:</p>
|
|
5997
|
+
* <ul>
|
|
5998
|
+
* <li>
|
|
5999
|
+
* <p>
|
|
6000
|
+
* <code>EBS</code> for Amazon Elastic Block Store</p>
|
|
6001
|
+
* </li>
|
|
6002
|
+
* <li>
|
|
6003
|
+
* <p>
|
|
6004
|
+
* <code>S3</code> for Amazon Simple Storage Service (Amazon S3)</p>
|
|
6005
|
+
* </li>
|
|
6006
|
+
* </ul>
|
|
6007
|
+
* @public
|
|
6008
|
+
*/
|
|
6009
|
+
ResourceType?: string | undefined;
|
|
6010
|
+
/**
|
|
6011
|
+
* <p>Include this parameter to filter the returned list by
|
|
6012
|
+
* the indicated statuses.</p>
|
|
6013
|
+
* <p>Accepted values: <code>PENDING</code> | <code>ACTIVE</code> | <code>FAILED</code> | <code>DELETING</code>
|
|
6014
|
+
* </p>
|
|
6015
|
+
* <p>A recovery point with an index that has the status of <code>ACTIVE</code>
|
|
6016
|
+
* can be included in a search.</p>
|
|
6017
|
+
* @public
|
|
6018
|
+
*/
|
|
6019
|
+
IndexStatus?: IndexStatus | undefined;
|
|
6020
|
+
}
|
|
6021
|
+
/**
|
|
6022
|
+
* <p>This is a recovery point that has an associated backup index.</p>
|
|
6023
|
+
* <p>Only recovery points with a backup index can be
|
|
6024
|
+
* included in a search.</p>
|
|
6025
|
+
* @public
|
|
6026
|
+
*/
|
|
6027
|
+
export interface IndexedRecoveryPoint {
|
|
6028
|
+
/**
|
|
6029
|
+
* <p>An ARN that uniquely identifies a recovery point; for example,
|
|
6030
|
+
* <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>
|
|
6031
|
+
* </p>
|
|
6032
|
+
* @public
|
|
6033
|
+
*/
|
|
6034
|
+
RecoveryPointArn?: string | undefined;
|
|
6035
|
+
/**
|
|
6036
|
+
* <p>A string of the Amazon Resource Name (ARN) that uniquely identifies
|
|
6037
|
+
* the source resource.</p>
|
|
6038
|
+
* @public
|
|
6039
|
+
*/
|
|
6040
|
+
SourceResourceArn?: string | undefined;
|
|
6041
|
+
/**
|
|
6042
|
+
* <p>This specifies the IAM role ARN used for this operation.</p>
|
|
6043
|
+
* <p>For example, arn:aws:iam::123456789012:role/S3Access</p>
|
|
6044
|
+
* @public
|
|
6045
|
+
*/
|
|
6046
|
+
IamRoleArn?: string | undefined;
|
|
6047
|
+
/**
|
|
6048
|
+
* <p>The date and time that a backup was created, in Unix format and Coordinated
|
|
6049
|
+
* Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds.
|
|
6050
|
+
* For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
6051
|
+
* AM.</p>
|
|
6052
|
+
* @public
|
|
6053
|
+
*/
|
|
6054
|
+
BackupCreationDate?: Date | undefined;
|
|
6055
|
+
/**
|
|
6056
|
+
* <p>The resource type of the indexed recovery point.</p>
|
|
6057
|
+
* <ul>
|
|
6058
|
+
* <li>
|
|
6059
|
+
* <p>
|
|
6060
|
+
* <code>EBS</code> for Amazon Elastic Block Store</p>
|
|
6061
|
+
* </li>
|
|
6062
|
+
* <li>
|
|
6063
|
+
* <p>
|
|
6064
|
+
* <code>S3</code> for Amazon Simple Storage Service (Amazon S3)</p>
|
|
6065
|
+
* </li>
|
|
6066
|
+
* </ul>
|
|
6067
|
+
* @public
|
|
6068
|
+
*/
|
|
6069
|
+
ResourceType?: string | undefined;
|
|
6070
|
+
/**
|
|
6071
|
+
* <p>The date and time that a backup index was created, in Unix format and Coordinated
|
|
6072
|
+
* Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds.
|
|
6073
|
+
* For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
6074
|
+
* AM.</p>
|
|
6075
|
+
* @public
|
|
6076
|
+
*/
|
|
6077
|
+
IndexCreationDate?: Date | undefined;
|
|
6078
|
+
/**
|
|
6079
|
+
* <p>This is the current status for the backup index associated
|
|
6080
|
+
* with the specified recovery point.</p>
|
|
6081
|
+
* <p>Statuses are: <code>PENDING</code> | <code>ACTIVE</code> | <code>FAILED</code> | <code>DELETING</code>
|
|
6082
|
+
* </p>
|
|
6083
|
+
* <p>A recovery point with an index that has the status of <code>ACTIVE</code>
|
|
6084
|
+
* can be included in a search.</p>
|
|
6085
|
+
* @public
|
|
6086
|
+
*/
|
|
6087
|
+
IndexStatus?: IndexStatus | undefined;
|
|
6088
|
+
/**
|
|
6089
|
+
* <p>A string in the form of a detailed message explaining the status of a backup index associated
|
|
6090
|
+
* with the recovery point.</p>
|
|
6091
|
+
* @public
|
|
6092
|
+
*/
|
|
6093
|
+
IndexStatusMessage?: string | undefined;
|
|
6094
|
+
/**
|
|
6095
|
+
* <p>An ARN that uniquely identifies the backup vault where the recovery
|
|
6096
|
+
* point index is stored.</p>
|
|
6097
|
+
* <p>For example,
|
|
6098
|
+
* <code>arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault</code>.</p>
|
|
6099
|
+
* @public
|
|
6100
|
+
*/
|
|
6101
|
+
BackupVaultArn?: string | undefined;
|
|
6102
|
+
}
|
|
6103
|
+
/**
|
|
6104
|
+
* @public
|
|
6105
|
+
*/
|
|
6106
|
+
export interface ListIndexedRecoveryPointsOutput {
|
|
6107
|
+
/**
|
|
6108
|
+
* <p>This is a list of recovery points that have an
|
|
6109
|
+
* associated index, belonging to the specified account.</p>
|
|
6110
|
+
* @public
|
|
6111
|
+
*/
|
|
6112
|
+
IndexedRecoveryPoints?: IndexedRecoveryPoint[] | undefined;
|
|
6113
|
+
/**
|
|
6114
|
+
* <p>The next item following a partial list of returned recovery points.</p>
|
|
6115
|
+
* <p>For example, if a request
|
|
6116
|
+
* is made to return <code>MaxResults</code> number of indexed recovery points, <code>NextToken</code>
|
|
6117
|
+
* allows you to return more items in your list starting at the location pointed to by the
|
|
6118
|
+
* next token.</p>
|
|
6119
|
+
* @public
|
|
6120
|
+
*/
|
|
6121
|
+
NextToken?: string | undefined;
|
|
6122
|
+
}
|
|
5786
6123
|
/**
|
|
5787
6124
|
* @public
|
|
5788
6125
|
*/
|
|
@@ -6289,6 +6626,23 @@ export interface RecoveryPointByBackupVault {
|
|
|
6289
6626
|
* @public
|
|
6290
6627
|
*/
|
|
6291
6628
|
VaultType?: VaultType | undefined;
|
|
6629
|
+
/**
|
|
6630
|
+
* <p>This is the current status for the backup index associated
|
|
6631
|
+
* with the specified recovery point.</p>
|
|
6632
|
+
* <p>Statuses are: <code>PENDING</code> | <code>ACTIVE</code> | <code>FAILED</code> |
|
|
6633
|
+
* <code>DELETING</code>
|
|
6634
|
+
* </p>
|
|
6635
|
+
* <p>A recovery point with an index that has the status of <code>ACTIVE</code>
|
|
6636
|
+
* can be included in a search.</p>
|
|
6637
|
+
* @public
|
|
6638
|
+
*/
|
|
6639
|
+
IndexStatus?: IndexStatus | undefined;
|
|
6640
|
+
/**
|
|
6641
|
+
* <p>A string in the form of a detailed message explaining the status of a backup index associated
|
|
6642
|
+
* with the recovery point.</p>
|
|
6643
|
+
* @public
|
|
6644
|
+
*/
|
|
6645
|
+
IndexStatusMessage?: string | undefined;
|
|
6292
6646
|
}
|
|
6293
6647
|
/**
|
|
6294
6648
|
* @public
|
|
@@ -6489,6 +6843,22 @@ export interface RecoveryPointByResource {
|
|
|
6489
6843
|
* @public
|
|
6490
6844
|
*/
|
|
6491
6845
|
VaultType?: VaultType | undefined;
|
|
6846
|
+
/**
|
|
6847
|
+
* <p>This is the current status for the backup index associated
|
|
6848
|
+
* with the specified recovery point.</p>
|
|
6849
|
+
* <p>Statuses are: <code>PENDING</code> | <code>ACTIVE</code> | <code>FAILED</code> | <code>DELETING</code>
|
|
6850
|
+
* </p>
|
|
6851
|
+
* <p>A recovery point with an index that has the status of <code>ACTIVE</code>
|
|
6852
|
+
* can be included in a search.</p>
|
|
6853
|
+
* @public
|
|
6854
|
+
*/
|
|
6855
|
+
IndexStatus?: IndexStatus | undefined;
|
|
6856
|
+
/**
|
|
6857
|
+
* <p>A string in the form of a detailed message explaining the status of a backup index
|
|
6858
|
+
* associated with the recovery point.</p>
|
|
6859
|
+
* @public
|
|
6860
|
+
*/
|
|
6861
|
+
IndexStatusMessage?: string | undefined;
|
|
6492
6862
|
}
|
|
6493
6863
|
/**
|
|
6494
6864
|
* @public
|
|
@@ -7523,6 +7893,18 @@ export interface PutRestoreValidationResultInput {
|
|
|
7523
7893
|
*/
|
|
7524
7894
|
ValidationStatusMessage?: string | undefined;
|
|
7525
7895
|
}
|
|
7896
|
+
/**
|
|
7897
|
+
* @public
|
|
7898
|
+
* @enum
|
|
7899
|
+
*/
|
|
7900
|
+
export declare const Index: {
|
|
7901
|
+
readonly DISABLED: "DISABLED";
|
|
7902
|
+
readonly ENABLED: "ENABLED";
|
|
7903
|
+
};
|
|
7904
|
+
/**
|
|
7905
|
+
* @public
|
|
7906
|
+
*/
|
|
7907
|
+
export type Index = (typeof Index)[keyof typeof Index];
|
|
7526
7908
|
/**
|
|
7527
7909
|
* @public
|
|
7528
7910
|
*/
|
|
@@ -7608,6 +7990,28 @@ export interface StartBackupJobInput {
|
|
|
7608
7990
|
* @public
|
|
7609
7991
|
*/
|
|
7610
7992
|
BackupOptions?: Record<string, string> | undefined;
|
|
7993
|
+
/**
|
|
7994
|
+
* <p>Include this parameter to enable index creation if your backup
|
|
7995
|
+
* job has a resource type that supports backup indexes.</p>
|
|
7996
|
+
* <p>Resource types that support backup indexes include:</p>
|
|
7997
|
+
* <ul>
|
|
7998
|
+
* <li>
|
|
7999
|
+
* <p>
|
|
8000
|
+
* <code>EBS</code> for Amazon Elastic Block Store</p>
|
|
8001
|
+
* </li>
|
|
8002
|
+
* <li>
|
|
8003
|
+
* <p>
|
|
8004
|
+
* <code>S3</code> for Amazon Simple Storage Service (Amazon S3)</p>
|
|
8005
|
+
* </li>
|
|
8006
|
+
* </ul>
|
|
8007
|
+
* <p>Index can have 1 of 2 possible values, either <code>ENABLED</code> or
|
|
8008
|
+
* <code>DISABLED</code>.</p>
|
|
8009
|
+
* <p>To create a backup index for an eligible <code>ACTIVE</code> recovery point
|
|
8010
|
+
* that does not yet have a backup index, set value to <code>ENABLED</code>.</p>
|
|
8011
|
+
* <p>To delete a backup index, set value to <code>DISABLED</code>.</p>
|
|
8012
|
+
* @public
|
|
8013
|
+
*/
|
|
8014
|
+
Index?: Index | undefined;
|
|
7611
8015
|
}
|
|
7612
8016
|
/**
|
|
7613
8017
|
* @public
|
|
@@ -8116,6 +8520,77 @@ export interface UpdateGlobalSettingsInput {
|
|
|
8116
8520
|
*/
|
|
8117
8521
|
GlobalSettings?: Record<string, string> | undefined;
|
|
8118
8522
|
}
|
|
8523
|
+
/**
|
|
8524
|
+
* @public
|
|
8525
|
+
*/
|
|
8526
|
+
export interface UpdateRecoveryPointIndexSettingsInput {
|
|
8527
|
+
/**
|
|
8528
|
+
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
8529
|
+
* by names that are unique to the account used to create them and the Region where they are
|
|
8530
|
+
* created.</p>
|
|
8531
|
+
* <p>Accepted characters include lowercase letters, numbers, and hyphens.</p>
|
|
8532
|
+
* @public
|
|
8533
|
+
*/
|
|
8534
|
+
BackupVaultName: string | undefined;
|
|
8535
|
+
/**
|
|
8536
|
+
* <p>An ARN that uniquely identifies a recovery point; for example,
|
|
8537
|
+
* <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
|
|
8538
|
+
* @public
|
|
8539
|
+
*/
|
|
8540
|
+
RecoveryPointArn: string | undefined;
|
|
8541
|
+
/**
|
|
8542
|
+
* <p>This specifies the IAM role ARN used for this operation.</p>
|
|
8543
|
+
* <p>For example, arn:aws:iam::123456789012:role/S3Access</p>
|
|
8544
|
+
* @public
|
|
8545
|
+
*/
|
|
8546
|
+
IamRoleArn?: string | undefined;
|
|
8547
|
+
/**
|
|
8548
|
+
* <p>Index can have 1 of 2 possible values, either <code>ENABLED</code> or
|
|
8549
|
+
* <code>DISABLED</code>.</p>
|
|
8550
|
+
* <p>To create a backup index for an eligible <code>ACTIVE</code> recovery point
|
|
8551
|
+
* that does not yet have a backup index, set value to <code>ENABLED</code>.</p>
|
|
8552
|
+
* <p>To delete a backup index, set value to <code>DISABLED</code>.</p>
|
|
8553
|
+
* @public
|
|
8554
|
+
*/
|
|
8555
|
+
Index: Index | undefined;
|
|
8556
|
+
}
|
|
8557
|
+
/**
|
|
8558
|
+
* @public
|
|
8559
|
+
*/
|
|
8560
|
+
export interface UpdateRecoveryPointIndexSettingsOutput {
|
|
8561
|
+
/**
|
|
8562
|
+
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
8563
|
+
* by names that are unique to the account used to create them and the Region where they are
|
|
8564
|
+
* created.</p>
|
|
8565
|
+
* @public
|
|
8566
|
+
*/
|
|
8567
|
+
BackupVaultName?: string | undefined;
|
|
8568
|
+
/**
|
|
8569
|
+
* <p>An ARN that uniquely identifies a recovery point; for example,
|
|
8570
|
+
* <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
|
|
8571
|
+
* @public
|
|
8572
|
+
*/
|
|
8573
|
+
RecoveryPointArn?: string | undefined;
|
|
8574
|
+
/**
|
|
8575
|
+
* <p>This is the current status for the backup index associated
|
|
8576
|
+
* with the specified recovery point.</p>
|
|
8577
|
+
* <p>Statuses are: <code>PENDING</code> | <code>ACTIVE</code> | <code>FAILED</code> | <code>DELETING</code>
|
|
8578
|
+
* </p>
|
|
8579
|
+
* <p>A recovery point with an index that has the status of <code>ACTIVE</code>
|
|
8580
|
+
* can be included in a search.</p>
|
|
8581
|
+
* @public
|
|
8582
|
+
*/
|
|
8583
|
+
IndexStatus?: IndexStatus | undefined;
|
|
8584
|
+
/**
|
|
8585
|
+
* <p>Index can have 1 of 2 possible values, either <code>ENABLED</code> or
|
|
8586
|
+
* <code>DISABLED</code>.</p>
|
|
8587
|
+
* <p>A value of <code>ENABLED</code> means a backup index for an eligible <code>ACTIVE</code>
|
|
8588
|
+
* recovery point has been created.</p>
|
|
8589
|
+
* <p>A value of <code>DISABLED</code> means a backup index was deleted.</p>
|
|
8590
|
+
* @public
|
|
8591
|
+
*/
|
|
8592
|
+
Index?: Index | undefined;
|
|
8593
|
+
}
|
|
8119
8594
|
/**
|
|
8120
8595
|
* @public
|
|
8121
8596
|
*/
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { Paginator } from "@smithy/types";
|
|
2
|
+
import { ListIndexedRecoveryPointsCommandInput, ListIndexedRecoveryPointsCommandOutput } from "../commands/ListIndexedRecoveryPointsCommand";
|
|
3
|
+
import { BackupPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export declare const paginateListIndexedRecoveryPoints: (config: BackupPaginationConfiguration, input: ListIndexedRecoveryPointsCommandInput, ...rest: any[]) => Paginator<ListIndexedRecoveryPointsCommandOutput>;
|
|
@@ -9,6 +9,7 @@ export * from "./ListBackupVaultsPaginator";
|
|
|
9
9
|
export * from "./ListCopyJobSummariesPaginator";
|
|
10
10
|
export * from "./ListCopyJobsPaginator";
|
|
11
11
|
export * from "./ListFrameworksPaginator";
|
|
12
|
+
export * from "./ListIndexedRecoveryPointsPaginator";
|
|
12
13
|
export * from "./ListLegalHoldsPaginator";
|
|
13
14
|
export * from "./ListProtectedResourcesByBackupVaultPaginator";
|
|
14
15
|
export * from "./ListProtectedResourcesPaginator";
|
|
@@ -42,6 +42,7 @@ import { GetBackupSelectionCommandInput, GetBackupSelectionCommandOutput } from
|
|
|
42
42
|
import { GetBackupVaultAccessPolicyCommandInput, GetBackupVaultAccessPolicyCommandOutput } from "../commands/GetBackupVaultAccessPolicyCommand";
|
|
43
43
|
import { GetBackupVaultNotificationsCommandInput, GetBackupVaultNotificationsCommandOutput } from "../commands/GetBackupVaultNotificationsCommand";
|
|
44
44
|
import { GetLegalHoldCommandInput, GetLegalHoldCommandOutput } from "../commands/GetLegalHoldCommand";
|
|
45
|
+
import { GetRecoveryPointIndexDetailsCommandInput, GetRecoveryPointIndexDetailsCommandOutput } from "../commands/GetRecoveryPointIndexDetailsCommand";
|
|
45
46
|
import { GetRecoveryPointRestoreMetadataCommandInput, GetRecoveryPointRestoreMetadataCommandOutput } from "../commands/GetRecoveryPointRestoreMetadataCommand";
|
|
46
47
|
import { GetRestoreJobMetadataCommandInput, GetRestoreJobMetadataCommandOutput } from "../commands/GetRestoreJobMetadataCommand";
|
|
47
48
|
import { GetRestoreTestingInferredMetadataCommandInput, GetRestoreTestingInferredMetadataCommandOutput } from "../commands/GetRestoreTestingInferredMetadataCommand";
|
|
@@ -58,6 +59,7 @@ import { ListBackupVaultsCommandInput, ListBackupVaultsCommandOutput } from "../
|
|
|
58
59
|
import { ListCopyJobsCommandInput, ListCopyJobsCommandOutput } from "../commands/ListCopyJobsCommand";
|
|
59
60
|
import { ListCopyJobSummariesCommandInput, ListCopyJobSummariesCommandOutput } from "../commands/ListCopyJobSummariesCommand";
|
|
60
61
|
import { ListFrameworksCommandInput, ListFrameworksCommandOutput } from "../commands/ListFrameworksCommand";
|
|
62
|
+
import { ListIndexedRecoveryPointsCommandInput, ListIndexedRecoveryPointsCommandOutput } from "../commands/ListIndexedRecoveryPointsCommand";
|
|
61
63
|
import { ListLegalHoldsCommandInput, ListLegalHoldsCommandOutput } from "../commands/ListLegalHoldsCommand";
|
|
62
64
|
import { ListProtectedResourcesByBackupVaultCommandInput, ListProtectedResourcesByBackupVaultCommandOutput } from "../commands/ListProtectedResourcesByBackupVaultCommand";
|
|
63
65
|
import { ListProtectedResourcesCommandInput, ListProtectedResourcesCommandOutput } from "../commands/ListProtectedResourcesCommand";
|
|
@@ -86,6 +88,7 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "../comman
|
|
|
86
88
|
import { UpdateBackupPlanCommandInput, UpdateBackupPlanCommandOutput } from "../commands/UpdateBackupPlanCommand";
|
|
87
89
|
import { UpdateFrameworkCommandInput, UpdateFrameworkCommandOutput } from "../commands/UpdateFrameworkCommand";
|
|
88
90
|
import { UpdateGlobalSettingsCommandInput, UpdateGlobalSettingsCommandOutput } from "../commands/UpdateGlobalSettingsCommand";
|
|
91
|
+
import { UpdateRecoveryPointIndexSettingsCommandInput, UpdateRecoveryPointIndexSettingsCommandOutput } from "../commands/UpdateRecoveryPointIndexSettingsCommand";
|
|
89
92
|
import { UpdateRecoveryPointLifecycleCommandInput, UpdateRecoveryPointLifecycleCommandOutput } from "../commands/UpdateRecoveryPointLifecycleCommand";
|
|
90
93
|
import { UpdateRegionSettingsCommandInput, UpdateRegionSettingsCommandOutput } from "../commands/UpdateRegionSettingsCommand";
|
|
91
94
|
import { UpdateReportPlanCommandInput, UpdateReportPlanCommandOutput } from "../commands/UpdateReportPlanCommand";
|
|
@@ -259,6 +262,10 @@ export declare const se_GetBackupVaultNotificationsCommand: (input: GetBackupVau
|
|
|
259
262
|
* serializeAws_restJson1GetLegalHoldCommand
|
|
260
263
|
*/
|
|
261
264
|
export declare const se_GetLegalHoldCommand: (input: GetLegalHoldCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
265
|
+
/**
|
|
266
|
+
* serializeAws_restJson1GetRecoveryPointIndexDetailsCommand
|
|
267
|
+
*/
|
|
268
|
+
export declare const se_GetRecoveryPointIndexDetailsCommand: (input: GetRecoveryPointIndexDetailsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
262
269
|
/**
|
|
263
270
|
* serializeAws_restJson1GetRecoveryPointRestoreMetadataCommand
|
|
264
271
|
*/
|
|
@@ -323,6 +330,10 @@ export declare const se_ListCopyJobSummariesCommand: (input: ListCopyJobSummarie
|
|
|
323
330
|
* serializeAws_restJson1ListFrameworksCommand
|
|
324
331
|
*/
|
|
325
332
|
export declare const se_ListFrameworksCommand: (input: ListFrameworksCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
333
|
+
/**
|
|
334
|
+
* serializeAws_restJson1ListIndexedRecoveryPointsCommand
|
|
335
|
+
*/
|
|
336
|
+
export declare const se_ListIndexedRecoveryPointsCommand: (input: ListIndexedRecoveryPointsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
326
337
|
/**
|
|
327
338
|
* serializeAws_restJson1ListLegalHoldsCommand
|
|
328
339
|
*/
|
|
@@ -435,6 +446,10 @@ export declare const se_UpdateFrameworkCommand: (input: UpdateFrameworkCommandIn
|
|
|
435
446
|
* serializeAws_restJson1UpdateGlobalSettingsCommand
|
|
436
447
|
*/
|
|
437
448
|
export declare const se_UpdateGlobalSettingsCommand: (input: UpdateGlobalSettingsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
449
|
+
/**
|
|
450
|
+
* serializeAws_restJson1UpdateRecoveryPointIndexSettingsCommand
|
|
451
|
+
*/
|
|
452
|
+
export declare const se_UpdateRecoveryPointIndexSettingsCommand: (input: UpdateRecoveryPointIndexSettingsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
438
453
|
/**
|
|
439
454
|
* serializeAws_restJson1UpdateRecoveryPointLifecycleCommand
|
|
440
455
|
*/
|
|
@@ -623,6 +638,10 @@ export declare const de_GetBackupVaultNotificationsCommand: (output: __HttpRespo
|
|
|
623
638
|
* deserializeAws_restJson1GetLegalHoldCommand
|
|
624
639
|
*/
|
|
625
640
|
export declare const de_GetLegalHoldCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetLegalHoldCommandOutput>;
|
|
641
|
+
/**
|
|
642
|
+
* deserializeAws_restJson1GetRecoveryPointIndexDetailsCommand
|
|
643
|
+
*/
|
|
644
|
+
export declare const de_GetRecoveryPointIndexDetailsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetRecoveryPointIndexDetailsCommandOutput>;
|
|
626
645
|
/**
|
|
627
646
|
* deserializeAws_restJson1GetRecoveryPointRestoreMetadataCommand
|
|
628
647
|
*/
|
|
@@ -687,6 +706,10 @@ export declare const de_ListCopyJobSummariesCommand: (output: __HttpResponse, co
|
|
|
687
706
|
* deserializeAws_restJson1ListFrameworksCommand
|
|
688
707
|
*/
|
|
689
708
|
export declare const de_ListFrameworksCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListFrameworksCommandOutput>;
|
|
709
|
+
/**
|
|
710
|
+
* deserializeAws_restJson1ListIndexedRecoveryPointsCommand
|
|
711
|
+
*/
|
|
712
|
+
export declare const de_ListIndexedRecoveryPointsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListIndexedRecoveryPointsCommandOutput>;
|
|
690
713
|
/**
|
|
691
714
|
* deserializeAws_restJson1ListLegalHoldsCommand
|
|
692
715
|
*/
|
|
@@ -799,6 +822,10 @@ export declare const de_UpdateFrameworkCommand: (output: __HttpResponse, context
|
|
|
799
822
|
* deserializeAws_restJson1UpdateGlobalSettingsCommand
|
|
800
823
|
*/
|
|
801
824
|
export declare const de_UpdateGlobalSettingsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateGlobalSettingsCommandOutput>;
|
|
825
|
+
/**
|
|
826
|
+
* deserializeAws_restJson1UpdateRecoveryPointIndexSettingsCommand
|
|
827
|
+
*/
|
|
828
|
+
export declare const de_UpdateRecoveryPointIndexSettingsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateRecoveryPointIndexSettingsCommandOutput>;
|
|
802
829
|
/**
|
|
803
830
|
* deserializeAws_restJson1UpdateRecoveryPointLifecycleCommand
|
|
804
831
|
*/
|
|
@@ -26,6 +26,7 @@ export declare const getRuntimeConfig: (config: BackupClientConfig) => {
|
|
|
26
26
|
utf8Encoder: (input: string | Uint8Array) => string;
|
|
27
27
|
disableHostPrefix: boolean;
|
|
28
28
|
serviceId: string;
|
|
29
|
+
profile?: string | undefined;
|
|
29
30
|
logger: import("@smithy/types").Logger;
|
|
30
31
|
extensions: import("./runtimeExtensions").RuntimeExtension[];
|
|
31
32
|
customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
|
|
@@ -27,6 +27,7 @@ export declare const getRuntimeConfig: (config: BackupClientConfig) => {
|
|
|
27
27
|
utf8Encoder: (input: string | Uint8Array) => string;
|
|
28
28
|
disableHostPrefix: boolean;
|
|
29
29
|
serviceId: string;
|
|
30
|
+
profile?: string | undefined;
|
|
30
31
|
logger: import("@smithy/types").Logger;
|
|
31
32
|
extensions: import("./runtimeExtensions").RuntimeExtension[];
|
|
32
33
|
customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
|