Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateUserHierarchyStructure

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

Request Syntax


POST /user-hierarchy-structure/InstanceId HTTP/1.1
Content-type: application/json

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

URI Request Parameters

The request uses the following URI parameters.

InstanceId

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

Request Body

The request accepts the following data in JSON format.

HierarchyStructure

The hierarchy levels to update.

Type: HierarchyStructureUpdate object

Required: Yes

Response Syntax


HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

Request processing failed because of an error or failure with the service.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceInUseException

That resource is already in use. Please try another.

HTTP Status Code: 409

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429