Class: Aws::BackupSearch::Types::StartSearchJobInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

Include this parameter to allow multiple identical calls for idempotency.

A client token is valid for 8 hours after the first request that uses it is completed. After this time, any request with the same token is treated as a new request.

Returns:

  • (String) 


1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb', line 1211

class StartSearchJobInput < Struct.new(
  :tags,
  :name,
  :encryption_key_arn,
  :client_token,
  :search_scope,
  :item_filters)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_key_arn ⇒ String

The encryption key for the specified search job.

Returns:

  • (String) 


1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb', line 1211

class StartSearchJobInput < Struct.new(
  :tags,
  :name,
  :encryption_key_arn,
  :client_token,
  :search_scope,
  :item_filters)
  SENSITIVE = []
  include Aws::Structure
end

#item_filters ⇒ Types::ItemFilters

Item Filters represent all input item properties specified when the search was created.

Contains either EBSItemFilters or S3ItemFilters

Returns:



1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb', line 1211

class StartSearchJobInput < Struct.new(
  :tags,
  :name,
  :encryption_key_arn,
  :client_token,
  :search_scope,
  :item_filters)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

Include alphanumeric characters to create a name for this search job.

Returns:

  • (String) 


1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb', line 1211

class StartSearchJobInput < Struct.new(
  :tags,
  :name,
  :encryption_key_arn,
  :client_token,
  :search_scope,
  :item_filters)
  SENSITIVE = []
  include Aws::Structure
end

#search_scope ⇒ Types::SearchScope

This object can contain BackupResourceTypes, BackupResourceArns, BackupResourceCreationTime, BackupResourceTags, and SourceResourceArns to filter the recovery points returned by the search job.

Returns:



1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb', line 1211

class StartSearchJobInput < Struct.new(
  :tags,
  :name,
  :encryption_key_arn,
  :client_token,
  :search_scope,
  :item_filters)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

List of tags returned by the operation.

Returns:

  • (Hash<String,String>) 


1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb', line 1211

class StartSearchJobInput < Struct.new(
  :tags,
  :name,
  :encryption_key_arn,
  :client_token,
  :search_scope,
  :item_filters)
  SENSITIVE = []
  include Aws::Structure
end