WorkMail / Client / get_default_retention_policy
get_default_retention_policy#
- WorkMail.Client.get_default_retention_policy(**kwargs)#
Gets the default retention policy details for the specified organization.
See also: AWS API Documentation
Request Syntax
response = client.get_default_retention_policy( OrganizationId='string' )
- Parameters:
OrganizationId (string) –
[REQUIRED]
The organization ID.
- Return type:
dict
- Returns:
Response Syntax
{ 'Id': 'string', 'Name': 'string', 'Description': 'string', 'FolderConfigurations': [ { 'Name': 'INBOX'|'DELETED_ITEMS'|'SENT_ITEMS'|'DRAFTS'|'JUNK_EMAIL', 'Action': 'NONE'|'DELETE'|'PERMANENTLY_DELETE', 'Period': 123 }, ] }
Response Structure
(dict) –
Id (string) –
The retention policy ID.
Name (string) –
The retention policy name.
Description (string) –
The retention policy description.
FolderConfigurations (list) –
The retention policy folder configurations.
(dict) –
The configuration applied to an organization’s folders by its retention policy.
Name (string) –
The folder name.
Action (string) –
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.
Exceptions
WorkMail.Client.exceptions.InvalidParameterException
WorkMail.Client.exceptions.OrganizationNotFoundException
WorkMail.Client.exceptions.OrganizationStateException
WorkMail.Client.exceptions.EntityNotFoundException