Class: Aws::BackupSearch::Types::GetSearchJobOutput

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

#completion_time ⇒ Time

The date and time that a search job completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

  • (Time) 


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb', line 380

class GetSearchJobOutput < Struct.new(
  :name,
  :search_scope_summary,
  :current_search_progress,
  :status_message,
  :encryption_key_arn,
  :completion_time,
  :status,
  :search_scope,
  :item_filters,
  :creation_time,
  :search_job_identifier,
  :search_job_arn)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

The date and time that a search job was created, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

  • (Time) 


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb', line 380

class GetSearchJobOutput < Struct.new(
  :name,
  :search_scope_summary,
  :current_search_progress,
  :status_message,
  :encryption_key_arn,
  :completion_time,
  :status,
  :search_scope,
  :item_filters,
  :creation_time,
  :search_job_identifier,
  :search_job_arn)
  SENSITIVE = []
  include Aws::Structure
end

#current_search_progress ⇒ Types::CurrentSearchProgress

Returns numbers representing BackupsScannedCount, ItemsScanned, and ItemsMatched.

Returns:



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb', line 380

class GetSearchJobOutput < Struct.new(
  :name,
  :search_scope_summary,
  :current_search_progress,
  :status_message,
  :encryption_key_arn,
  :completion_time,
  :status,
  :search_scope,
  :item_filters,
  :creation_time,
  :search_job_identifier,
  :search_job_arn)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_key_arn ⇒ String

The encryption key for the specified search job.

Example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

Returns:

  • (String) 


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb', line 380

class GetSearchJobOutput < Struct.new(
  :name,
  :search_scope_summary,
  :current_search_progress,
  :status_message,
  :encryption_key_arn,
  :completion_time,
  :status,
  :search_scope,
  :item_filters,
  :creation_time,
  :search_job_identifier,
  :search_job_arn)
  SENSITIVE = []
  include Aws::Structure
end

#item_filters ⇒ Types::ItemFilters

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

Returns:



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb', line 380

class GetSearchJobOutput < Struct.new(
  :name,
  :search_scope_summary,
  :current_search_progress,
  :status_message,
  :encryption_key_arn,
  :completion_time,
  :status,
  :search_scope,
  :item_filters,
  :creation_time,
  :search_job_identifier,
  :search_job_arn)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

Returned name of the specified search job.

Returns:

  • (String) 


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb', line 380

class GetSearchJobOutput < Struct.new(
  :name,
  :search_scope_summary,
  :current_search_progress,
  :status_message,
  :encryption_key_arn,
  :completion_time,
  :status,
  :search_scope,
  :item_filters,
  :creation_time,
  :search_job_identifier,
  :search_job_arn)
  SENSITIVE = []
  include Aws::Structure
end

#search_job_arn ⇒ String

The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.

Returns:

  • (String) 


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb', line 380

class GetSearchJobOutput < Struct.new(
  :name,
  :search_scope_summary,
  :current_search_progress,
  :status_message,
  :encryption_key_arn,
  :completion_time,
  :status,
  :search_scope,
  :item_filters,
  :creation_time,
  :search_job_identifier,
  :search_job_arn)
  SENSITIVE = []
  include Aws::Structure
end

#search_job_identifier ⇒ String

The unique string that identifies the specified search job.

Returns:

  • (String) 


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb', line 380

class GetSearchJobOutput < Struct.new(
  :name,
  :search_scope_summary,
  :current_search_progress,
  :status_message,
  :encryption_key_arn,
  :completion_time,
  :status,
  :search_scope,
  :item_filters,
  :creation_time,
  :search_job_identifier,
  :search_job_arn)
  SENSITIVE = []
  include Aws::Structure
end

#search_scope ⇒ Types::SearchScope

The search scope is all backup properties input into a search.

Returns:



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb', line 380

class GetSearchJobOutput < Struct.new(
  :name,
  :search_scope_summary,
  :current_search_progress,
  :status_message,
  :encryption_key_arn,
  :completion_time,
  :status,
  :search_scope,
  :item_filters,
  :creation_time,
  :search_job_identifier,
  :search_job_arn)
  SENSITIVE = []
  include Aws::Structure
end

#search_scope_summary ⇒ Types::SearchScopeSummary

Returned summary of the specified search job scope, including:

  • TotalBackupsToScanCount, the number of recovery points returned by the search.

  • TotalItemsToScanCount, the number of items returned by the search.

Returns:



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb', line 380

class GetSearchJobOutput < Struct.new(
  :name,
  :search_scope_summary,
  :current_search_progress,
  :status_message,
  :encryption_key_arn,
  :completion_time,
  :status,
  :search_scope,
  :item_filters,
  :creation_time,
  :search_job_identifier,
  :search_job_arn)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the specified search job.

A search job may have one of the following statuses: RUNNING; COMPLETED; STOPPED; FAILED; TIMED_OUT; or EXPIRED .

Returns:

  • (String) 


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb', line 380

class GetSearchJobOutput < Struct.new(
  :name,
  :search_scope_summary,
  :current_search_progress,
  :status_message,
  :encryption_key_arn,
  :completion_time,
  :status,
  :search_scope,
  :item_filters,
  :creation_time,
  :search_job_identifier,
  :search_job_arn)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ String

A status message will be returned for either a earch job with a status of ERRORED or a status of COMPLETED jobs with issues.

For example, a message may say that a search contained recovery points unable to be scanned because of a permissions issue.

Returns:

  • (String) 


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb', line 380

class GetSearchJobOutput < Struct.new(
  :name,
  :search_scope_summary,
  :current_search_progress,
  :status_message,
  :encryption_key_arn,
  :completion_time,
  :status,
  :search_scope,
  :item_filters,
  :creation_time,
  :search_job_identifier,
  :search_job_arn)
  SENSITIVE = []
  include Aws::Structure
end