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

Inherits:

Struct

• Object
• Struct
• Aws::MailManager::Types::StartArchiveSearchRequest

Includes:

Structure

Defined in:

lib/aws-sdk-mailmanager/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #archive_id ⇒ String

  The identifier of the archive to search emails in.

• #filters ⇒ Types::ArchiveFilters

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

• #from_timestamp ⇒ Time

  The start timestamp of the range to search emails from.

• #max_results ⇒ Integer

  The maximum number of search results to return.

• #to_timestamp ⇒ Time

  The end timestamp of the range to search emails from.

Instance Attribute Details

#archive_id ⇒ String

The identifier of the archive to search emails in.

Returns:

• (String)

# File 'lib/aws-sdk-mailmanager/types.rb', line 3424

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:

• (Types::ArchiveFilters)

# File 'lib/aws-sdk-mailmanager/types.rb', line 3424

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)

# File 'lib/aws-sdk-mailmanager/types.rb', line 3424

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)

# File 'lib/aws-sdk-mailmanager/types.rb', line 3424

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)

# File 'lib/aws-sdk-mailmanager/types.rb', line 3424

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