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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#archive_arnString

The Amazon Resource Name (ARN) of the archive.

Returns:

  • (String)


1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 1208

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

#archive_idString

The unique identifier of the archive.

Returns:

  • (String)


1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 1208

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

#archive_nameString

The unique name assigned to the archive.

Returns:

  • (String)


1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 1208

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

#archive_stateString

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)


1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 1208

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

#created_timestampTime

The timestamp of when the archive was created.

Returns:

  • (Time)


1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 1208

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

#kms_key_arnString

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

Returns:

  • (String)


1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 1208

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

#last_updated_timestampTime

The timestamp of when the archive was modified.

Returns:

  • (Time)


1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 1208

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

#retentionTypes::ArchiveRetention

The retention period for emails in this archive.



1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 1208

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