Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateArchive

Creates a new email archive resource for storing and retaining emails.

Request Syntax


{
   "ArchiveName": "string",
   "ClientToken": "string",
   "KmsKeyArn": "string",
   "Retention": { ... },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "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.

ArchiveName

A unique name for the new 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]$

Required: Yes

ClientToken

A unique token Amazon SES uses to recognize retries of this request.

Type: String

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

Required: No

KmsKeyArn

The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.

Type: String

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

Required: No

Retention

The period for retaining emails in the archive before automatic deletion.

Type: ArchiveRetention object

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

Required: No

Tags

The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Response Syntax


{
   "ArchiveId": "string"
}

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.

ArchiveId

The unique identifier for the newly created archive.

Type: String

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

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

ConflictException

The request configuration has conflicts. For details, see the accompanying error message.

HTTP Status Code: 400

ServiceQuotaExceededException

Occurs when an operation exceeds a predefined service quota or limit.

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