View Source AWS.BackupSearch (aws-elixir v1.0.6)

Backup Search

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

For additional information, see:

*

Backup API Reference

*

Backup Developer Guide

Link to this section Summary

Functions

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

This operation retrieves the metadata of an export job.

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

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

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

This operation returns the tags for a resource type.

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

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

This operation puts tags on the resource you indicate.

This operation removes tags from the specified resource.

Link to this section Functions

Link to this function

get_search_job(client, search_job_identifier, options \\ [])

View Source

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

Link to this function

get_search_result_export_job(client, export_job_identifier, options \\ [])

View Source

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.

Link to this function

list_search_job_backups(client, search_job_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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.

Link to this function

list_search_job_results(client, search_job_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

This operation returns a list of a specified search job.

Link to this function

list_search_jobs(client, by_status \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_search_result_export_jobs(client, max_results \\ nil, next_token \\ nil, search_job_identifier \\ nil, status \\ nil, options \\ [])

View Source

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

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

This operation returns the tags for a resource type.

Link to this function

start_search_job(client, input, options \\ [])

View Source

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.

Link to this function

start_search_result_export_job(client, input, options \\ [])

View Source

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

Link to this function

stop_search_job(client, search_job_identifier, input, options \\ [])

View Source

This operations ends a search job.

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

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

This operation puts tags on the resource you indicate.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

This operation removes tags from the specified resource.