BackupSearchClient

Suggest an Edit
Backup Search

Backup Search is the recovery point and item level search for Backup.

For additional information, see:

Installation

NPM
npm install @aws-sdk/client-backupsearch
Yarn
yarn add @aws-sdk/client-backupsearch
pnpm
pnpm add @aws-sdk/client-backupsearch

BackupSearchClient Operations

Command
Summary
GetSearchJobCommand

This operation retrieves metadata of a search job, including its progress.

GetSearchResultExportJobCommand

This operation retrieves the metadata of an export job.

An export job is an operation that transmits the results of a search job to a specified S3 bucket in a .csv file.

An export job allows you to retain results of a search beyond the search job's scheduled retention of 7 days.

ListSearchJobBackupsCommand

This operation returns a list of all backups (recovery points) in a paginated format that were included in the search job.

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 FAILED status from a permissions issue will be displayed, along with a status message.

Only recovery points with a backup index that has a status of ACTIVE will be included in search results. If the index has any other status, its status will be displayed along with a status message.

ListSearchJobResultsCommand

This operation returns a list of a specified search job.

ListSearchJobsCommand

This operation returns a list of search jobs belonging to an account.

ListSearchResultExportJobsCommand

This operation exports search results of a search job to a specified destination S3 bucket.

ListTagsForResourceCommand

This operation returns the tags for a resource type.

StartSearchJobCommand

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.

StartSearchResultExportJobCommand

This operations starts a job to export the results of search job to a designated S3 bucket.

StopSearchJobCommand

This operations ends a search job.

Only a search job with a status of RUNNING can be stopped.

TagResourceCommand

This operation puts tags on the resource you indicate.

UntagResourceCommand

This operation removes tags from the specified resource.

BackupSearchClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: BackupSearchClientConfig