[ aws . connect ]

update-user-hierarchy-structure

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-user-hierarchy-structure
--hierarchy-structure <value>
--instance-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--hierarchy-structure (structure)

The hierarchy levels to update.

LevelOne -> (structure)

The update for level one.

Name -> (string)

The name of the user hierarchy level. Must not be more than 50 characters.

LevelTwo -> (structure)

The update for level two.

Name -> (string)

The name of the user hierarchy level. Must not be more than 50 characters.

LevelThree -> (structure)

The update for level three.

Name -> (string)

The name of the user hierarchy level. Must not be more than 50 characters.

LevelFour -> (structure)

The update for level four.

Name -> (string)

The name of the user hierarchy level. Must not be more than 50 characters.

LevelFive -> (structure)

The update for level five.

Name -> (string)

The name of the user hierarchy level. Must not be more than 50 characters.

Shorthand Syntax:

LevelOne={Name=string},LevelTwo={Name=string},LevelThree={Name=string},LevelFour={Name=string},LevelFive={Name=string}

JSON Syntax:

{
  "LevelOne": {
    "Name": "string"
  },
  "LevelTwo": {
    "Name": "string"
  },
  "LevelThree": {
    "Name": "string"
  },
  "LevelFour": {
    "Name": "string"
  },
  "LevelFive": {
    "Name": "string"
  }
}

--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

None