blocked_guest_users

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

Overview

Name	blocked_guest_users
Type	Resource
Id	aws.wickr.blocked_guest_users

Fields

The following fields are returned by SELECT queries:

list_blocked_guest_users

Name	Datatype	Description
admin	string	The username of the administrator who blocked this guest user. (pattern: <code>[\S\s]*</code>)
modified	string	The timestamp when the guest user was blocked or last modified. (pattern: <code>[\S\s]*</code>)
username	string	The username of the blocked guest user. (pattern: <code>[\S\s]*</code>)
username_hash	string	The unique username hash identifier for the blocked 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_blocked_guest_users	select	network_id, region	maxResults, sortDirection, sortFields, username, admin, nextToken	Retrieves a paginated list of guest users who have been blocked from a Wickr network. You can filter and sort the results.

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 from which to list blocked guest users.
region	string	AWS region (default: us-east-1)
admin	string	Filter results to only include blocked guest users that were blocked by this administrator.
maxResults	integer	The maximum number of blocked 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 blocked guest users by. Accepted values include 'username', 'admin', and 'modified'.
username	string	Filter results to only include blocked guest users with usernames matching this value.

SELECT examples

list_blocked_guest_users

Retrieves a paginated list of guest users who have been blocked from a Wickr network. You can filter and sort the results.

SELECT
admin,
modified,
username,
username_hash
FROM aws.wickr.blocked_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 admin = '{{ admin }}'
AND nextToken = '{{ nextToken }}'
;