Class: Aws::MailManager::Types::GetArchiveResponse

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

Overview

The response containing details of the requested archive.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#archive_arn ⇒ String

The Amazon Resource Name (ARN) of the archive.

Returns:

  • (String) 


1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 1649

class GetArchiveResponse < Struct.new(
  :archive_id,
  :archive_name,
  :archive_arn,
  :archive_state,
  :retention,
  :created_timestamp,
  :last_updated_timestamp,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#archive_id ⇒ String

The unique identifier of the archive.

Returns:

  • (String) 


1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 1649

class GetArchiveResponse < Struct.new(
  :archive_id,
  :archive_name,
  :archive_arn,
  :archive_state,
  :retention,
  :created_timestamp,
  :last_updated_timestamp,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#archive_name ⇒ String

The unique name assigned to the archive.

Returns:

  • (String) 


1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 1649

class GetArchiveResponse < Struct.new(
  :archive_id,
  :archive_name,
  :archive_arn,
  :archive_state,
  :retention,
  :created_timestamp,
  :last_updated_timestamp,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#archive_state ⇒ String

The current state of the archive:

  • ACTIVE – The archive is ready and available for use.

  • PENDING_DELETION – The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state.

Returns:

  • (String) 


1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 1649

class GetArchiveResponse < Struct.new(
  :archive_id,
  :archive_name,
  :archive_arn,
  :archive_state,
  :retention,
  :created_timestamp,
  :last_updated_timestamp,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#created_timestamp ⇒ Time

The timestamp of when the archive was created.

Returns:

  • (Time) 


1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 1649

class GetArchiveResponse < Struct.new(
  :archive_id,
  :archive_name,
  :archive_arn,
  :archive_state,
  :retention,
  :created_timestamp,
  :last_updated_timestamp,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_arn ⇒ String

The Amazon Resource Name (ARN) of the KMS key used to encrypt the archive.

Returns:

  • (String) 


1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 1649

class GetArchiveResponse < Struct.new(
  :archive_id,
  :archive_name,
  :archive_arn,
  :archive_state,
  :retention,
  :created_timestamp,
  :last_updated_timestamp,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_timestamp ⇒ Time

The timestamp of when the archive was modified.

Returns:

  • (Time) 


1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 1649

class GetArchiveResponse < Struct.new(
  :archive_id,
  :archive_name,
  :archive_arn,
  :archive_state,
  :retention,
  :created_timestamp,
  :last_updated_timestamp,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#retention ⇒ Types::ArchiveRetention

The retention period for emails in this archive.

Returns:



1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 1649

class GetArchiveResponse < Struct.new(
  :archive_id,
  :archive_name,
  :archive_arn,
  :archive_state,
  :retention,
  :created_timestamp,
  :last_updated_timestamp,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end