@aws-sdk/client-backup 3.449.0 → 3.451.0

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

@@ -0,0 +1,106 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupClient";
+import { ListBackupJobSummariesInput, ListBackupJobSummariesOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListBackupJobSummariesCommand}.
+ */
+export interface ListBackupJobSummariesCommandInput extends ListBackupJobSummariesInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListBackupJobSummariesCommand}.
+ */
+export interface ListBackupJobSummariesCommandOutput extends ListBackupJobSummariesOutput, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>This is a request for a summary of backup jobs created
+ *          or running within the most recent 30 days. You can
+ *          include parameters AccountID, State, ResourceType, MessageCategory,
+ *          AggregationPeriod, MaxResults, or NextToken to filter
+ *          results.</p>
+ *          <p>This request returns a summary that contains
+ *          Region, Account, State, ResourceType, MessageCategory,
+ *          StartTime, EndTime, and Count of included jobs.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BackupClient, ListBackupJobSummariesCommand } from "@aws-sdk/client-backup"; // ES Modules import
+ * // const { BackupClient, ListBackupJobSummariesCommand } = require("@aws-sdk/client-backup"); // CommonJS import
+ * const client = new BackupClient(config);
+ * const input = { // ListBackupJobSummariesInput
+ *   AccountId: "STRING_VALUE",
+ *   State: "CREATED" || "PENDING" || "RUNNING" || "ABORTING" || "ABORTED" || "COMPLETED" || "FAILED" || "EXPIRED" || "PARTIAL" || "AGGREGATE_ALL" || "ANY",
+ *   ResourceType: "STRING_VALUE",
+ *   MessageCategory: "STRING_VALUE",
+ *   AggregationPeriod: "ONE_DAY" || "SEVEN_DAYS" || "FOURTEEN_DAYS",
+ *   MaxResults: Number("int"),
+ *   NextToken: "STRING_VALUE",
+ * };
+ * const command = new ListBackupJobSummariesCommand(input);
+ * const response = await client.send(command);
+ * // { // ListBackupJobSummariesOutput
+ * //   BackupJobSummaries: [ // BackupJobSummaryList
+ * //     { // BackupJobSummary
+ * //       Region: "STRING_VALUE",
+ * //       AccountId: "STRING_VALUE",
+ * //       State: "CREATED" || "PENDING" || "RUNNING" || "ABORTING" || "ABORTED" || "COMPLETED" || "FAILED" || "EXPIRED" || "PARTIAL" || "AGGREGATE_ALL" || "ANY",
+ * //       ResourceType: "STRING_VALUE",
+ * //       MessageCategory: "STRING_VALUE",
+ * //       Count: Number("int"),
+ * //       StartTime: new Date("TIMESTAMP"),
+ * //       EndTime: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   AggregationPeriod: "STRING_VALUE",
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListBackupJobSummariesCommandInput - {@link ListBackupJobSummariesCommandInput}
+ * @returns {@link ListBackupJobSummariesCommandOutput}
+ * @see {@link ListBackupJobSummariesCommandInput} for command's `input` shape.
+ * @see {@link ListBackupJobSummariesCommandOutput} 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 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>
+ *
+ */
+export declare class ListBackupJobSummariesCommand extends $Command<ListBackupJobSummariesCommandInput, ListBackupJobSummariesCommandOutput, BackupClientResolvedConfig> {
+    readonly input: ListBackupJobSummariesCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: ListBackupJobSummariesCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BackupClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListBackupJobSummariesCommandInput, ListBackupJobSummariesCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -44,6 +44,7 @@ export interface ListBackupJobsCommandOutput extends ListBackupJobsOutput, __Met
  *   ByCompleteAfter: new Date("TIMESTAMP"),
  *   ByCompleteBefore: new Date("TIMESTAMP"),
  *   ByParentJobId: "STRING_VALUE",
+ *   ByMessageCategory: "STRING_VALUE",
  * };
  * const command = new ListBackupJobsCommand(input);
  * const response = await client.send(command);
@@ -80,6 +81,7 @@ export interface ListBackupJobsCommandOutput extends ListBackupJobsOutput, __Met
  * //       ParentJobId: "STRING_VALUE",
  * //       IsParent: true || false,
  * //       ResourceName: "STRING_VALUE",
+ * //       MessageCategory: "STRING_VALUE",
  * //     },
  * //   ],
  * //   NextToken: "STRING_VALUE",

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

