data_retention_bots

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

Overview

Name	data_retention_bots
Type	Resource
Id	aws.wickr.data_retention_bots

Fields

The following fields are returned by SELECT queries:

get_data_retention_bot

Name	Datatype	Description
bot_exists	boolean	Indicates whether a data retention bot exists in the network.
bot_name	string	The name of the data retention bot. (pattern: <code>[\S\s]*</code>)
is_bot_active	boolean	Indicates whether the data retention bot is active and operational.
is_data_retention_bot_registered	boolean	Indicates whether the data retention bot has been registered with the network.
is_data_retention_service_enabled	boolean	Indicates whether the data retention service is enabled for the network.
is_pubkey_msg_acked	boolean	Indicates whether the public key message has been acknowledged by the bot.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_data_retention_bot	select	network_id, region		Retrieves information about the data retention bot in a Wickr network, including its status and whether the data retention service is enabled.
create_data_retention_bot	insert	network_id, region		Creates a data retention bot in a Wickr network. Data retention bots are specialized bots that handle message archiving and compliance by capturing and storing messages for regulatory or organizational requirements.
delete_data_retention_bot	delete	network_id, region		Deletes the data retention bot from a Wickr network. This operation permanently removes the bot and all its associated data from the database.
create_data_retention_bot_challenge	exec	network_id, region		Creates a new challenge password for the data retention bot. This password is used for authentication when the bot connects to the network.

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
network_id	string	The ID of the Wickr network containing the data retention bot.
region	string	AWS region (default: us-east-1)

SELECT examples

get_data_retention_bot

Retrieves information about the data retention bot in a Wickr network, including its status and whether the data retention service is enabled.

SELECT
bot_exists,
bot_name,
is_bot_active,
is_data_retention_bot_registered,
is_data_retention_service_enabled,
is_pubkey_msg_acked
FROM aws.wickr.data_retention_bots
WHERE network_id = '{{ network_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_data_retention_bot

Creates a data retention bot in a Wickr network. Data retention bots are specialized bots that handle message archiving and compliance by capturing and storing messages for regulatory or organizational requirements.

INSERT INTO aws.wickr.data_retention_bots (
network_id,
region
)
SELECT 
'{{ network_id }}',
'{{ region }}'
RETURNING
message
;

Manifest

# Description fields are for documentation purposes
- name: data_retention_bots
props:
  - name: network_id
    value: "{{ network_id }}"
    description: Required parameter for the data_retention_bots resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the data_retention_bots resource.

DELETE examples

delete_data_retention_bot

Deletes the data retention bot from a Wickr network. This operation permanently removes the bot and all its associated data from the database.

DELETE FROM aws.wickr.data_retention_bots
WHERE network_id = '{{ network_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

create_data_retention_bot_challenge

Creates a new challenge password for the data retention bot. This password is used for authentication when the bot connects to the network.

EXEC aws.wickr.data_retention_bots.create_data_retention_bot_challenge 
@network_id='{{ network_id }}' --required, 
@region='{{ region }}' --required
;