user_proficiencies
Creates, updates, deletes, gets or lists a user_proficiencies resource.
Overview
| Name | user_proficiencies |
| Type | Resource |
| Id | aws.connect.user_proficiencies |
Fields
The following fields are returned by SELECT queries:
- list_user_proficiencies
| Name | Datatype | Description |
|---|---|---|
attribute_name | string | The name of user's proficiency. You must use name of predefined attribute present in the Connect Customer instance. |
attribute_value | string | The value of user's proficiency. You must use value of predefined attribute present in the Connect Customer instance. |
level | number (float) | The level of the proficiency. The valid values are 1, 2, 3, 4 and 5. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_user_proficiencies | select | instance_id, user_id, region | nextToken, maxResults | Lists proficiencies associated with a user. |
associate_user_proficiencies | update | instance_id, user_id, region, UserProficiencies | Associates a set of proficiencies with a user. | |
disassociate_user_proficiencies | exec | instance_id, user_id, region, UserProficiencies | Disassociates a set of proficiencies from a user. | |
update_user_proficiencies | exec | instance_id, user_id, region, UserProficiencies | Updates the properties associated with the proficiencies of a user. |
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 |
|---|---|---|
instance_id | string | The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. |
region | string | AWS region (default: us-east-1) |
user_id | string | The identifier of the user account. |
maxResults | integer | The maximum number of results to return per page. |
nextToken | string | The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. |
SELECT examples
- list_user_proficiencies
Lists proficiencies associated with a user.
SELECT
attribute_name,
attribute_value,
level
FROM aws.connect.user_proficiencies
WHERE instance_id = '{{ instance_id }}' -- required
AND user_id = '{{ user_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;
UPDATE examples
- associate_user_proficiencies
Associates a set of proficiencies with a user.
UPDATE aws.connect.user_proficiencies
SET
UserProficiencies = '{{ UserProficiencies }}'
WHERE
instance_id = '{{ instance_id }}' --required
AND user_id = '{{ user_id }}' --required
AND region = '{{ region }}' --required
AND UserProficiencies = '{{ UserProficiencies }}' --required;
Lifecycle Methods
- disassociate_user_proficiencies
- update_user_proficiencies
Disassociates a set of proficiencies from a user.
EXEC aws.connect.user_proficiencies.disassociate_user_proficiencies
@instance_id='{{ instance_id }}' --required,
@user_id='{{ user_id }}' --required,
@region='{{ region }}' --required
@@json=
'{
"UserProficiencies": "{{ UserProficiencies }}"
}'
;
Updates the properties associated with the proficiencies of a user.
EXEC aws.connect.user_proficiencies.update_user_proficiencies
@instance_id='{{ instance_id }}' --required,
@user_id='{{ user_id }}' --required,
@region='{{ region }}' --required
@@json=
'{
"UserProficiencies": "{{ UserProficiencies }}"
}'
;