@@ -0,0 +1,106 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupClient";
+import { ListCopyJobSummariesInput, ListCopyJobSummariesOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListCopyJobSummariesCommand}.
+ */
+export interface ListCopyJobSummariesCommandInput extends ListCopyJobSummariesInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListCopyJobSummariesCommand}.
+ */
+export interface ListCopyJobSummariesCommandOutput extends ListCopyJobSummariesOutput, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>This request obtains a list of copy jobs created
+ *          or running within the the most recent 30 days. You can
+ *          include parameters AccountID, State, ResourceType, MessageCategory,
+ *          AggregationPeriod, MaxResults, or NextToken to filter
+ *          results.</p>
+ *          <p>This request returns a summary that contains
+ *          Region, Account, State, RestourceType, MessageCategory,
+ *          StartTime, EndTime, and Count of included jobs.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BackupClient, ListCopyJobSummariesCommand } from "@aws-sdk/client-backup"; // ES Modules import
+ * // const { BackupClient, ListCopyJobSummariesCommand } = require("@aws-sdk/client-backup"); // CommonJS import
+ * const client = new BackupClient(config);
+ * const input = { // ListCopyJobSummariesInput
+ *   AccountId: "STRING_VALUE",
+ *   State: "CREATED" || "RUNNING" || "ABORTING" || "ABORTED" || "COMPLETING" || "COMPLETED" || "FAILING" || "FAILED" || "PARTIAL" || "AGGREGATE_ALL" || "ANY",
+ *   ResourceType: "STRING_VALUE",
+ *   MessageCategory: "STRING_VALUE",
+ *   AggregationPeriod: "ONE_DAY" || "SEVEN_DAYS" || "FOURTEEN_DAYS",
+ *   MaxResults: Number("int"),
+ *   NextToken: "STRING_VALUE",
+ * };
+ * const command = new ListCopyJobSummariesCommand(input);
+ * const response = await client.send(command);
+ * // { // ListCopyJobSummariesOutput
+ * //   CopyJobSummaries: [ // CopyJobSummaryList
+ * //     { // CopyJobSummary
+ * //       Region: "STRING_VALUE",
+ * //       AccountId: "STRING_VALUE",
+ * //       State: "CREATED" || "RUNNING" || "ABORTING" || "ABORTED" || "COMPLETING" || "COMPLETED" || "FAILING" || "FAILED" || "PARTIAL" || "AGGREGATE_ALL" || "ANY",
+ * //       ResourceType: "STRING_VALUE",
+ * //       MessageCategory: "STRING_VALUE",
+ * //       Count: Number("int"),
+ * //       StartTime: new Date("TIMESTAMP"),
+ * //       EndTime: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   AggregationPeriod: "STRING_VALUE",
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListCopyJobSummariesCommandInput - {@link ListCopyJobSummariesCommandInput}
+ * @returns {@link ListCopyJobSummariesCommandOutput}
+ * @see {@link ListCopyJobSummariesCommandInput} for command's `input` shape.
+ * @see {@link ListCopyJobSummariesCommandOutput} 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 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>
+ *
+ */
+export declare class ListCopyJobSummariesCommand extends $Command<ListCopyJobSummariesCommandInput, ListCopyJobSummariesCommandOutput, BackupClientResolvedConfig> {
+    readonly input: ListCopyJobSummariesCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: ListCopyJobSummariesCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BackupClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListCopyJobSummariesCommandInput, ListCopyJobSummariesCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -43,6 +43,7 @@ export interface ListCopyJobsCommandOutput extends ListCopyJobsOutput, __Metadat
  *   ByCompleteBefore: new Date("TIMESTAMP"),
  *   ByCompleteAfter: new Date("TIMESTAMP"),
  *   ByParentJobId: "STRING_VALUE",
+ *   ByMessageCategory: "STRING_VALUE",
  * };
  * const command = new ListCopyJobsCommand(input);
  * const response = await client.send(command);
@@ -77,6 +78,7 @@ export interface ListCopyJobsCommandOutput extends ListCopyJobsOutput, __Metadat
  * //         "<keys>": Number("long"),
  * //       },
  * //       ResourceName: "STRING_VALUE",
+ * //       MessageCategory: "STRING_VALUE",
  * //     },
  * //   ],
  * //   NextToken: "STRING_VALUE",

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

