[ aws . connect ]

create-user-hierarchy-group

Description

Creates a new user hierarchy group.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-user-hierarchy-group
--name <value>
[--parent-group-id <value>]
--instance-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the user hierarchy group. Must not be more than 100 characters.

--parent-group-id (string)

The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.

--instance-id (string)

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

HierarchyGroupId -> (string)

The identifier of the hierarchy group.

HierarchyGroupArn -> (string)

The Amazon Resource Name (ARN) of the hierarchy group.