backupsearch/aws.sdk.kotlin.services.backupsearch

Package-level declarations

Types

BackupSearchClient

interface BackupSearchClient : SdkClient

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

Properties

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

const val ServiceId: String

Functions

inline suspend fun BackupSearchClient.getSearchJob(crossinline block: GetSearchJobRequest.Builder.() -> Unit): GetSearchJobResponse

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

getSearchResultExportJob

inline suspend fun BackupSearchClient.getSearchResultExportJob(crossinline block: GetSearchResultExportJobRequest.Builder.() -> Unit): GetSearchResultExportJobResponse

This operation retrieves the metadata of an export job.

listSearchJobBackups

inline suspend fun BackupSearchClient.listSearchJobBackups(crossinline block: ListSearchJobBackupsRequest.Builder.() -> Unit): ListSearchJobBackupsResponse

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

listSearchJobResults

inline suspend fun BackupSearchClient.listSearchJobResults(crossinline block: ListSearchJobResultsRequest.Builder.() -> Unit): ListSearchJobResultsResponse

This operation returns a list of a specified search job.

inline suspend fun BackupSearchClient.listSearchJobs(crossinline block: ListSearchJobsRequest.Builder.() -> Unit): ListSearchJobsResponse

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

listSearchResultExportJobs

inline suspend fun BackupSearchClient.listSearchResultExportJobs(crossinline block: ListSearchResultExportJobsRequest.Builder.() -> Unit): ListSearchResultExportJobsResponse

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

listTagsForResource

inline suspend fun BackupSearchClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

This operation returns the tags for a resource type.

inline suspend fun BackupSearchClient.startSearchJob(crossinline block: StartSearchJobRequest.Builder.() -> Unit): StartSearchJobResponse

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

startSearchResultExportJob

inline suspend fun BackupSearchClient.startSearchResultExportJob(crossinline block: StartSearchResultExportJobRequest.Builder.() -> Unit): StartSearchResultExportJobResponse

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

inline suspend fun BackupSearchClient.stopSearchJob(crossinline block: StopSearchJobRequest.Builder.() -> Unit): StopSearchJobResponse

This operations ends a search job.

inline suspend fun BackupSearchClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

This operation puts tags on the resource you indicate.

inline suspend fun BackupSearchClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

This operation removes tags from the specified resource.

fun BackupSearchClient.withConfig(block: BackupSearchClient.Config.Builder.() -> Unit): BackupSearchClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.