UpdateArchive

Updates the attributes of an existing email archive.

Request Syntax


{
   "ArchiveId": "string",
   "ArchiveName": "string",
   "Retention": { ... }
}

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

The request accepts the following data in JSON format.

The identifier of the archive to update.

Type: String

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

Required: Yes

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

Required: No

A new retention period for emails in the archive.

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

Required: No

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

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

ResourceNotFoundException

Occurs when a requested resource is not found.

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