users

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

Overview

Name	users
Type	Resource
Id	aws.qbusiness.users

Fields

The following fields are returned by SELECT queries:

get_user

Name	Datatype	Description
user_aliases	array	A list of user aliases attached to a user.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_user	select	application_id, user_id, region		Describes the universally unique identifier (UUID) associated with a local user in a data source.
create_user	insert	application_id, region, userId		Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
update_user	update	application_id, user_id, region		Updates a information associated with a user id.
delete_user	delete	application_id, user_id, region		Deletes a user by email id.

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
application_id	string	The identifier of the application from which the user is being deleted.
region	string	AWS region (default: us-east-1)
user_id	string	The user email being deleted.

SELECT examples

get_user

Describes the universally unique identifier (UUID) associated with a local user in a data source.

SELECT
user_aliases
FROM aws.qbusiness.users
WHERE application_id = '{{ application_id }}' -- required
AND user_id = '{{ user_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_user

Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.

INSERT INTO aws.qbusiness.users (
userId,
userAliases,
clientToken,
application_id,
region
)
SELECT 
'{{ userId }}' /* required */,
'{{ userAliases }}',
'{{ clientToken }}',
'{{ application_id }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: users
props:
  - name: application_id
    value: "{{ application_id }}"
    description: Required parameter for the users resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the users resource.
  - name: userId
    value: "{{ userId }}"
  - name: userAliases
    value:
      - indexId: "{{ indexId }}"
        dataSourceId: "{{ dataSourceId }}"
        userId: "{{ userId }}"
  - name: clientToken
    value: "{{ clientToken }}"

UPDATE examples

update_user

Updates a information associated with a user id.

UPDATE aws.qbusiness.users
SET 
userAliasesToUpdate = '{{ userAliasesToUpdate }}',
userAliasesToDelete = '{{ userAliasesToDelete }}'
WHERE 
application_id = '{{ application_id }}' --required
AND user_id = '{{ user_id }}' --required
AND region = '{{ region }}' --required
RETURNING
user_aliases_added,
user_aliases_deleted,
user_aliases_updated;

DELETE examples

delete_user

Deletes a user by email id.

DELETE FROM aws.qbusiness.users
WHERE application_id = '{{ application_id }}' --required
AND user_id = '{{ user_id }}' --required
AND region = '{{ region }}' --required
;