@aws-sdk/client-backup 3.713.0 → 3.714.0

package/dist-types/commands/GetRecoveryPointIndexDetailsCommand.d.ts

@@ -0,0 +1,94 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupClient";
+import { GetRecoveryPointIndexDetailsInput, GetRecoveryPointIndexDetailsOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetRecoveryPointIndexDetailsCommand}.
+ */
+export interface GetRecoveryPointIndexDetailsCommandInput extends GetRecoveryPointIndexDetailsInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetRecoveryPointIndexDetailsCommand}.
+ */
+export interface GetRecoveryPointIndexDetailsCommandOutput extends GetRecoveryPointIndexDetailsOutput, __MetadataBearer {
+}
+declare const GetRecoveryPointIndexDetailsCommand_base: {
+    new (input: GetRecoveryPointIndexDetailsCommandInput): import("@smithy/smithy-client").CommandImpl<GetRecoveryPointIndexDetailsCommandInput, GetRecoveryPointIndexDetailsCommandOutput, BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetRecoveryPointIndexDetailsCommandInput): import("@smithy/smithy-client").CommandImpl<GetRecoveryPointIndexDetailsCommandInput, GetRecoveryPointIndexDetailsCommandOutput, BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>This operation returns the metadata and details specific to
+ *          the backup index associated with the specified recovery point.</p>
+ * @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)
+ *  <p>Indicates that something is wrong with a parameter's value. For example, the value is
+ *          out of range.</p>
+ *
+ * @throws {@link MissingParameterValueException} (client fault)
+ *  <p>Indicates that a required parameter is missing.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>A resource that is required for the action doesn't exist.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The request failed due to a temporary failure of the server.</p>
+ *
+ * @throws {@link BackupServiceException}
+ * <p>Base exception class for all service exceptions from Backup service.</p>
+ *
+ * @public
+ */
+export declare class GetRecoveryPointIndexDetailsCommand extends GetRecoveryPointIndexDetailsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetRecoveryPointIndexDetailsInput;
+            output: GetRecoveryPointIndexDetailsOutput;
+        };
+        sdk: {
+            input: GetRecoveryPointIndexDetailsCommandInput;
+            output: GetRecoveryPointIndexDetailsCommandOutput;
+        };
+    };
+}

package/dist-types/commands/ListIndexedRecoveryPointsCommand.d.ts

@@ -0,0 +1,104 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupClient";
+import { ListIndexedRecoveryPointsInput, ListIndexedRecoveryPointsOutput } from "../models/models_0";
+/**
+ * @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 {
+}
+declare const ListIndexedRecoveryPointsCommand_base: {
+    new (input: ListIndexedRecoveryPointsCommandInput): import("@smithy/smithy-client").CommandImpl<ListIndexedRecoveryPointsCommandInput, ListIndexedRecoveryPointsCommandOutput, BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [ListIndexedRecoveryPointsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListIndexedRecoveryPointsCommandInput, ListIndexedRecoveryPointsCommandOutput, BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>This operation returns a list of recovery points that have an
+ *          associated index, belonging to the specified account.</p>
+ *          <p>Optional parameters you can include are: MaxResults;
+ *          NextToken; SourceResourceArns; CreatedBefore; CreatedAfter;
+ *          and ResourceType.</p>
+ * @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)
+ *  <p>Indicates that something is wrong with a parameter's value. For example, the value is
+ *          out of range.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>A resource that is required for the action doesn't exist.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The request failed due to a temporary failure of the server.</p>
+ *
+ * @throws {@link BackupServiceException}
+ * <p>Base exception class for all service exceptions from Backup service.</p>
+ *
+ * @public
+ */
+export declare class ListIndexedRecoveryPointsCommand extends ListIndexedRecoveryPointsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListIndexedRecoveryPointsInput;
+            output: ListIndexedRecoveryPointsOutput;
+        };
+        sdk: {
+            input: ListIndexedRecoveryPointsCommandInput;
+            output: ListIndexedRecoveryPointsCommandOutput;
+        };
+    };
+}

package/dist-types/commands/ListRecoveryPointsByBackupVaultCommand.d.ts