@@ -0,0 +1,104 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { BackupClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupClient";
+import { ListRestoreJobSummariesInput, ListRestoreJobSummariesOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListRestoreJobSummariesCommand}.
+ */
+export interface ListRestoreJobSummariesCommandInput extends ListRestoreJobSummariesInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListRestoreJobSummariesCommand}.
+ */
+export interface ListRestoreJobSummariesCommandOutput extends ListRestoreJobSummariesOutput, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>This request obtains a summary of restore jobs created
+ *          or running within the the most recent 30 days. You can
+ *          include parameters AccountID, State, ResourceType,
+ *          AggregationPeriod, MaxResults, or NextToken to filter
+ *          results.</p>
+ *          <p>This request returns a summary that contains
+ *          Region, Account, State, RestourceType, MessageCategory,
+ *          StartTime, EndTime, and Count of included jobs.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BackupClient, ListRestoreJobSummariesCommand } from "@aws-sdk/client-backup"; // ES Modules import
+ * // const { BackupClient, ListRestoreJobSummariesCommand } = require("@aws-sdk/client-backup"); // CommonJS import
+ * const client = new BackupClient(config);
+ * const input = { // ListRestoreJobSummariesInput
+ *   AccountId: "STRING_VALUE",
+ *   State: "CREATED" || "PENDING" || "RUNNING" || "ABORTED" || "COMPLETED" || "FAILED" || "AGGREGATE_ALL" || "ANY",
+ *   ResourceType: "STRING_VALUE",
+ *   AggregationPeriod: "ONE_DAY" || "SEVEN_DAYS" || "FOURTEEN_DAYS",
+ *   MaxResults: Number("int"),
+ *   NextToken: "STRING_VALUE",
+ * };
+ * const command = new ListRestoreJobSummariesCommand(input);
+ * const response = await client.send(command);
+ * // { // ListRestoreJobSummariesOutput
+ * //   RestoreJobSummaries: [ // RestoreJobSummaryList
+ * //     { // RestoreJobSummary
+ * //       Region: "STRING_VALUE",
+ * //       AccountId: "STRING_VALUE",
+ * //       State: "CREATED" || "PENDING" || "RUNNING" || "ABORTED" || "COMPLETED" || "FAILED" || "AGGREGATE_ALL" || "ANY",
+ * //       ResourceType: "STRING_VALUE",
+ * //       Count: Number("int"),
+ * //       StartTime: new Date("TIMESTAMP"),
+ * //       EndTime: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   AggregationPeriod: "STRING_VALUE",
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListRestoreJobSummariesCommandInput - {@link ListRestoreJobSummariesCommandInput}
+ * @returns {@link ListRestoreJobSummariesCommandOutput}
+ * @see {@link ListRestoreJobSummariesCommandInput} for command's `input` shape.
+ * @see {@link ListRestoreJobSummariesCommandOutput} 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 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>
+ *
+ */
+export declare class ListRestoreJobSummariesCommand extends $Command<ListRestoreJobSummariesCommandInput, ListRestoreJobSummariesCommandOutput, BackupClientResolvedConfig> {
+    readonly input: ListRestoreJobSummariesCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: ListRestoreJobSummariesCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BackupClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListRestoreJobSummariesCommandInput, ListRestoreJobSummariesCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -38,12 +38,14 @@ export * from "./GetBackupVaultNotificationsCommand";
 export * from "./GetLegalHoldCommand";
 export * from "./GetRecoveryPointRestoreMetadataCommand";
 export * from "./GetSupportedResourceTypesCommand";
+export * from "./ListBackupJobSummariesCommand";
 export * from "./ListBackupJobsCommand";
 export * from "./ListBackupPlanTemplatesCommand";
 export * from "./ListBackupPlanVersionsCommand";
 export * from "./ListBackupPlansCommand";
 export * from "./ListBackupSelectionsCommand";
 export * from "./ListBackupVaultsCommand";
+export * from "./ListCopyJobSummariesCommand";
 export * from "./ListCopyJobsCommand";
 export * from "./ListFrameworksCommand";
 export * from "./ListLegalHoldsCommand";
@@ -54,6 +56,7 @@ export * from "./ListRecoveryPointsByLegalHoldCommand";
 export * from "./ListRecoveryPointsByResourceCommand";
 export * from "./ListReportJobsCommand";
 export * from "./ListReportPlansCommand";
+export * from "./ListRestoreJobSummariesCommand";
 export * from "./ListRestoreJobsCommand";
 export * from "./ListTagsCommand";
 export * from "./PutBackupVaultAccessPolicyCommand";