users_counts
Creates, updates, deletes, gets or lists a users_counts resource.
Overview
| Name | users_counts |
| Type | Resource |
| Id | aws.wickr.users_counts |
Fields
The following fields are returned by SELECT queries:
- get_users_count
| Name | Datatype | Description |
|---|---|---|
active | integer | The number of users with active status in the network. |
pending | integer | The number of users with pending status (invited but not yet accepted). |
rejected | integer | The number of users who have rejected network invitations. |
remaining | integer | The number of additional users that can be added to the network while maintaining premium free trial eligibility. |
total | integer | The total number of users in the network (active and pending combined). |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_users_count | select | network_id, region | Retrieves the count of users in a Wickr network, categorized by their status (pending, active, rejected) and showing how many users can still be added. |
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 for which to retrieve user counts. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_users_count
Retrieves the count of users in a Wickr network, categorized by their status (pending, active, rejected) and showing how many users can still be added.
SELECT
active,
pending,
rejected,
remaining,
total
FROM aws.wickr.users_counts
WHERE network_id = '{{ network_id }}' -- required
AND region = '{{ region }}' -- required
;