This operation returns the metadata and details specific to + * the backup index associated with the specified recovery point.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, GetRecoveryPointIndexDetailsCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, GetRecoveryPointIndexDetailsCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const input = { // GetRecoveryPointIndexDetailsInput + * BackupVaultName: "STRING_VALUE", // required + * RecoveryPointArn: "STRING_VALUE", // required + * }; + * const command = new GetRecoveryPointIndexDetailsCommand(input); + * const response = await client.send(command); + * // { // GetRecoveryPointIndexDetailsOutput + * // RecoveryPointArn: "STRING_VALUE", + * // BackupVaultArn: "STRING_VALUE", + * // SourceResourceArn: "STRING_VALUE", + * // IndexCreationDate: new Date("TIMESTAMP"), + * // IndexDeletionDate: new Date("TIMESTAMP"), + * // IndexCompletionDate: new Date("TIMESTAMP"), + * // IndexStatus: "PENDING" || "ACTIVE" || "FAILED" || "DELETING", + * // IndexStatusMessage: "STRING_VALUE", + * // TotalItemsIndexed: Number("long"), + * // }; + * + * ``` + * + * @param GetRecoveryPointIndexDetailsCommandInput - {@link GetRecoveryPointIndexDetailsCommandInput} + * @returns {@link GetRecoveryPointIndexDetailsCommandOutput} + * @see {@link GetRecoveryPointIndexDetailsCommandInput} for command's `input` shape. + * @see {@link GetRecoveryPointIndexDetailsCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape. + * + * @throws {@link InvalidParameterValueException} (client fault) + *Indicates that something is wrong with a parameter's value. For example, the value is + * out of range.
+ * + * @throws {@link MissingParameterValueException} (client fault) + *Indicates that a required parameter is missing.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *A resource that is required for the action doesn't exist.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The request failed due to a temporary failure of the server.
+ * + * @throws {@link BackupServiceException} + *Base exception class for all service exceptions from Backup service.
+ * + * @public + */ +export class GetRecoveryPointIndexDetailsCommand extends $Command + .classBuilder< + GetRecoveryPointIndexDetailsCommandInput, + GetRecoveryPointIndexDetailsCommandOutput, + BackupClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: BackupClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("CryoControllerUserManager", "GetRecoveryPointIndexDetails", {}) + .n("BackupClient", "GetRecoveryPointIndexDetailsCommand") + .f(void 0, void 0) + .ser(se_GetRecoveryPointIndexDetailsCommand) + .de(de_GetRecoveryPointIndexDetailsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetRecoveryPointIndexDetailsInput; + output: GetRecoveryPointIndexDetailsOutput; + }; + sdk: { + input: GetRecoveryPointIndexDetailsCommandInput; + output: GetRecoveryPointIndexDetailsCommandOutput; + }; + }; +} diff --git a/clients/client-backup/src/commands/ListIndexedRecoveryPointsCommand.ts b/clients/client-backup/src/commands/ListIndexedRecoveryPointsCommand.ts new file mode 100644 index 000000000000..f77d83498ead --- /dev/null +++ b/clients/client-backup/src/commands/ListIndexedRecoveryPointsCommand.ts @@ -0,0 +1,125 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListIndexedRecoveryPointsInput, ListIndexedRecoveryPointsOutput } from "../models/models_0"; +import { de_ListIndexedRecoveryPointsCommand, se_ListIndexedRecoveryPointsCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListIndexedRecoveryPointsCommand}. + */ +export interface ListIndexedRecoveryPointsCommandInput extends ListIndexedRecoveryPointsInput {} +/** + * @public + * + * The output of {@link ListIndexedRecoveryPointsCommand}. + */ +export interface ListIndexedRecoveryPointsCommandOutput extends ListIndexedRecoveryPointsOutput, __MetadataBearer {} + +/** + *This operation returns a list of recovery points that have an + * associated index, belonging to the specified account.
+ *Optional parameters you can include are: MaxResults; + * NextToken; SourceResourceArns; CreatedBefore; CreatedAfter; + * and ResourceType.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, ListIndexedRecoveryPointsCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, ListIndexedRecoveryPointsCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const input = { // ListIndexedRecoveryPointsInput + * NextToken: "STRING_VALUE", + * MaxResults: Number("int"), + * SourceResourceArn: "STRING_VALUE", + * CreatedBefore: new Date("TIMESTAMP"), + * CreatedAfter: new Date("TIMESTAMP"), + * ResourceType: "STRING_VALUE", + * IndexStatus: "PENDING" || "ACTIVE" || "FAILED" || "DELETING", + * }; + * const command = new ListIndexedRecoveryPointsCommand(input); + * const response = await client.send(command); + * // { // ListIndexedRecoveryPointsOutput + * // IndexedRecoveryPoints: [ // IndexedRecoveryPointList + * // { // IndexedRecoveryPoint + * // RecoveryPointArn: "STRING_VALUE", + * // SourceResourceArn: "STRING_VALUE", + * // IamRoleArn: "STRING_VALUE", + * // BackupCreationDate: new Date("TIMESTAMP"), + * // ResourceType: "STRING_VALUE", + * // IndexCreationDate: new Date("TIMESTAMP"), + * // IndexStatus: "PENDING" || "ACTIVE" || "FAILED" || "DELETING", + * // IndexStatusMessage: "STRING_VALUE", + * // BackupVaultArn: "STRING_VALUE", + * // }, + * // ], + * // NextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListIndexedRecoveryPointsCommandInput - {@link ListIndexedRecoveryPointsCommandInput} + * @returns {@link ListIndexedRecoveryPointsCommandOutput} + * @see {@link ListIndexedRecoveryPointsCommandInput} for command's `input` shape. + * @see {@link ListIndexedRecoveryPointsCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape. + * + * @throws {@link InvalidParameterValueException} (client fault) + *Indicates that something is wrong with a parameter's value. For example, the value is + * out of range.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *A resource that is required for the action doesn't exist.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The request failed due to a temporary failure of the server.
+ * + * @throws {@link BackupServiceException} + *Base exception class for all service exceptions from Backup service.
+ * + * @public + */ +export class ListIndexedRecoveryPointsCommand extends $Command + .classBuilder< + ListIndexedRecoveryPointsCommandInput, + ListIndexedRecoveryPointsCommandOutput, + BackupClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: BackupClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("CryoControllerUserManager", "ListIndexedRecoveryPoints", {}) + .n("BackupClient", "ListIndexedRecoveryPointsCommand") + .f(void 0, void 0) + .ser(se_ListIndexedRecoveryPointsCommand) + .de(de_ListIndexedRecoveryPointsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListIndexedRecoveryPointsInput; + output: ListIndexedRecoveryPointsOutput; + }; + sdk: { + input: ListIndexedRecoveryPointsCommandInput; + output: ListIndexedRecoveryPointsCommandOutput; + }; + }; +} diff --git a/clients/client-backup/src/commands/ListRecoveryPointsByBackupVaultCommand.ts b/clients/client-backup/src/commands/ListRecoveryPointsByBackupVaultCommand.ts index 4cdbe9118bf8..77920cfca2cf 100644 --- a/clients/client-backup/src/commands/ListRecoveryPointsByBackupVaultCommand.ts +++ b/clients/client-backup/src/commands/ListRecoveryPointsByBackupVaultCommand.ts @@ -93,6 +93,8 @@ export interface ListRecoveryPointsByBackupVaultCommandOutput * // IsParent: true || false, * // ResourceName: "STRING_VALUE", * // VaultType: "BACKUP_VAULT" || "LOGICALLY_AIR_GAPPED_BACKUP_VAULT", + * // IndexStatus: "PENDING" || "ACTIVE" || "FAILED" || "DELETING", + * // IndexStatusMessage: "STRING_VALUE", * // }, * // ], * // }; diff --git a/clients/client-backup/src/commands/ListRecoveryPointsByResourceCommand.ts b/clients/client-backup/src/commands/ListRecoveryPointsByResourceCommand.ts index 358e2760263d..14035208cb63 100644 --- a/clients/client-backup/src/commands/ListRecoveryPointsByResourceCommand.ts +++ b/clients/client-backup/src/commands/ListRecoveryPointsByResourceCommand.ts @@ -68,6 +68,8 @@ export interface ListRecoveryPointsByResourceCommandOutput * // ParentRecoveryPointArn: "STRING_VALUE", * // ResourceName: "STRING_VALUE", * // VaultType: "BACKUP_VAULT" || "LOGICALLY_AIR_GAPPED_BACKUP_VAULT", + * // IndexStatus: "PENDING" || "ACTIVE" || "FAILED" || "DELETING", + * // IndexStatusMessage: "STRING_VALUE", * // }, * // ], * // }; diff --git a/clients/client-backup/src/commands/StartBackupJobCommand.ts b/clients/client-backup/src/commands/StartBackupJobCommand.ts index 5eea4e9af550..9435f9cccac9 100644 --- a/clients/client-backup/src/commands/StartBackupJobCommand.ts +++ b/clients/client-backup/src/commands/StartBackupJobCommand.ts @@ -53,6 +53,7 @@ export interface StartBackupJobCommandOutput extends StartBackupJobOutput, __Met * BackupOptions: { // BackupOptions * "This operation updates the settings of a recovery point index.
+ *Required: BackupVaultName, RecoveryPointArn, and IAMRoleArn
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, UpdateRecoveryPointIndexSettingsCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, UpdateRecoveryPointIndexSettingsCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const input = { // UpdateRecoveryPointIndexSettingsInput + * BackupVaultName: "STRING_VALUE", // required + * RecoveryPointArn: "STRING_VALUE", // required + * IamRoleArn: "STRING_VALUE", + * Index: "ENABLED" || "DISABLED", // required + * }; + * const command = new UpdateRecoveryPointIndexSettingsCommand(input); + * const response = await client.send(command); + * // { // UpdateRecoveryPointIndexSettingsOutput + * // BackupVaultName: "STRING_VALUE", + * // RecoveryPointArn: "STRING_VALUE", + * // IndexStatus: "PENDING" || "ACTIVE" || "FAILED" || "DELETING", + * // Index: "ENABLED" || "DISABLED", + * // }; + * + * ``` + * + * @param UpdateRecoveryPointIndexSettingsCommandInput - {@link UpdateRecoveryPointIndexSettingsCommandInput} + * @returns {@link UpdateRecoveryPointIndexSettingsCommandOutput} + * @see {@link UpdateRecoveryPointIndexSettingsCommandInput} for command's `input` shape. + * @see {@link UpdateRecoveryPointIndexSettingsCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape. + * + * @throws {@link InvalidParameterValueException} (client fault) + *Indicates that something is wrong with a parameter's value. For example, the value is + * out of range.
+ * + * @throws {@link InvalidRequestException} (client fault) + *Indicates that something is wrong with the input to the request. For example, a + * parameter is of the wrong type.
+ * + * @throws {@link MissingParameterValueException} (client fault) + *Indicates that a required parameter is missing.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *A resource that is required for the action doesn't exist.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The request failed due to a temporary failure of the server.
+ * + * @throws {@link BackupServiceException} + *Base exception class for all service exceptions from Backup service.
+ * + * @public + */ +export class UpdateRecoveryPointIndexSettingsCommand extends $Command + .classBuilder< + UpdateRecoveryPointIndexSettingsCommandInput, + UpdateRecoveryPointIndexSettingsCommandOutput, + BackupClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: BackupClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("CryoControllerUserManager", "UpdateRecoveryPointIndexSettings", {}) + .n("BackupClient", "UpdateRecoveryPointIndexSettingsCommand") + .f(void 0, void 0) + .ser(se_UpdateRecoveryPointIndexSettingsCommand) + .de(de_UpdateRecoveryPointIndexSettingsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UpdateRecoveryPointIndexSettingsInput; + output: UpdateRecoveryPointIndexSettingsOutput; + }; + sdk: { + input: UpdateRecoveryPointIndexSettingsCommandInput; + output: UpdateRecoveryPointIndexSettingsCommandOutput; + }; + }; +} diff --git a/clients/client-backup/src/commands/index.ts b/clients/client-backup/src/commands/index.ts index 91cacf2c0a78..e71351400ab9 100644 --- a/clients/client-backup/src/commands/index.ts +++ b/clients/client-backup/src/commands/index.ts @@ -41,6 +41,7 @@ export * from "./GetBackupSelectionCommand"; export * from "./GetBackupVaultAccessPolicyCommand"; export * from "./GetBackupVaultNotificationsCommand"; export * from "./GetLegalHoldCommand"; +export * from "./GetRecoveryPointIndexDetailsCommand"; export * from "./GetRecoveryPointRestoreMetadataCommand"; export * from "./GetRestoreJobMetadataCommand"; export * from "./GetRestoreTestingInferredMetadataCommand"; @@ -57,6 +58,7 @@ export * from "./ListBackupVaultsCommand"; export * from "./ListCopyJobSummariesCommand"; export * from "./ListCopyJobsCommand"; export * from "./ListFrameworksCommand"; +export * from "./ListIndexedRecoveryPointsCommand"; export * from "./ListLegalHoldsCommand"; export * from "./ListProtectedResourcesByBackupVaultCommand"; export * from "./ListProtectedResourcesCommand"; @@ -85,6 +87,7 @@ export * from "./UntagResourceCommand"; export * from "./UpdateBackupPlanCommand"; export * from "./UpdateFrameworkCommand"; export * from "./UpdateGlobalSettingsCommand"; +export * from "./UpdateRecoveryPointIndexSettingsCommand"; export * from "./UpdateRecoveryPointLifecycleCommand"; export * from "./UpdateRegionSettingsCommand"; export * from "./UpdateReportPlanCommand"; diff --git a/clients/client-backup/src/models/models_0.ts b/clients/client-backup/src/models/models_0.ts index c138392251c1..03860ad1018e 100644 --- a/clients/client-backup/src/models/models_0.ts +++ b/clients/client-backup/src/models/models_0.ts @@ -525,6 +525,30 @@ export interface CopyAction { DestinationBackupVaultArn: string | undefined; } +/** + *This is an optional array within a BackupRule.
+ *IndexAction consists of one ResourceTypes.
+ * @public + */ +export interface IndexAction { + /** + *0 or 1 index action will be accepted for each BackupRule.
+ *Valid values:
+ *
+ * EBS for Amazon Elastic Block Store
+ * S3 for Amazon Simple Storage Service (Amazon S3)
Specifies a scheduled task used to back up a selection of resources.
* @public @@ -626,6 +650,16 @@ export interface BackupRule { * @public */ ScheduleExpressionTimezone?: string | undefined; + + /** + *IndexActions is an array you use to specify how backup data should + * be indexed.
+ *eEach BackupRule can have 0 or 1 IndexAction, as each backup can have up + * to one index associated with it.
+ *Within the array is ResourceType. Only one will be accepted for each BackupRule.
+ * @public + */ + IndexActions?: IndexAction[] | undefined; } /** @@ -750,6 +784,25 @@ export interface BackupRuleInput { * @public */ ScheduleExpressionTimezone?: string | undefined; + + /** + *There can up to one IndexAction in each BackupRule, as each backup + * can have 0 or 1 backup index associated with it.
+ *Within the array is ResourceTypes. Only 1 resource type will + * be accepted for each BackupRule. Valid values:
+ *
+ * EBS for Amazon Elastic Block Store
+ * S3 for Amazon Simple Storage Service (Amazon S3)
This is the current status for the backup index associated with the specified recovery + * point.
+ *Statuses are: PENDING | ACTIVE | FAILED |
+ * DELETING
+ *
A recovery point with an index that has the status of ACTIVE can be
+ * included in a search.
A string in the form of a detailed message explaining the status of a backup index + * associated with the recovery point.
+ * @public + */ + IndexStatusMessage?: string | undefined; } /** @@ -5098,6 +5186,107 @@ export interface GetLegalHoldOutput { RecoveryPointSelection?: RecoveryPointSelection | undefined; } +/** + * @public + */ +export interface GetRecoveryPointIndexDetailsInput { + /** + *The name of a logical container where backups are stored. Backup vaults are identified + * by names that are unique to the account used to create them and the Region where they are + * created.
+ *Accepted characters include lowercase letters, numbers, and hyphens.
+ * @public + */ + BackupVaultName: string | undefined; + + /** + *An ARN that uniquely identifies a recovery point; for example,
+ * arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An ARN that uniquely identifies a recovery point; for example,
+ * arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An ARN that uniquely identifies the backup vault where the recovery + * point index is stored.
+ *For example,
+ * arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
A string of the Amazon Resource Name (ARN) that uniquely identifies + * the source resource.
+ * @public + */ + SourceResourceArn?: string | undefined; + + /** + *The date and time that a backup index was created, in Unix format and Coordinated
+ * Universal Time (UTC). The value of CreationDate is accurate to milliseconds.
+ * For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
+ * AM.
The date and time that a backup index was deleted, in Unix format and Coordinated
+ * Universal Time (UTC). The value of CreationDate is accurate to milliseconds.
+ * For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
+ * AM.
The date and time that a backup index finished creation, in Unix format and Coordinated
+ * Universal Time (UTC). The value of CreationDate is accurate to milliseconds.
+ * For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
+ * AM.
This is the current status for the backup index associated + * with the specified recovery point.
+ *Statuses are: PENDING | ACTIVE | FAILED | DELETING
+ *
A recovery point with an index that has the status of ACTIVE
+ * can be included in a search.
A detailed message explaining the status of a backup index associated + * with the recovery point.
+ * @public + */ + IndexStatusMessage?: string | undefined; + + /** + *Count of items within the backup index associated with the + * recovery point.
+ * @public + */ + TotalItemsIndexed?: number | undefined; +} + /** * @public */ @@ -6549,6 +6738,190 @@ export interface ListFrameworksOutput { NextToken?: string | undefined; } +/** + * @public + */ +export interface ListIndexedRecoveryPointsInput { + /** + *The next item following a partial list of returned recovery points.
+ *For example, if a request
+ * is made to return MaxResults number of indexed recovery points, NextToken
+ * allows you to return more items in your list starting at the location pointed to by the
+ * next token.
The maximum number of resource list items to be returned.
+ * @public + */ + MaxResults?: number | undefined; + + /** + *A string of the Amazon Resource Name (ARN) that uniquely identifies + * the source resource.
+ * @public + */ + SourceResourceArn?: string | undefined; + + /** + *Returns only indexed recovery points that were created before the + * specified date.
+ * @public + */ + CreatedBefore?: Date | undefined; + + /** + *Returns only indexed recovery points that were created after the + * specified date.
+ * @public + */ + CreatedAfter?: Date | undefined; + + /** + *Returns a list of indexed recovery points for the specified + * resource type(s).
+ *Accepted values include:
+ *
+ * EBS for Amazon Elastic Block Store
+ * S3 for Amazon Simple Storage Service (Amazon S3)
Include this parameter to filter the returned list by + * the indicated statuses.
+ *Accepted values: PENDING | ACTIVE | FAILED | DELETING
+ *
A recovery point with an index that has the status of ACTIVE
+ * can be included in a search.
This is a recovery point that has an associated backup index.
+ *Only recovery points with a backup index can be + * included in a search.
+ * @public + */ +export interface IndexedRecoveryPoint { + /** + *An ARN that uniquely identifies a recovery point; for example,
+ * arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
+ *
A string of the Amazon Resource Name (ARN) that uniquely identifies + * the source resource.
+ * @public + */ + SourceResourceArn?: string | undefined; + + /** + *This specifies the IAM role ARN used for this operation.
+ *For example, arn:aws:iam::123456789012:role/S3Access
+ * @public + */ + IamRoleArn?: string | undefined; + + /** + *The date and time that a backup was created, in Unix format and Coordinated
+ * Universal Time (UTC). The value of CreationDate is accurate to milliseconds.
+ * For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
+ * AM.
The resource type of the indexed recovery point.
+ *
+ * EBS for Amazon Elastic Block Store
+ * S3 for Amazon Simple Storage Service (Amazon S3)
The date and time that a backup index was created, in Unix format and Coordinated
+ * Universal Time (UTC). The value of CreationDate is accurate to milliseconds.
+ * For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
+ * AM.
This is the current status for the backup index associated + * with the specified recovery point.
+ *Statuses are: PENDING | ACTIVE | FAILED | DELETING
+ *
A recovery point with an index that has the status of ACTIVE
+ * can be included in a search.
A string in the form of a detailed message explaining the status of a backup index associated + * with the recovery point.
+ * @public + */ + IndexStatusMessage?: string | undefined; + + /** + *An ARN that uniquely identifies the backup vault where the recovery + * point index is stored.
+ *For example,
+ * arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
This is a list of recovery points that have an + * associated index, belonging to the specified account.
+ * @public + */ + IndexedRecoveryPoints?: IndexedRecoveryPoint[] | undefined; + + /** + *The next item following a partial list of returned recovery points.
+ *For example, if a request
+ * is made to return MaxResults number of indexed recovery points, NextToken
+ * allows you to return more items in your list starting at the location pointed to by the
+ * next token.
This is the current status for the backup index associated + * with the specified recovery point.
+ *Statuses are: PENDING | ACTIVE | FAILED |
+ * DELETING
+ *
A recovery point with an index that has the status of ACTIVE
+ * can be included in a search.
A string in the form of a detailed message explaining the status of a backup index associated + * with the recovery point.
+ * @public + */ + IndexStatusMessage?: string | undefined; } /** @@ -7340,6 +7732,24 @@ export interface RecoveryPointByResource { * @public */ VaultType?: VaultType | undefined; + + /** + *This is the current status for the backup index associated + * with the specified recovery point.
+ *Statuses are: PENDING | ACTIVE | FAILED | DELETING
+ *
A recovery point with an index that has the status of ACTIVE
+ * can be included in a search.
A string in the form of a detailed message explaining the status of a backup index + * associated with the recovery point.
+ * @public + */ + IndexStatusMessage?: string | undefined; } /** @@ -8486,6 +8896,20 @@ export interface PutRestoreValidationResultInput { ValidationStatusMessage?: string | undefined; } +/** + * @public + * @enum + */ +export const Index = { + DISABLED: "DISABLED", + ENABLED: "ENABLED", +} as const; + +/** + * @public + */ +export type Index = (typeof Index)[keyof typeof Index]; + /** * @public */ @@ -8579,6 +9003,29 @@ export interface StartBackupJobInput { * @public */ BackupOptions?: RecordInclude this parameter to enable index creation if your backup + * job has a resource type that supports backup indexes.
+ *Resource types that support backup indexes include:
+ *
+ * EBS for Amazon Elastic Block Store
+ * S3 for Amazon Simple Storage Service (Amazon S3)
Index can have 1 of 2 possible values, either ENABLED or
+ * DISABLED.
To create a backup index for an eligible ACTIVE recovery point
+ * that does not yet have a backup index, set value to ENABLED.
To delete a backup index, set value to DISABLED.
The name of a logical container where backups are stored. Backup vaults are identified + * by names that are unique to the account used to create them and the Region where they are + * created.
+ *Accepted characters include lowercase letters, numbers, and hyphens.
+ * @public + */ + BackupVaultName: string | undefined; + + /** + *An ARN that uniquely identifies a recovery point; for example,
+ * arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
This specifies the IAM role ARN used for this operation.
+ *For example, arn:aws:iam::123456789012:role/S3Access
+ * @public + */ + IamRoleArn?: string | undefined; + + /** + *Index can have 1 of 2 possible values, either ENABLED or
+ * DISABLED.
To create a backup index for an eligible ACTIVE recovery point
+ * that does not yet have a backup index, set value to ENABLED.
To delete a backup index, set value to DISABLED.
The name of a logical container where backups are stored. Backup vaults are identified + * by names that are unique to the account used to create them and the Region where they are + * created.
+ * @public + */ + BackupVaultName?: string | undefined; + + /** + *An ARN that uniquely identifies a recovery point; for example,
+ * arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
This is the current status for the backup index associated + * with the specified recovery point.
+ *Statuses are: PENDING | ACTIVE | FAILED | DELETING
+ *
A recovery point with an index that has the status of ACTIVE
+ * can be included in a search.
Index can have 1 of 2 possible values, either ENABLED or
+ * DISABLED.
A value of ENABLED means a backup index for an eligible ACTIVE
+ * recovery point has been created.
A value of DISABLED means a backup index was deleted.
The timezone in which the schedule expression is set. By default, \n ScheduleExpressions are in UTC. You can modify this to a specified timezone.
" } + }, + "IndexActions": { + "target": "com.amazonaws.backup#IndexActions", + "traits": { + "smithy.api#documentation": "IndexActions is an array you use to specify how backup data should \n be indexed.
\neEach BackupRule can have 0 or 1 IndexAction, as each backup can have up \n to one index associated with it.
\nWithin the array is ResourceType. Only one will be accepted for each BackupRule.
" + } } }, "traits": { @@ -813,6 +819,12 @@ "traits": { "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.
" } + }, + "IndexActions": { + "target": "com.amazonaws.backup#IndexActions", + "traits": { + "smithy.api#documentation": "There can up to one IndexAction in each BackupRule, as each backup \n can have 0 or 1 backup index associated with it.
\nWithin the array is ResourceTypes. Only 1 resource type will \n be accepted for each BackupRule. Valid values:
\n\n EBS for Amazon Elastic Block Store
\n S3 for Amazon Simple Storage Service (Amazon S3)
The type of vault in which the described recovery point is stored.
" } + }, + "IndexStatus": { + "target": "com.amazonaws.backup#IndexStatus", + "traits": { + "smithy.api#documentation": "This is the current status for the backup index associated with the specified recovery\n point.
\nStatuses are: PENDING | ACTIVE | FAILED |\n DELETING\n
A recovery point with an index that has the status of ACTIVE can be\n included in a search.
A string in the form of a detailed message explaining the status of a backup index\n associated with the recovery point.
" + } } }, "traits": { @@ -6717,6 +6750,124 @@ "smithy.api#output": {} } }, + "com.amazonaws.backup#GetRecoveryPointIndexDetails": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#GetRecoveryPointIndexDetailsInput" + }, + "output": { + "target": "com.amazonaws.backup#GetRecoveryPointIndexDetailsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "This operation returns the metadata and details specific to \n the backup index associated with the specified recovery point.
", + "smithy.api#http": { + "method": "GET", + "uri": "/backup-vaults/{BackupVaultName}/recovery-points/{RecoveryPointArn}/index", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.backup#GetRecoveryPointIndexDetailsInput": { + "type": "structure", + "members": { + "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.
\nAccepted characters include lowercase letters, numbers, and hyphens.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RecoveryPointArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An ARN that uniquely identifies the backup vault where the recovery \n point index is stored.
\nFor example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
A string of the Amazon Resource Name (ARN) that uniquely identifies \n the source resource.
" + } + }, + "IndexCreationDate": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "The date and time that a backup index was created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.
The date and time that a backup index was deleted, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.
The date and time that a backup index finished creation, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.
This is the current status for the backup index associated \n with the specified recovery point.
\nStatuses are: PENDING | ACTIVE | FAILED | DELETING\n
A recovery point with an index that has the status of ACTIVE \n can be included in a search.
A detailed message explaining the status of a backup index associated \n with the recovery point.
" + } + }, + "TotalItemsIndexed": { + "target": "com.amazonaws.backup#Long", + "traits": { + "smithy.api#documentation": "Count of items within the backup index associated with the \n recovery point.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.backup#GetRecoveryPointRestoreMetadata": { "type": "operation", "input": { @@ -7133,6 +7284,140 @@ "com.amazonaws.backup#IAMRoleArn": { "type": "string" }, + "com.amazonaws.backup#Index": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.backup#IndexAction": { + "type": "structure", + "members": { + "ResourceTypes": { + "target": "com.amazonaws.backup#ResourceTypes", + "traits": { + "smithy.api#documentation": "0 or 1 index action will be accepted for each BackupRule.
\nValid values:
\n\n EBS for Amazon Elastic Block Store
\n S3 for Amazon Simple Storage Service (Amazon S3)
This is an optional array within a BackupRule.
\nIndexAction consists of one ResourceTypes.
" + } + }, + "com.amazonaws.backup#IndexActions": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#IndexAction" + } + }, + "com.amazonaws.backup#IndexStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } + } + }, + "com.amazonaws.backup#IndexedRecoveryPoint": { + "type": "structure", + "members": { + "RecoveryPointArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45\n
A string of the Amazon Resource Name (ARN) that uniquely identifies \n the source resource.
" + } + }, + "IamRoleArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "This specifies the IAM role ARN used for this operation.
\nFor example, arn:aws:iam::123456789012:role/S3Access
" + } + }, + "BackupCreationDate": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "The date and time that a backup was created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.
The resource type of the indexed recovery point.
\n\n EBS for Amazon Elastic Block Store
\n S3 for Amazon Simple Storage Service (Amazon S3)
The date and time that a backup index was created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.
This is the current status for the backup index associated \n with the specified recovery point.
\nStatuses are: PENDING | ACTIVE | FAILED | DELETING\n
A recovery point with an index that has the status of ACTIVE \n can be included in a search.
A string in the form of a detailed message explaining the status of a backup index associated \n with the recovery point.
" + } + }, + "BackupVaultArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "An ARN that uniquely identifies the backup vault where the recovery \n point index is stored.
\nFor example,\n arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
This is a recovery point that has an associated backup index.
\nOnly recovery points with a backup index can be \n included in a search.
" + } + }, + "com.amazonaws.backup#IndexedRecoveryPointList": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#IndexedRecoveryPoint" + } + }, "com.amazonaws.backup#InvalidParameterValueException": { "type": "structure", "members": { @@ -8422,6 +8707,118 @@ "smithy.api#output": {} } }, + "com.amazonaws.backup#ListIndexedRecoveryPoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#ListIndexedRecoveryPointsInput" + }, + "output": { + "target": "com.amazonaws.backup#ListIndexedRecoveryPointsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "This operation returns a list of recovery points that have an \n associated index, belonging to the specified account.
\nOptional parameters you can include are: MaxResults; \n NextToken; SourceResourceArns; CreatedBefore; CreatedAfter; \n and ResourceType.
", + "smithy.api#http": { + "method": "GET", + "uri": "/indexes/recovery-point", + "code": 200 + }, + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IndexedRecoveryPoints", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.backup#ListIndexedRecoveryPointsInput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "The next item following a partial list of returned recovery points.
\nFor example, if a request\n is made to return MaxResults number of indexed recovery points, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.
The maximum number of resource list items to be returned.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "SourceResourceArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "A string of the Amazon Resource Name (ARN) that uniquely identifies \n the source resource.
", + "smithy.api#httpQuery": "sourceResourceArn" + } + }, + "CreatedBefore": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "Returns only indexed recovery points that were created before the \n specified date.
", + "smithy.api#httpQuery": "createdBefore" + } + }, + "CreatedAfter": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "Returns only indexed recovery points that were created after the \n specified date.
", + "smithy.api#httpQuery": "createdAfter" + } + }, + "ResourceType": { + "target": "com.amazonaws.backup#ResourceType", + "traits": { + "smithy.api#documentation": "Returns a list of indexed recovery points for the specified \n resource type(s).
\nAccepted values include:
\n\n EBS for Amazon Elastic Block Store
\n S3 for Amazon Simple Storage Service (Amazon S3)
Include this parameter to filter the returned list by \n the indicated statuses.
\nAccepted values: PENDING | ACTIVE | FAILED | DELETING\n
A recovery point with an index that has the status of ACTIVE \n can be included in a search.
This is a list of recovery points that have an \n associated index, belonging to the specified account.
" + } + }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "The next item following a partial list of returned recovery points.
\nFor example, if a request\n is made to return MaxResults number of indexed recovery points, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.
The type of vault in which the described recovery point is stored.
" } + }, + "IndexStatus": { + "target": "com.amazonaws.backup#IndexStatus", + "traits": { + "smithy.api#documentation": "This is the current status for the backup index associated \n with the specified recovery point.
\nStatuses are: PENDING | ACTIVE | FAILED |\n DELETING\n
A recovery point with an index that has the status of ACTIVE \n can be included in a search.
A string in the form of a detailed message explaining the status of a backup index associated \n with the recovery point.
" + } } }, "traits": { @@ -10397,6 +10806,18 @@ "traits": { "smithy.api#documentation": "The type of vault in which the described recovery point is \n stored.
" } + }, + "IndexStatus": { + "target": "com.amazonaws.backup#IndexStatus", + "traits": { + "smithy.api#documentation": "This is the current status for the backup index associated \n with the specified recovery point.
\nStatuses are: PENDING | ACTIVE | FAILED | DELETING\n
A recovery point with an index that has the status of ACTIVE \n can be included in a search.
A string in the form of a detailed message explaining the status of a backup index\n associated with the recovery point.
" + } } }, "traits": { @@ -11851,6 +12272,12 @@ "traits": { "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.
\nValid 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.
Include this parameter to enable index creation if your backup \n job has a resource type that supports backup indexes.
\nResource types that support backup indexes include:
\n\n EBS for Amazon Elastic Block Store
\n S3 for Amazon Simple Storage Service (Amazon S3)
Index can have 1 of 2 possible values, either ENABLED or \n DISABLED.
To create a backup index for an eligible ACTIVE recovery point \n that does not yet have a backup index, set value to ENABLED.
To delete a backup index, set value to DISABLED.
This operation updates the settings of a recovery point index.
\nRequired: BackupVaultName, RecoveryPointArn, and IAMRoleArn
", + "smithy.api#http": { + "method": "POST", + "uri": "/backup-vaults/{BackupVaultName}/recovery-points/{RecoveryPointArn}/index", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.backup#UpdateRecoveryPointIndexSettingsInput": { + "type": "structure", + "members": { + "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.
\nAccepted characters include lowercase letters, numbers, and hyphens.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RecoveryPointArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
This specifies the IAM role ARN used for this operation.
\nFor example, arn:aws:iam::123456789012:role/S3Access
" + } + }, + "Index": { + "target": "com.amazonaws.backup#Index", + "traits": { + "smithy.api#documentation": "Index can have 1 of 2 possible values, either ENABLED or \n DISABLED.
To create a backup index for an eligible ACTIVE recovery point \n that does not yet have a backup index, set value to ENABLED.
To delete a backup index, set value to DISABLED.
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.
" + } + }, + "RecoveryPointArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
This is the current status for the backup index associated \n with the specified recovery point.
\nStatuses are: PENDING | ACTIVE | FAILED | DELETING\n
A recovery point with an index that has the status of ACTIVE \n can be included in a search.
Index can have 1 of 2 possible values, either ENABLED or\n DISABLED.
A value of ENABLED means a backup index for an eligible ACTIVE\n recovery point has been created.
A value of DISABLED means a backup index was deleted.