guest_users

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

Overview

Name	guest_users
Type	Resource
Id	aws.wickr.guest_users

Fields

The following fields are returned by SELECT queries:

list_guest_users

Name	Datatype	Description
billing_period	string	The billing period when this guest user accessed the network (e.g., '2024-01'). (pattern: <code>[\S\s]*</code>)
username	string	The username of the guest user. (pattern: <code>[\S\s]*</code>)
username_hash	string	The unique username hash identifier for the guest user. (pattern: <code>[\S\s]*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_guest_users	select	network_id, region	maxResults, sortDirection, sortFields, username, billingPeriod, nextToken	Retrieves a paginated list of guest users who have communicated with your Wickr network. Guest users are external users from federated networks who can communicate with network members.
update_guest_user	update	network_id, username_hash, region, block		Updates the block status of a guest user in a Wickr network. This operation allows you to block or unblock a guest user from accessing 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 where the guest user's status will be updated.
region	string	AWS region (default: us-east-1)
username_hash	string	The username hash (unique identifier) of the guest user to update.
billingPeriod	string	Filter results to only include guest users from this billing period (e.g., '2024-01').
maxResults	integer	The maximum number of guest users 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 field to sort guest users by. Accepted values include 'username' and 'billingPeriod'.
username	string	Filter results to only include guest users with usernames matching this value.

SELECT examples

list_guest_users

Retrieves a paginated list of guest users who have communicated with your Wickr network. Guest users are external users from federated networks who can communicate with network members.

SELECT
billing_period,
username,
username_hash
FROM aws.wickr.guest_users
WHERE network_id = '{{ network_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND sortDirection = '{{ sortDirection }}'
AND sortFields = '{{ sortFields }}'
AND username = '{{ username }}'
AND billingPeriod = '{{ billingPeriod }}'
AND nextToken = '{{ nextToken }}'
;

UPDATE examples

update_guest_user

Updates the block status of a guest user in a Wickr network. This operation allows you to block or unblock a guest user from accessing the network.

UPDATE aws.wickr.guest_users
SET 
block = {{ block }}
WHERE 
network_id = '{{ network_id }}' --required
AND username_hash = '{{ username_hash }}' --required
AND region = '{{ region }}' --required
AND block = {{ block }} --required
RETURNING
message;