@aws-sdk/client-backupsearch 3.714.0

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

@@ -0,0 +1,187 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupSearchClient";
+import { GetSearchJobInput, GetSearchJobOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetSearchJobCommand}.
+ */
+export interface GetSearchJobCommandInput extends GetSearchJobInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetSearchJobCommand}.
+ */
+export interface GetSearchJobCommandOutput extends GetSearchJobOutput, __MetadataBearer {
+}
+declare const GetSearchJobCommand_base: {
+    new (input: GetSearchJobCommandInput): import("@smithy/smithy-client").CommandImpl<GetSearchJobCommandInput, GetSearchJobCommandOutput, BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetSearchJobCommandInput): import("@smithy/smithy-client").CommandImpl<GetSearchJobCommandInput, GetSearchJobCommandOutput, BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>This operation retrieves metadata of a search job,
+ *       including its progress.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BackupSearchClient, GetSearchJobCommand } from "@aws-sdk/client-backupsearch"; // ES Modules import
+ * // const { BackupSearchClient, GetSearchJobCommand } = require("@aws-sdk/client-backupsearch"); // CommonJS import
+ * const client = new BackupSearchClient(config);
+ * const input = { // GetSearchJobInput
+ *   SearchJobIdentifier: "STRING_VALUE", // required
+ * };
+ * const command = new GetSearchJobCommand(input);
+ * const response = await client.send(command);
+ * // { // GetSearchJobOutput
+ * //   Name: "STRING_VALUE",
+ * //   SearchScopeSummary: { // SearchScopeSummary
+ * //     TotalRecoveryPointsToScanCount: Number("int"),
+ * //     TotalItemsToScanCount: Number("long"),
+ * //   },
+ * //   CurrentSearchProgress: { // CurrentSearchProgress
+ * //     RecoveryPointsScannedCount: Number("int"),
+ * //     ItemsScannedCount: Number("long"),
+ * //     ItemsMatchedCount: Number("long"),
+ * //   },
+ * //   StatusMessage: "STRING_VALUE",
+ * //   EncryptionKeyArn: "STRING_VALUE",
+ * //   CompletionTime: new Date("TIMESTAMP"),
+ * //   Status: "RUNNING" || "COMPLETED" || "STOPPING" || "STOPPED" || "FAILED", // required
+ * //   SearchScope: { // SearchScope
+ * //     BackupResourceTypes: [ // ResourceTypeList // required
+ * //       "S3" || "EBS",
+ * //     ],
+ * //     BackupResourceCreationTime: { // BackupCreationTimeFilter
+ * //       CreatedAfter: new Date("TIMESTAMP"),
+ * //       CreatedBefore: new Date("TIMESTAMP"),
+ * //     },
+ * //     SourceResourceArns: [ // ResourceArnList
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     BackupResourceArns: [ // RecoveryPointArnList
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     BackupResourceTags: { // TagMap
+ * //       "<keys>": "STRING_VALUE",
+ * //     },
+ * //   },
+ * //   ItemFilters: { // ItemFilters
+ * //     S3ItemFilters: [ // S3ItemFilters
+ * //       { // S3ItemFilter
+ * //         ObjectKeys: [ // StringConditionList
+ * //           { // StringCondition
+ * //             Value: "STRING_VALUE", // required
+ * //             Operator: "EQUALS_TO" || "NOT_EQUALS_TO" || "CONTAINS" || "DOES_NOT_CONTAIN" || "BEGINS_WITH" || "ENDS_WITH" || "DOES_NOT_BEGIN_WITH" || "DOES_NOT_END_WITH",
+ * //           },
+ * //         ],
+ * //         Sizes: [ // LongConditionList
+ * //           { // LongCondition
+ * //             Value: Number("long"), // required
+ * //             Operator: "EQUALS_TO" || "NOT_EQUALS_TO" || "LESS_THAN_EQUAL_TO" || "GREATER_THAN_EQUAL_TO",
+ * //           },
+ * //         ],
+ * //         CreationTimes: [ // TimeConditionList
+ * //           { // TimeCondition
+ * //             Value: new Date("TIMESTAMP"), // required
+ * //             Operator: "EQUALS_TO" || "NOT_EQUALS_TO" || "LESS_THAN_EQUAL_TO" || "GREATER_THAN_EQUAL_TO",
+ * //           },
+ * //         ],
+ * //         VersionIds: [
+ * //           {
+ * //             Value: "STRING_VALUE", // required
+ * //             Operator: "EQUALS_TO" || "NOT_EQUALS_TO" || "CONTAINS" || "DOES_NOT_CONTAIN" || "BEGINS_WITH" || "ENDS_WITH" || "DOES_NOT_BEGIN_WITH" || "DOES_NOT_END_WITH",
+ * //           },
+ * //         ],
+ * //         ETags: [
+ * //           {
+ * //             Value: "STRING_VALUE", // required
+ * //             Operator: "EQUALS_TO" || "NOT_EQUALS_TO" || "CONTAINS" || "DOES_NOT_CONTAIN" || "BEGINS_WITH" || "ENDS_WITH" || "DOES_NOT_BEGIN_WITH" || "DOES_NOT_END_WITH",
+ * //           },
+ * //         ],
+ * //       },
+ * //     ],
+ * //     EBSItemFilters: [ // EBSItemFilters
+ * //       { // EBSItemFilter
+ * //         FilePaths: [
+ * //           {
+ * //             Value: "STRING_VALUE", // required
+ * //             Operator: "EQUALS_TO" || "NOT_EQUALS_TO" || "CONTAINS" || "DOES_NOT_CONTAIN" || "BEGINS_WITH" || "ENDS_WITH" || "DOES_NOT_BEGIN_WITH" || "DOES_NOT_END_WITH",
+ * //           },
+ * //         ],
+ * //         Sizes: [
+ * //           {
+ * //             Value: Number("long"), // required
+ * //             Operator: "EQUALS_TO" || "NOT_EQUALS_TO" || "LESS_THAN_EQUAL_TO" || "GREATER_THAN_EQUAL_TO",
+ * //           },
+ * //         ],
+ * //         CreationTimes: [
+ * //           {
+ * //             Value: new Date("TIMESTAMP"), // required
+ * //             Operator: "EQUALS_TO" || "NOT_EQUALS_TO" || "LESS_THAN_EQUAL_TO" || "GREATER_THAN_EQUAL_TO",
+ * //           },
+ * //         ],
+ * //         LastModificationTimes: [
+ * //           {
+ * //             Value: new Date("TIMESTAMP"), // required
+ * //             Operator: "EQUALS_TO" || "NOT_EQUALS_TO" || "LESS_THAN_EQUAL_TO" || "GREATER_THAN_EQUAL_TO",
+ * //           },
+ * //         ],
+ * //       },
+ * //     ],
+ * //   },
+ * //   CreationTime: new Date("TIMESTAMP"), // required
+ * //   SearchJobIdentifier: "STRING_VALUE", // required
+ * //   SearchJobArn: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param GetSearchJobCommandInput - {@link GetSearchJobCommandInput}
+ * @returns {@link GetSearchJobCommandOutput}
+ * @see {@link GetSearchJobCommandInput} for command's `input` shape.
+ * @see {@link GetSearchJobCommandOutput} for command's `response` shape.
+ * @see {@link BackupSearchClientResolvedConfig | config} for BackupSearchClient's `config` shape.
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource was not found for this request.</p>
+ *          <p>Confirm the resource information, such as the ARN or type is correct
+ *             and exists, then retry the request.</p>
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal server error occurred. Retry your request.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by a service.</p>
+ *
+ * @throws {@link BackupSearchServiceException}
+ * <p>Base exception class for all service exceptions from BackupSearch service.</p>
+ *
+ * @public
+ */
+export declare class GetSearchJobCommand extends GetSearchJobCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetSearchJobInput;
+            output: GetSearchJobOutput;
+        };
+        sdk: {
+            input: GetSearchJobCommandInput;
+            output: GetSearchJobCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,105 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupSearchClient";
+import { GetSearchResultExportJobInput, GetSearchResultExportJobOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetSearchResultExportJobCommand}.
+ */
+export interface GetSearchResultExportJobCommandInput extends GetSearchResultExportJobInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetSearchResultExportJobCommand}.
+ */
+export interface GetSearchResultExportJobCommandOutput extends GetSearchResultExportJobOutput, __MetadataBearer {
+}
+declare const GetSearchResultExportJobCommand_base: {
+    new (input: GetSearchResultExportJobCommandInput): import("@smithy/smithy-client").CommandImpl<GetSearchResultExportJobCommandInput, GetSearchResultExportJobCommandOutput, BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetSearchResultExportJobCommandInput): import("@smithy/smithy-client").CommandImpl<GetSearchResultExportJobCommandInput, GetSearchResultExportJobCommandOutput, BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>This operation retrieves the metadata of an export job.</p>
+ *          <p>An export job is an operation that transmits the results
+ *       of a search job to a specified S3 bucket in a
+ *       .csv file.</p>
+ *          <p>An export job allows you to retain results of a search
+ *       beyond the search job's scheduled retention of 7 days.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BackupSearchClient, GetSearchResultExportJobCommand } from "@aws-sdk/client-backupsearch"; // ES Modules import
+ * // const { BackupSearchClient, GetSearchResultExportJobCommand } = require("@aws-sdk/client-backupsearch"); // CommonJS import
+ * const client = new BackupSearchClient(config);
+ * const input = { // GetSearchResultExportJobInput
+ *   ExportJobIdentifier: "STRING_VALUE", // required
+ * };
+ * const command = new GetSearchResultExportJobCommand(input);
+ * const response = await client.send(command);
+ * // { // GetSearchResultExportJobOutput
+ * //   ExportJobIdentifier: "STRING_VALUE", // required
+ * //   ExportJobArn: "STRING_VALUE",
+ * //   Status: "RUNNING" || "FAILED" || "COMPLETED",
+ * //   CreationTime: new Date("TIMESTAMP"),
+ * //   CompletionTime: new Date("TIMESTAMP"),
+ * //   StatusMessage: "STRING_VALUE",
+ * //   ExportSpecification: { // ExportSpecification Union: only one key present
+ * //     s3ExportSpecification: { // S3ExportSpecification
+ * //       DestinationBucket: "STRING_VALUE", // required
+ * //       DestinationPrefix: "STRING_VALUE",
+ * //     },
+ * //   },
+ * //   SearchJobArn: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param GetSearchResultExportJobCommandInput - {@link GetSearchResultExportJobCommandInput}
+ * @returns {@link GetSearchResultExportJobCommandOutput}
+ * @see {@link GetSearchResultExportJobCommandInput} for command's `input` shape.
+ * @see {@link GetSearchResultExportJobCommandOutput} for command's `response` shape.
+ * @see {@link BackupSearchClientResolvedConfig | config} for BackupSearchClient's `config` shape.
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource was not found for this request.</p>
+ *          <p>Confirm the resource information, such as the ARN or type is correct
+ *             and exists, then retry the request.</p>
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal server error occurred. Retry your request.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by a service.</p>
+ *
+ * @throws {@link BackupSearchServiceException}
+ * <p>Base exception class for all service exceptions from BackupSearch service.</p>
+ *
+ * @public
+ */
+export declare class GetSearchResultExportJobCommand extends GetSearchResultExportJobCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetSearchResultExportJobInput;
+            output: GetSearchResultExportJobOutput;
+        };
+        sdk: {
+            input: GetSearchResultExportJobCommandInput;
+            output: GetSearchResultExportJobCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,113 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupSearchClient";
+import { ListSearchJobBackupsInput, ListSearchJobBackupsOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListSearchJobBackupsCommand}.
+ */
+export interface ListSearchJobBackupsCommandInput extends ListSearchJobBackupsInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListSearchJobBackupsCommand}.
+ */
+export interface ListSearchJobBackupsCommandOutput extends ListSearchJobBackupsOutput, __MetadataBearer {
+}
+declare const ListSearchJobBackupsCommand_base: {
+    new (input: ListSearchJobBackupsCommandInput): import("@smithy/smithy-client").CommandImpl<ListSearchJobBackupsCommandInput, ListSearchJobBackupsCommandOutput, BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: ListSearchJobBackupsCommandInput): import("@smithy/smithy-client").CommandImpl<ListSearchJobBackupsCommandInput, ListSearchJobBackupsCommandOutput, BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>This operation returns a list of all backups (recovery
+ *       points) in a paginated format that were included in
+ *       the search job.</p>
+ *          <p>If a search does not display an expected backup in
+ *       the results, you can call this operation to display each
+ *       backup included in the search. Any backups that were not
+ *       included because they have a <code>FAILED</code> status
+ *       from a permissions issue will be displayed, along with a
+ *       status message.</p>
+ *          <p>Only recovery points with a backup index that has
+ *       a status of <code>ACTIVE</code> will be included in search results.
+ *       If the index has any other status, its status will be
+ *       displayed along with a status message.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BackupSearchClient, ListSearchJobBackupsCommand } from "@aws-sdk/client-backupsearch"; // ES Modules import
+ * // const { BackupSearchClient, ListSearchJobBackupsCommand } = require("@aws-sdk/client-backupsearch"); // CommonJS import
+ * const client = new BackupSearchClient(config);
+ * const input = { // ListSearchJobBackupsInput
+ *   SearchJobIdentifier: "STRING_VALUE", // required
+ *   NextToken: "STRING_VALUE",
+ *   MaxResults: Number("int"),
+ * };
+ * const command = new ListSearchJobBackupsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListSearchJobBackupsOutput
+ * //   Results: [ // SearchJobBackupsResults // required
+ * //     { // SearchJobBackupsResult
+ * //       Status: "RUNNING" || "COMPLETED" || "STOPPING" || "STOPPED" || "FAILED",
+ * //       StatusMessage: "STRING_VALUE",
+ * //       ResourceType: "S3" || "EBS",
+ * //       BackupResourceArn: "STRING_VALUE",
+ * //       SourceResourceArn: "STRING_VALUE",
+ * //       IndexCreationTime: new Date("TIMESTAMP"),
+ * //       BackupCreationTime: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListSearchJobBackupsCommandInput - {@link ListSearchJobBackupsCommandInput}
+ * @returns {@link ListSearchJobBackupsCommandOutput}
+ * @see {@link ListSearchJobBackupsCommandInput} for command's `input` shape.
+ * @see {@link ListSearchJobBackupsCommandOutput} for command's `response` shape.
+ * @see {@link BackupSearchClientResolvedConfig | config} for BackupSearchClient's `config` shape.
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource was not found for this request.</p>
+ *          <p>Confirm the resource information, such as the ARN or type is correct
+ *             and exists, then retry the request.</p>
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal server error occurred. Retry your request.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by a service.</p>
+ *
+ * @throws {@link BackupSearchServiceException}
+ * <p>Base exception class for all service exceptions from BackupSearch service.</p>
+ *
+ * @public
+ */
+export declare class ListSearchJobBackupsCommand extends ListSearchJobBackupsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListSearchJobBackupsInput;
+            output: ListSearchJobBackupsOutput;
+        };
+        sdk: {
+            input: ListSearchJobBackupsCommandInput;
+            output: ListSearchJobBackupsCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,114 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupSearchClient";
+import { ListSearchJobResultsInput, ListSearchJobResultsOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListSearchJobResultsCommand}.
+ */
+export interface ListSearchJobResultsCommandInput extends ListSearchJobResultsInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListSearchJobResultsCommand}.
+ */
+export interface ListSearchJobResultsCommandOutput extends ListSearchJobResultsOutput, __MetadataBearer {
+}
+declare const ListSearchJobResultsCommand_base: {
+    new (input: ListSearchJobResultsCommandInput): import("@smithy/smithy-client").CommandImpl<ListSearchJobResultsCommandInput, ListSearchJobResultsCommandOutput, BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: ListSearchJobResultsCommandInput): import("@smithy/smithy-client").CommandImpl<ListSearchJobResultsCommandInput, ListSearchJobResultsCommandOutput, BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>This operation returns a list of a specified search job.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BackupSearchClient, ListSearchJobResultsCommand } from "@aws-sdk/client-backupsearch"; // ES Modules import
+ * // const { BackupSearchClient, ListSearchJobResultsCommand } = require("@aws-sdk/client-backupsearch"); // CommonJS import
+ * const client = new BackupSearchClient(config);
+ * const input = { // ListSearchJobResultsInput
+ *   SearchJobIdentifier: "STRING_VALUE", // required
+ *   NextToken: "STRING_VALUE",
+ *   MaxResults: Number("int"),
+ * };
+ * const command = new ListSearchJobResultsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListSearchJobResultsOutput
+ * //   Results: [ // Results // required
+ * //     { // ResultItem Union: only one key present
+ * //       S3ResultItem: { // S3ResultItem
+ * //         BackupResourceArn: "STRING_VALUE",
+ * //         SourceResourceArn: "STRING_VALUE",
+ * //         BackupVaultName: "STRING_VALUE",
+ * //         ObjectKey: "STRING_VALUE",
+ * //         ObjectSize: Number("long"),
+ * //         CreationTime: new Date("TIMESTAMP"),
+ * //         ETag: "STRING_VALUE",
+ * //         VersionId: "STRING_VALUE",
+ * //       },
+ * //       EBSResultItem: { // EBSResultItem
+ * //         BackupResourceArn: "STRING_VALUE",
+ * //         SourceResourceArn: "STRING_VALUE",
+ * //         BackupVaultName: "STRING_VALUE",
+ * //         FileSystemIdentifier: "STRING_VALUE",
+ * //         FilePath: "STRING_VALUE",
+ * //         FileSize: Number("long"),
+ * //         CreationTime: new Date("TIMESTAMP"),
+ * //         LastModifiedTime: new Date("TIMESTAMP"),
+ * //       },
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListSearchJobResultsCommandInput - {@link ListSearchJobResultsCommandInput}
+ * @returns {@link ListSearchJobResultsCommandOutput}
+ * @see {@link ListSearchJobResultsCommandInput} for command's `input` shape.
+ * @see {@link ListSearchJobResultsCommandOutput} for command's `response` shape.
+ * @see {@link BackupSearchClientResolvedConfig | config} for BackupSearchClient's `config` shape.
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource was not found for this request.</p>
+ *          <p>Confirm the resource information, such as the ARN or type is correct
+ *             and exists, then retry the request.</p>
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal server error occurred. Retry your request.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by a service.</p>
+ *
+ * @throws {@link BackupSearchServiceException}
+ * <p>Base exception class for all service exceptions from BackupSearch service.</p>
+ *
+ * @public
+ */
+export declare class ListSearchJobResultsCommand extends ListSearchJobResultsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListSearchJobResultsInput;
+            output: ListSearchJobResultsOutput;
+        };
+        sdk: {
+            input: ListSearchJobResultsCommandInput;
+            output: ListSearchJobResultsCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,101 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupSearchClient";
+import { ListSearchJobsInput, ListSearchJobsOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListSearchJobsCommand}.
+ */
+export interface ListSearchJobsCommandInput extends ListSearchJobsInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListSearchJobsCommand}.
+ */
+export interface ListSearchJobsCommandOutput extends ListSearchJobsOutput, __MetadataBearer {
+}
+declare const ListSearchJobsCommand_base: {
+    new (input: ListSearchJobsCommandInput): import("@smithy/smithy-client").CommandImpl<ListSearchJobsCommandInput, ListSearchJobsCommandOutput, BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [ListSearchJobsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListSearchJobsCommandInput, ListSearchJobsCommandOutput, BackupSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>This operation returns a list of search jobs belonging
+ *       to an account.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BackupSearchClient, ListSearchJobsCommand } from "@aws-sdk/client-backupsearch"; // ES Modules import
+ * // const { BackupSearchClient, ListSearchJobsCommand } = require("@aws-sdk/client-backupsearch"); // CommonJS import
+ * const client = new BackupSearchClient(config);
+ * const input = { // ListSearchJobsInput
+ *   ByStatus: "RUNNING" || "COMPLETED" || "STOPPING" || "STOPPED" || "FAILED",
+ *   NextToken: "STRING_VALUE",
+ *   MaxResults: Number("int"),
+ * };
+ * const command = new ListSearchJobsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListSearchJobsOutput
+ * //   SearchJobs: [ // SearchJobs // required
+ * //     { // SearchJobSummary
+ * //       SearchJobIdentifier: "STRING_VALUE",
+ * //       SearchJobArn: "STRING_VALUE",
+ * //       Name: "STRING_VALUE",
+ * //       Status: "RUNNING" || "COMPLETED" || "STOPPING" || "STOPPED" || "FAILED",
+ * //       CreationTime: new Date("TIMESTAMP"),
+ * //       CompletionTime: new Date("TIMESTAMP"),
+ * //       SearchScopeSummary: { // SearchScopeSummary
+ * //         TotalRecoveryPointsToScanCount: Number("int"),
+ * //         TotalItemsToScanCount: Number("long"),
+ * //       },
+ * //       StatusMessage: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListSearchJobsCommandInput - {@link ListSearchJobsCommandInput}
+ * @returns {@link ListSearchJobsCommandOutput}
+ * @see {@link ListSearchJobsCommandInput} for command's `input` shape.
+ * @see {@link ListSearchJobsCommandOutput} for command's `response` shape.
+ * @see {@link BackupSearchClientResolvedConfig | config} for BackupSearchClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal server error occurred. Retry your request.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by a service.</p>
+ *
+ * @throws {@link BackupSearchServiceException}
+ * <p>Base exception class for all service exceptions from BackupSearch service.</p>
+ *
+ * @public
+ */
+export declare class ListSearchJobsCommand extends ListSearchJobsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListSearchJobsInput;
+            output: ListSearchJobsOutput;
+        };
+        sdk: {
+            input: ListSearchJobsCommandInput;
+            output: ListSearchJobsCommandOutput;
+        };
+    };
+}