user_hierarchy_structures

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

Overview

Name	user_hierarchy_structures
Type	Resource
Id	aws.connect.user_hierarchy_structures

Fields

The following fields are returned by SELECT queries:

describe_user_hierarchy_structure

Name	Datatype	Description
level_five	object	Information about level five.
level_four	object	Information about level four.
level_one	object	Information about level one.
level_three	object	Information about level three.
level_two	object	Information about level two.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_user_hierarchy_structure	select	instance_id, region		Describes the hierarchy structure of the specified Connect Customer instance.
update_user_hierarchy_structure	update	instance_id, region, HierarchyStructure		Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.

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)

SELECT examples

describe_user_hierarchy_structure

Describes the hierarchy structure of the specified Connect Customer instance.

SELECT
level_five,
level_four,
level_one,
level_three,
level_two
FROM aws.connect.user_hierarchy_structures
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_user_hierarchy_structure

Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.

UPDATE aws.connect.user_hierarchy_structures
SET 
HierarchyStructure = '{{ HierarchyStructure }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND region = '{{ region }}' --required
AND HierarchyStructure = '{{ HierarchyStructure }}' --required;