bots

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

Overview

Name	bots
Type	Resource
Id	aws.wickr.bots

Fields

The following fields are returned by SELECT queries:

get_bot

Name	Datatype	Description
bot_id	string	The unique identifier of the bot. (pattern: <code>[\S\s]*</code>)
display_name	string	The display name of the bot that is visible to users. (pattern: <code>[\S\s]*</code>)
group_id	string	The ID of the security group to which the bot belongs. (pattern: <code>[\S\s]*</code>)
has_challenge	boolean	Indicates whether the bot has a password set.
last_login	string	The timestamp of the bot's last login. (pattern: <code>[\S\s]*</code>)
pubkey	string	The public key of the bot used for encryption. (pattern: <code>[\S\s]*</code>)
status	integer	The current status of the bot (1 for pending, 2 for active).
suspended	boolean	Indicates whether the bot is currently suspended.
uname	string	The unique username hash identifier for the bot. (pattern: <code>[\S\s]*</code>)
username	string	The username of the bot. (pattern: <code>[\S\s]*</code>)

list_bots

Name	Datatype	Description
bot_id	string	The unique identifier of the bot. (pattern: <code>[\S\s]*</code>)
display_name	string	The display name of the bot that is visible to users. (pattern: <code>[\S\s]*</code>)
group_id	string	The ID of the security group to which the bot belongs. (pattern: <code>[\S\s]*</code>)
has_challenge	boolean	Indicates whether the bot has a password set.
last_login	string	The timestamp of the bot's last login. (pattern: <code>[\S\s]*</code>)
pubkey	string	The public key of the bot used for encryption. (pattern: <code>[\S\s]*</code>)
status	integer	The current status of the bot (1 for pending, 2 for active).
suspended	boolean	Indicates whether the bot is currently suspended.
uname	string	The unique username hash identifier for the bot. (pattern: <code>[\S\s]*</code>)
username	string	The username of the bot. (pattern: <code>[\S\s]*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_bot	select	network_id, bot_id, region		Retrieves detailed information about a specific bot in a Wickr network, including its status, group membership, and authentication details.
list_bots	select	network_id, region	nextToken, maxResults, sortFields, sortDirection, displayName, username, status, groupId	Retrieves a paginated list of bots in a specified Wickr network. You can filter and sort the results based on various criteria.
create_bot	insert	network_id, region, username, groupId, challenge		Creates a new bot in a specified Wickr network. Bots are automated accounts that can send and receive messages, enabling integration with external systems and automation of tasks.
update_bot	update	network_id, bot_id, region		Updates the properties of an existing bot in a Wickr network. This operation allows you to modify the bot's display name, security group, password, or suspension status.
delete_bot	delete	network_id, bot_id, region		Deletes a bot from a specified Wickr network. This operation permanently removes the bot account and its associated data from 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
bot_id	string	The unique identifier of the bot to be deleted.
network_id	string	The ID of the Wickr network from which the bot will be deleted.
region	string	AWS region (default: us-east-1)
displayName	string	Filter results to only include bots with display names matching this value.
groupId	string	Filter results to only include bots belonging to this security group.
maxResults	integer	The maximum number of bots to return in a single page. Valid range is 1-100. Default is 10.
nextToken	string	The token for retrieving the next page of results. This is returned from a previous request when there are more results available.
sortDirection	string	The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.
sortFields	string	The fields to sort bots by. Multiple fields can be specified by separating them with '+'. Accepted values include 'username', 'firstName', 'displayName', 'status', and 'groupId'.
status	integer	Filter results to only include bots with this status (1 for pending, 2 for active).
username	string	Filter results to only include bots with usernames matching this value.

SELECT examples

get_bot

Retrieves detailed information about a specific bot in a Wickr network, including its status, group membership, and authentication details.

SELECT
bot_id,
display_name,
group_id,
has_challenge,
last_login,
pubkey,
status,
suspended,
uname,
username
FROM aws.wickr.bots
WHERE network_id = '{{ network_id }}' -- required
AND bot_id = '{{ bot_id }}' -- required
AND region = '{{ region }}' -- required
;

list_bots

Retrieves a paginated list of bots in a specified Wickr network. You can filter and sort the results based on various criteria.

SELECT
bot_id,
display_name,
group_id,
has_challenge,
last_login,
pubkey,
status,
suspended,
uname,
username
FROM aws.wickr.bots
WHERE network_id = '{{ network_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND sortFields = '{{ sortFields }}'
AND sortDirection = '{{ sortDirection }}'
AND displayName = '{{ displayName }}'
AND username = '{{ username }}'
AND status = '{{ status }}'
AND groupId = '{{ groupId }}'
;

INSERT examples

create_bot

Creates a new bot in a specified Wickr network. Bots are automated accounts that can send and receive messages, enabling integration with external systems and automation of tasks.

INSERT INTO aws.wickr.bots (
username,
displayName,
groupId,
challenge,
network_id,
region
)
SELECT 
'{{ username }}' /* required */,
'{{ displayName }}',
'{{ groupId }}' /* required */,
'{{ challenge }}' /* required */,
'{{ network_id }}',
'{{ region }}'
RETURNING
bot_id,
display_name,
group_id,
message,
network_id,
username
;

Manifest

# Description fields are for documentation purposes
- name: bots
props:
  - name: network_id
    value: "{{ network_id }}"
    description: Required parameter for the bots resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the bots resource.
  - name: username
    value: "{{ username }}"
  - name: displayName
    value: "{{ displayName }}"
  - name: groupId
    value: "{{ groupId }}"
  - name: challenge
    value: "{{ challenge }}"

UPDATE examples

update_bot

Updates the properties of an existing bot in a Wickr network. This operation allows you to modify the bot's display name, security group, password, or suspension status.

UPDATE aws.wickr.bots
SET 
displayName = '{{ displayName }}',
groupId = '{{ groupId }}',
challenge = '{{ challenge }}',
suspend = {{ suspend }}
WHERE 
network_id = '{{ network_id }}' --required
AND bot_id = '{{ bot_id }}' --required
AND region = '{{ region }}' --required
RETURNING
message;

DELETE examples

delete_bot

Deletes a bot from a specified Wickr network. This operation permanently removes the bot account and its associated data from the network.

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