@@ -87,6 +87,8 @@ declare const ListRecoveryPointsByBackupVaultCommand_base: {
  * //       IsParent: true || false,
  * //       ResourceName: "STRING_VALUE",
  * //       VaultType: "BACKUP_VAULT" || "LOGICALLY_AIR_GAPPED_BACKUP_VAULT",
+ * //       IndexStatus: "PENDING" || "ACTIVE" || "FAILED" || "DELETING",
+ * //       IndexStatusMessage: "STRING_VALUE",
  * //     },
  * //   ],
  * // };

package/dist-types/commands/ListRecoveryPointsByResourceCommand.d.ts

@@ -62,6 +62,8 @@ declare const ListRecoveryPointsByResourceCommand_base: {
  * //       ParentRecoveryPointArn: "STRING_VALUE",
  * //       ResourceName: "STRING_VALUE",
  * //       VaultType: "BACKUP_VAULT" || "LOGICALLY_AIR_GAPPED_BACKUP_VAULT",
+ * //       IndexStatus: "PENDING" || "ACTIVE" || "FAILED" || "DELETING",
+ * //       IndexStatusMessage: "STRING_VALUE",
  * //     },
  * //   ],
  * // };

package/dist-types/commands/StartBackupJobCommand.d.ts

@@ -52,6 +52,7 @@ declare const StartBackupJobCommand_base: {
  *   BackupOptions: { // BackupOptions
  *     "<keys>": "STRING_VALUE",
  *   },
+ *   Index: "ENABLED" || "DISABLED",
  * };
  * const command = new StartBackupJobCommand(input);
  * const response = await client.send(command);

package/dist-types/commands/UpdateBackupPlanCommand.d.ts

@@ -65,6 +65,13 @@ declare const UpdateBackupPlanCommand_base: {
  *         ],
  *         EnableContinuousBackup: true || false,
  *         ScheduleExpressionTimezone: "STRING_VALUE",
+ *         IndexActions: [ // IndexActions
+ *           { // IndexAction
+ *             ResourceTypes: [ // ResourceTypes
+ *               "STRING_VALUE",
+ *             ],
+ *           },
+ *         ],
  *       },
  *     ],
  *     AdvancedBackupSettings: [ // AdvancedBackupSettings

package/dist-types/commands/UpdateRecoveryPointIndexSettingsCommand.d.ts

@@ -0,0 +1,95 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupClient";
+import { UpdateRecoveryPointIndexSettingsInput, UpdateRecoveryPointIndexSettingsOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateRecoveryPointIndexSettingsCommand}.
+ */
+export interface UpdateRecoveryPointIndexSettingsCommandInput extends UpdateRecoveryPointIndexSettingsInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateRecoveryPointIndexSettingsCommand}.
+ */
+export interface UpdateRecoveryPointIndexSettingsCommandOutput extends UpdateRecoveryPointIndexSettingsOutput, __MetadataBearer {
+}
+declare const UpdateRecoveryPointIndexSettingsCommand_base: {
+    new (input: UpdateRecoveryPointIndexSettingsCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateRecoveryPointIndexSettingsCommandInput, UpdateRecoveryPointIndexSettingsCommandOutput, BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateRecoveryPointIndexSettingsCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateRecoveryPointIndexSettingsCommandInput, UpdateRecoveryPointIndexSettingsCommandOutput, BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>This operation updates the settings of a recovery point index.</p>
+ *          <p>Required: BackupVaultName, RecoveryPointArn, and IAMRoleArn</p>
+ * @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)
+ *  <p>Indicates that something is wrong with a parameter's value. For example, the value is
+ *          out of range.</p>
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  <p>Indicates that something is wrong with the input to the request. For example, a
+ *          parameter is of the wrong type.</p>
+ *
+ * @throws {@link MissingParameterValueException} (client fault)
+ *  <p>Indicates that a required parameter is missing.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>A resource that is required for the action doesn't exist.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The request failed due to a temporary failure of the server.</p>
+ *
+ * @throws {@link BackupServiceException}
+ * <p>Base exception class for all service exceptions from Backup service.</p>
+ *
+ * @public
+ */
+export declare class UpdateRecoveryPointIndexSettingsCommand extends UpdateRecoveryPointIndexSettingsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateRecoveryPointIndexSettingsInput;
+            output: UpdateRecoveryPointIndexSettingsOutput;
+        };
+        sdk: {
+            input: UpdateRecoveryPointIndexSettingsCommandInput;
+            output: UpdateRecoveryPointIndexSettingsCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -40,6 +40,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";
@@ -56,6 +57,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";
@@ -84,6 +86,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";