Class: Aws::MailManager::Types::StartArchiveSearchRequest

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

Overview

The request to initiate a search across emails in an archive.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#archive_id ⇒ String

The identifier of the archive to search emails in.

Returns:

  • (String) 


3379
3380
3381
3382
3383
3384
3385
3386
3387
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 3379

class StartArchiveSearchRequest < Struct.new(
  :archive_id,
  :filters,
  :from_timestamp,
  :max_results,
  :to_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#filters ⇒ Types::ArchiveFilters

Criteria to filter which emails are included in the search results.

Returns:



3379
3380
3381
3382
3383
3384
3385
3386
3387
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 3379

class StartArchiveSearchRequest < Struct.new(
  :archive_id,
  :filters,
  :from_timestamp,
  :max_results,
  :to_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#from_timestamp ⇒ Time

The start timestamp of the range to search emails from.

Returns:

  • (Time) 


3379
3380
3381
3382
3383
3384
3385
3386
3387
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 3379

class StartArchiveSearchRequest < Struct.new(
  :archive_id,
  :filters,
  :from_timestamp,
  :max_results,
  :to_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of search results to return.

Returns:

  • (Integer) 


3379
3380
3381
3382
3383
3384
3385
3386
3387
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 3379

class StartArchiveSearchRequest < Struct.new(
  :archive_id,
  :filters,
  :from_timestamp,
  :max_results,
  :to_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#to_timestamp ⇒ Time

The end timestamp of the range to search emails from.

Returns:

  • (Time) 


3379
3380
3381
3382
3383
3384
3385
3386
3387
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 3379

class StartArchiveSearchRequest < Struct.new(
  :archive_id,
  :filters,
  :from_timestamp,
  :max_results,
  :to_timestamp)
  SENSITIVE = []
  include Aws::Structure
end