user_hierarchy_groups

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

Overview

Name	user_hierarchy_groups
Type	Resource
Id	aws.connect.user_hierarchy_groups

Fields

The following fields are returned by SELECT queries:

describe_user_hierarchy_group

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the hierarchy group.
hierarchy_path	object	Information about the levels in the hierarchy group.
id	string	The identifier of the hierarchy group.
last_modified_region	string	The Amazon Web Services Region where this resource was last modified. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
last_modified_time	string (date-time)	The timestamp when this resource was last modified.
level_id	string	The identifier of the level in the hierarchy group.
name	string	The name of the hierarchy group.
tags	object	The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

list_user_hierarchy_groups

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the hierarchy group.
id	string	The identifier of the hierarchy group.
last_modified_region	string	The Amazon Web Services Region where this resource was last modified. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
last_modified_time	string (date-time)	The timestamp when this resource was last modified.
name	string	The name of the hierarchy group.

search_user_hierarchy_groups

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the hierarchy group.
hierarchy_path	object	Information about the levels in the hierarchy group.
id	string	The identifier of the hierarchy group.
last_modified_region	string	The Amazon Web Services Region where this resource was last modified. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
last_modified_time	string (date-time)	The timestamp when this resource was last modified.
level_id	string	The identifier of the level in the hierarchy group.
name	string	The name of the hierarchy group.
tags	object	The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_user_hierarchy_group	select	hierarchy_group_id, instance_id, region		Describes the specified hierarchy group.
list_user_hierarchy_groups	select	instance_id, region	nextToken, maxResults	Provides summary information about the hierarchy groups for the specified Connect Customer instance. For more information about agent hierarchies, see Set Up Agent Hierarchies in the Connect Customer Administrator Guide.
search_user_hierarchy_groups	select	region		Searches UserHierarchyGroups in an Connect Customer instance, with optional filtering. The UserHierarchyGroup with "LevelId": "0" is the foundation for building levels on top of an instance. It is not user-definable, nor is it visible in the UI.
create_user_hierarchy_group	insert	instance_id, region		Creates a new user hierarchy group.
update_user_hierarchy_group_name	update	hierarchy_group_id, instance_id, region		Updates the name of the user hierarchy group.
delete_user_hierarchy_group	delete	hierarchy_group_id, instance_id, region		Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.

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
hierarchy_group_id	string	The identifier of the hierarchy group.
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)
maxResults	integer	The maximum number of results to return per page. The default MaxResult size is 100.
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

describe_user_hierarchy_group

Describes the specified hierarchy group.

SELECT
arn,
hierarchy_path,
id,
last_modified_region,
last_modified_time,
level_id,
name,
tags
FROM aws.connect.user_hierarchy_groups
WHERE hierarchy_group_id = '{{ hierarchy_group_id }}' -- required
AND instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
;

list_user_hierarchy_groups

Provides summary information about the hierarchy groups for the specified Connect Customer instance. For more information about agent hierarchies, see Set Up Agent Hierarchies in the Connect Customer Administrator Guide.

SELECT
arn,
id,
last_modified_region,
last_modified_time,
name
FROM aws.connect.user_hierarchy_groups
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

search_user_hierarchy_groups

Searches UserHierarchyGroups in an Connect Customer instance, with optional filtering. The UserHierarchyGroup with "LevelId": "0" is the foundation for building levels on top of an instance. It is not user-definable, nor is it visible in the UI.

SELECT
arn,
hierarchy_path,
id,
last_modified_region,
last_modified_time,
level_id,
name,
tags
FROM aws.connect.user_hierarchy_groups
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_user_hierarchy_group

Creates a new user hierarchy group.

INSERT INTO aws.connect.user_hierarchy_groups (
Name,
ParentGroupId,
Tags,
instance_id,
region
)
SELECT 
'{{ Name }}',
'{{ ParentGroupId }}',
'{{ Tags }}',
'{{ instance_id }}',
'{{ region }}'
RETURNING
hierarchy_group_arn,
hierarchy_group_id
;

Manifest

# Description fields are for documentation purposes
- name: user_hierarchy_groups
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the user_hierarchy_groups resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the user_hierarchy_groups resource.
  - name: Name
    value: "{{ Name }}"
  - name: ParentGroupId
    value: "{{ ParentGroupId }}"
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

update_user_hierarchy_group_name

Updates the name of the user hierarchy group.

UPDATE aws.connect.user_hierarchy_groups
SET 
Name = '{{ Name }}'
WHERE 
hierarchy_group_id = '{{ hierarchy_group_id }}' --required
AND instance_id = '{{ instance_id }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_user_hierarchy_group

Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.

DELETE FROM aws.connect.user_hierarchy_groups
WHERE hierarchy_group_id = '{{ hierarchy_group_id }}' --required
AND instance_id = '{{ instance_id }}' --required
AND region = '{{ region }}' --required
;