import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { StartSearchJobInput, StartSearchJobOutput } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link StartSearchJobCommand}. */ export interface StartSearchJobCommandInput extends StartSearchJobInput { } /** * @public * * The output of {@link StartSearchJobCommand}. */ export interface StartSearchJobCommandOutput extends StartSearchJobOutput, __MetadataBearer { } declare const StartSearchJobCommand_base: { new (input: StartSearchJobCommandInput): import("@smithy/core/client").CommandImpl; new (input: StartSearchJobCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

This operation creates a search job which returns recovery points filtered by SearchScope and items filtered by ItemFilters.

You can optionally include ClientToken, EncryptionKeyArn, Name, and/or Tags.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { BackupSearchClient, StartSearchJobCommand } from "@aws-sdk/client-backupsearch"; // ES Modules import * // const { BackupSearchClient, StartSearchJobCommand } = require("@aws-sdk/client-backupsearch"); // CommonJS import * // import type { BackupSearchClientConfig } from "@aws-sdk/client-backupsearch"; * const config = {}; // type is BackupSearchClientConfig * const client = new BackupSearchClient(config); * const input = { // StartSearchJobInput * Tags: { // TagMap * "": "STRING_VALUE", * }, * Name: "STRING_VALUE", * EncryptionKeyArn: "STRING_VALUE", * ClientToken: "STRING_VALUE", * 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: { * "": "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", * }, * ], * }, * ], * }, * }; * const command = new StartSearchJobCommand(input); * const response = await client.send(command); * // { // StartSearchJobOutput * // SearchJobArn: "STRING_VALUE", * // CreationTime: new Date("TIMESTAMP"), * // SearchJobIdentifier: "STRING_VALUE", * // }; * * ``` * * @param StartSearchJobCommandInput - {@link StartSearchJobCommandInput} * @returns {@link StartSearchJobCommandOutput} * @see {@link StartSearchJobCommandInput} for command's `input` shape. * @see {@link StartSearchJobCommandOutput} for command's `response` shape. * @see {@link BackupSearchClientResolvedConfig | config} for BackupSearchClient's `config` shape. * * @throws {@link ConflictException} (client fault) *

This exception occurs when a conflict with a previous successful operation is detected. This generally occurs when the previous operation did not have time to propagate to the host serving the current request.

A retry (with appropriate backoff logic) is the recommended response to this exception.

* * @throws {@link ResourceNotFoundException} (client fault) *

The resource was not found for this request.

Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

* * @throws {@link ServiceQuotaExceededException} (client fault) *

The request denied due to exceeding the quota limits permitted.

* * @throws {@link AccessDeniedException} (client fault) *

You do not have sufficient access to perform this action.

* * @throws {@link InternalServerException} (server fault) *

An internal server error occurred. Retry your request.

* * @throws {@link ThrottlingException} (client fault) *

The request was denied due to request throttling.

* * @throws {@link ValidationException} (client fault) *

The input fails to satisfy the constraints specified by a service.

* * @throws {@link BackupSearchServiceException} *

Base exception class for all service exceptions from BackupSearch service.

* * * @public */ export declare class StartSearchJobCommand extends StartSearchJobCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: StartSearchJobInput; output: StartSearchJobOutput; }; sdk: { input: StartSearchJobCommandInput; output: StartSearchJobCommandOutput; }; }; }