put_retention_policy

WorkMail.Client.put_retention_policy(**kwargs)

Puts a retention policy to the specified organization.

See also: AWS API Documentation

Request Syntax

response = client.put_retention_policy(
    OrganizationId='string',
    Id='string',
    Name='string',
    Description='string',
    FolderConfigurations=[
        {
            'Name': 'INBOX'|'DELETED_ITEMS'|'SENT_ITEMS'|'DRAFTS'|'JUNK_EMAIL',
            'Action': 'NONE'|'DELETE'|'PERMANENTLY_DELETE',
            'Period': 123
        },
    ]
)

Parameters

• OrganizationId (string) --

  [REQUIRED]

  The organization ID.

• Id (string) -- The retention policy ID.
• Name (string) --

  [REQUIRED]

  The retention policy name.

• Description (string) -- The retention policy description.
• FolderConfigurations (list) --

  [REQUIRED]

  The retention policy folder configurations.

  • (dict) --

    The configuration applied to an organization's folders by its retention policy.

    • Name (string) -- [REQUIRED]

      The folder name.

    • Action (string) -- [REQUIRED]

      The action to take on the folder contents at the end of the folder configuration period.

    • Period (integer) --

      The number of days for which the folder-configuration action applies.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) --

Exceptions

• WorkMail.Client.exceptions.InvalidParameterException
• WorkMail.Client.exceptions.OrganizationNotFoundException
• WorkMail.Client.exceptions.OrganizationStateException
• WorkMail.Client.exceptions.LimitExceededException