Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetArchive

Retrieves the full details and current state of a specified email archive.

Request Syntax


{
   "ArchiveId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ArchiveId

The identifier of the archive to retrieve.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 66.

Required: Yes

Response Syntax


{
   "ArchiveArn": "string",
   "ArchiveId": "string",
   "ArchiveName": "string",
   "ArchiveState": "string",
   "CreatedTimestamp": number,
   "KmsKeyArn": "string",
   "LastUpdatedTimestamp": number,
   "Retention": { ... }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ArchiveArn

The Amazon Resource Name (ARN) of the archive.

Type: String

ArchiveId

The unique identifier of the archive.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 66.

ArchiveName

The unique name assigned to the archive.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*[a-zA-Z0-9]$

ArchiveState

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.

Type: String

Valid Values: ACTIVE | PENDING_DELETION

CreatedTimestamp

The timestamp of when the archive was created.

Type: Timestamp

KmsKeyArn

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

Type: String

Pattern: ^arn:aws(|-cn|-us-gov):kms:[a-z0-9-]{1,20}:[0-9]{12}:(key|alias)/.+$

LastUpdatedTimestamp

The timestamp of when the archive was modified.

Type: Timestamp

Retention

The retention period for emails in this archive.

Type: ArchiveRetention object

Note: This object is a Union. Only one member of this object can be specified or returned.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Occurs when a user is denied access to a specific resource or action.

HTTP Status Code: 400

ResourceNotFoundException

Occurs when a requested resource is not found.

HTTP Status Code: 400

ThrottlingException

Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.

HTTP Status Code: 400

ValidationException

The request validation has failed. For details, see the accompanying error message.

HTTP Status Code: 400