You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::WorkMail::Types::PutRetentionPolicyRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PutRetentionPolicyRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  organization_id: "OrganizationId", # required
  id: "ShortString",
  name: "ShortString", # required
  description: "PolicyDescription",
  folder_configurations: [ # required
    {
      name: "INBOX", # required, accepts INBOX, DELETED_ITEMS, SENT_ITEMS, DRAFTS, JUNK_EMAIL
      action: "NONE", # required, accepts NONE, DELETE, PERMANENTLY_DELETE
      period: 1,
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

The retention policy description.

Returns:

  • (String) —

    The retention policy description.

#folder_configurations ⇒ Array<Types::FolderConfiguration>

The retention policy folder configurations.

Returns:

#id ⇒ String

The retention policy ID.

Returns:

  • (String) —

    The retention policy ID.

#name ⇒ String

The retention policy name.

Returns:

  • (String) —

    The retention policy name.

#organization_id ⇒ String

The organization ID.

Returns:

  • (String) —

    The organization ID.