retention_settings

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

Overview

Name	retention_settings
Type	Resource
Id	aws.chime.retention_settings

Fields

The following fields are returned by SELECT queries:

get_retention_settings

Name	Datatype	Description
initiate_deletion_timestamp	string (date-time)	The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.
retention_settings	object	The retention settings.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_retention_settings	select	account_id, region		Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.
put_retention_settings	replace	account_id, region, RetentionSettings		Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide. To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.

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
account_id	string	The Amazon Chime account ID.
region	string	AWS region (default: us-east-1)

SELECT examples

get_retention_settings

Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.

SELECT
initiate_deletion_timestamp,
retention_settings
FROM aws.chime.retention_settings
WHERE account_id = '{{ account_id }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_retention_settings

Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide. To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.

REPLACE aws.chime.retention_settings
SET 
RetentionSettings = '{{ RetentionSettings }}'
WHERE 
account_id = '{{ account_id }}' --required
AND region = '{{ region }}' --required
AND RetentionSettings = '{{ RetentionSettings }}' --required
RETURNING
initiate_deletion_timestamp,
retention_settings;