Class: Aws::MailManager::Types::GetArchiveSearchResponse

Inherits:

Struct

• Object
• Struct
• Aws::MailManager::Types::GetArchiveSearchResponse

Includes:

Structure

Defined in:

lib/aws-sdk-mailmanager/types.rb

Overview

The response containing details of the specified archive search job.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #archive_id ⇒ String

  The identifier of the archive the email search was performed in.

• #filters ⇒ Types::ArchiveFilters

  The criteria used to filter emails included in the search.

• #from_timestamp ⇒ Time

  The start timestamp of the range the searched emails cover.

• #max_results ⇒ Integer

  The maximum number of search results to return.

• #status ⇒ Types::SearchStatus

  The current status of the search job.

• #to_timestamp ⇒ Time

  The end timestamp of the range the searched emails cover.

Instance Attribute Details

#archive_id ⇒ String

The identifier of the archive the email search was performed in.

Returns:

• (String)

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

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

#filters ⇒ Types::ArchiveFilters

The criteria used to filter emails included in the search.

Returns:

• (Types::ArchiveFilters)

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

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

#from_timestamp ⇒ Time

The start timestamp of the range the searched emails cover.

Returns:

• (Time)

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

class GetArchiveSearchResponse < Struct.new(
  :archive_id,
  :filters,
  :from_timestamp,
  :max_results,
  :status,
  :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 1336

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

#status ⇒ Types::SearchStatus

The current status of the search job.

Returns:

• (Types::SearchStatus)

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

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

#to_timestamp ⇒ Time

The end timestamp of the range the searched emails cover.

Returns:

• (Time)

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

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