default_retention_policies

Creates, updates, deletes, gets or lists a default_retention_policies resource.

Overview

Name	default_retention_policies
Type	Resource
Id	aws.workmail.default_retention_policies

Fields

The following fields are returned by SELECT queries:

get_default_retention_policy

Name	Datatype	Description
description	string	The retention policy description.
folder_configurations	array	The retention policy folder configurations.
id	string	The retention policy ID. (pattern: <code>[a-zA-Z0-9_-]+</code>)
name	string	The retention policy name. (pattern: <code>[a-zA-Z0-9_-]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_default_retention_policy	select	region		Gets the default retention policy details for the specified organization.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_default_retention_policy

Gets the default retention policy details for the specified organization.

SELECT
description,
folder_configurations,
id,
name
FROM aws.workmail.default_retention_policies
WHERE region = '{{ region }}' -- required
;