Class: Aws::MailManager::Types::StartArchiveExportRequest

Inherits:

Struct

• Object
• Struct
• Aws::MailManager::Types::StartArchiveExportRequest

Includes:

Structure

Defined in:

lib/aws-sdk-mailmanager/types.rb

Overview

The request to initiate an export of emails from an archive.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #archive_id ⇒ String

  The identifier of the archive to export emails from.

• #export_destination_configuration ⇒ Types::ExportDestinationConfiguration

  Details on where to deliver the exported email data.

• #filters ⇒ Types::ArchiveFilters

  Criteria to filter which emails are included in the export.

• #from_timestamp ⇒ Time

  The start of the timestamp range to include emails from.

• #include_metadata ⇒ Boolean

  Whether to include message metadata as JSON files in the export.

• #max_results ⇒ Integer

  The maximum number of email items to include in the export.

• #to_timestamp ⇒ Time

  The end of the timestamp range to include emails from.

Instance Attribute Details

#archive_id ⇒ String

The identifier of the archive to export emails from.

Returns:

• (String)

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

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

#export_destination_configuration ⇒ Types::ExportDestinationConfiguration

Details on where to deliver the exported email data.

Returns:

• (Types::ExportDestinationConfiguration)

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

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

#filters ⇒ Types::ArchiveFilters

Criteria to filter which emails are included in the export.

Returns:

• (Types::ArchiveFilters)

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

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

#from_timestamp ⇒ Time

The start of the timestamp range to include emails from.

Returns:

• (Time)

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

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

#include_metadata ⇒ Boolean

Whether to include message metadata as JSON files in the export.

Returns:

• (Boolean)

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

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

#max_results ⇒ Integer

The maximum number of email items to include in the export.

Returns:

• (Integer)

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

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

#to_timestamp ⇒ Time

The end of the timestamp range to include emails from.

Returns:

• (Time)

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

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