Class: Aws::BackupSearch::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::BackupSearch::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/client.rb
Overview
An API client for BackupSearch. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::BackupSearch::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#get_search_job(params = {}) ⇒ Types::GetSearchJobOutput
This operation retrieves metadata of a search job, including its progress.
-
#get_search_result_export_job(params = {}) ⇒ Types::GetSearchResultExportJobOutput
This operation retrieves the metadata of an export job.
-
#list_search_job_backups(params = {}) ⇒ Types::ListSearchJobBackupsOutput
This operation returns a list of all backups (recovery points) in a paginated format that were included in the search job.
-
#list_search_job_results(params = {}) ⇒ Types::ListSearchJobResultsOutput
This operation returns a list of a specified search job.
-
#list_search_jobs(params = {}) ⇒ Types::ListSearchJobsOutput
This operation returns a list of search jobs belonging to an account.
-
#list_search_result_export_jobs(params = {}) ⇒ Types::ListSearchResultExportJobsOutput
This operation exports search results of a search job to a specified destination S3 bucket.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
This operation returns the tags for a resource type.
-
#start_search_job(params = {}) ⇒ Types::StartSearchJobOutput
This operation creates a search job which returns recovery points filtered by SearchScope and items filtered by ItemFilters.
-
#start_search_result_export_job(params = {}) ⇒ Types::StartSearchResultExportJobOutput
This operations starts a job to export the results of search job to a designated S3 bucket.
-
#stop_search_job(params = {}) ⇒ Struct
This operations ends a search job.
-
#tag_resource(params = {}) ⇒ Struct
This operation puts tags on the resource you indicate.
-
#untag_resource(params = {}) ⇒ Struct
This operation removes tags from the specified resource.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
467 468 469 |
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/client.rb', line 467 def initialize(*args) super end |
Instance Method Details
#get_search_job(params = {}) ⇒ Types::GetSearchJobOutput
This operation retrieves metadata of a search job, including its progress.
559 560 561 562 |
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/client.rb', line 559 def get_search_job(params = {}, = {}) req = build_request(:get_search_job, params) req.send_request() end |
#get_search_result_export_job(params = {}) ⇒ Types::GetSearchResultExportJobOutput
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.
610 611 612 613 |
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/client.rb', line 610 def get_search_result_export_job(params = {}, = {}) req = build_request(:get_search_result_export_job, params) req.send_request() end |
#list_search_job_backups(params = {}) ⇒ Types::ListSearchJobBackupsOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
673 674 675 676 |
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/client.rb', line 673 def list_search_job_backups(params = {}, = {}) req = build_request(:list_search_job_backups, params) req.send_request() end |
#list_search_job_results(params = {}) ⇒ Types::ListSearchJobResultsOutput
This operation returns a list of a specified search job.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
733 734 735 736 |
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/client.rb', line 733 def list_search_job_results(params = {}, = {}) req = build_request(:list_search_job_results, params) req.send_request() end |
#list_search_jobs(params = {}) ⇒ Types::ListSearchJobsOutput
This operation returns a list of search jobs belonging to an account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
786 787 788 789 |
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/client.rb', line 786 def list_search_jobs(params = {}, = {}) req = build_request(:list_search_jobs, params) req.send_request() end |
#list_search_result_export_jobs(params = {}) ⇒ Types::ListSearchResultExportJobsOutput
This operation exports search results of a search job to a specified destination S3 bucket.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
844 845 846 847 |
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/client.rb', line 844 def list_search_result_export_jobs(params = {}, = {}) req = build_request(:list_search_result_export_jobs, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
This operation returns the tags for a resource type.
874 875 876 877 |
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/client.rb', line 874 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#start_search_job(params = {}) ⇒ Types::StartSearchJobOutput
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.
1016 1017 1018 1019 |
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/client.rb', line 1016 def start_search_job(params = {}, = {}) req = build_request(:start_search_job, params) req.send_request() end |
#start_search_result_export_job(params = {}) ⇒ Types::StartSearchResultExportJobOutput
This operations starts a job to export the results of search job to a designated S3 bucket.
1080 1081 1082 1083 |
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/client.rb', line 1080 def start_search_result_export_job(params = {}, = {}) req = build_request(:start_search_result_export_job, params) req.send_request() end |
#stop_search_job(params = {}) ⇒ Struct
This operations ends a search job.
Only a search job with a status of RUNNING
can be stopped.
1104 1105 1106 1107 |
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/client.rb', line 1104 def stop_search_job(params = {}, = {}) req = build_request(:stop_search_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
This operation puts tags on the resource you indicate.
1137 1138 1139 1140 |
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/client.rb', line 1137 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
This operation removes tags from the specified resource.
1165 1166 1167 1168 |
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/client.rb', line 1165 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |