PutRetentionPolicy - Amazon WorkMail

PutRetentionPolicy

Puts a retention policy to the specified organization.

Request Syntax

{ "Description": "string", "FolderConfigurations": [ { "Action": "string", "Name": "string", "Period": number } ], "Id": "string", "Name": "string", "OrganizationId": "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.

Description

The retention policy description.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [\w\d\s\S\-!?=,.;:'_]+

Required: No

FolderConfigurations

The retention policy folder configurations.

Type: Array of FolderConfiguration objects

Required: Yes

Id

The retention policy ID.

Type: String

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

Pattern: [a-zA-Z0-9_-]+

Required: No

Name

The retention policy name.

Type: String

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

Pattern: [a-zA-Z0-9_-]+

Required: Yes

OrganizationId

The organization ID.

Type: String

Pattern: ^m-[0-9a-f]{32}$

Required: Yes

Response Elements

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

Errors

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

InvalidParameterException

One or more of the input parameters don't match the service's restrictions.

HTTP Status Code: 400

LimitExceededException

The request exceeds the limit of the resource.

HTTP Status Code: 400

OrganizationNotFoundException

An operation received a valid organization identifier that either doesn't belong or exist in the system.

HTTP Status Code: 400

OrganizationStateException

The organization must have a valid state (Active or Synchronizing) to perform certain operations on the organization or its members.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: