app_instance_retention_settings

Creates, updates, deletes, gets or lists an app_instance_retention_settings resource.

Overview

Name	app_instance_retention_settings
Type	Resource
Id	aws.chime_sdk_identity.app_instance_retention_settings

Fields

The following fields are returned by SELECT queries:

get_app_instance_retention_settings

Name	Datatype	Description
app_instance_retention_settings	object	The retention settings for the AppInstance.
initiate_deletion_timestamp	string (date-time)	The timestamp representing the time at which the specified items are retained, in Epoch Seconds.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_app_instance_retention_settings	select	app_instance_arn, region		Gets the retention settings for an AppInstance.
put_app_instance_retention_settings	replace	app_instance_arn, region, AppInstanceRetentionSettings		Sets the amount of time in days that a given AppInstance retains data.

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
app_instance_arn	string	The ARN of the AppInstance.
region	string	AWS region (default: us-east-1)

SELECT examples

get_app_instance_retention_settings

Gets the retention settings for an AppInstance.

SELECT
app_instance_retention_settings,
initiate_deletion_timestamp
FROM aws.chime_sdk_identity.app_instance_retention_settings
WHERE app_instance_arn = '{{ app_instance_arn }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_app_instance_retention_settings

Sets the amount of time in days that a given AppInstance retains data.

REPLACE aws.chime_sdk_identity.app_instance_retention_settings
SET 
AppInstanceRetentionSettings = '{{ AppInstanceRetentionSettings }}'
WHERE 
app_instance_arn = '{{ app_instance_arn }}' --required
AND region = '{{ region }}' --required
AND AppInstanceRetentionSettings = '{{ AppInstanceRetentionSettings }}' --required
RETURNING
app_instance_retention_settings,
initiate_deletion_timestamp;