Amazon WorkMail

Puts a retention policy to the specified organization.

See also: AWS API Documentation

Request Syntax

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
        },
    ]
)

type OrganizationId:

string

param OrganizationId:

[REQUIRED]

The organization ID.

type Id:

string

param Id:

The retention policy ID.

type Name:

string

param Name:

[REQUIRED]

The retention policy name.

type Description:

string

param Description:

The retention policy description.

type FolderConfigurations:

list

param FolderConfigurations:

[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 period of time at which the folder configuration action is applied.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Gets the default retention policy details for the specified organization.

See also: AWS API Documentation

Request Syntax

client.get_default_retention_policy(
    OrganizationId='string'
)

type OrganizationId:

string

param OrganizationId:

[REQUIRED]

The organization ID.

rtype:

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 period of time at which the folder configuration action is applied.

Deletes the specified retention policy from the specified organization.

See also: AWS API Documentation

Request Syntax

client.delete_retention_policy(
    OrganizationId='string',
    Id='string'
)

type OrganizationId:

string

param OrganizationId:

[REQUIRED]

The organization ID.

type Id:

string

param Id:

[REQUIRED]

The retention policy ID.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --