Menu
Amazon Connect Service
API Reference (API Version 2017-08-08)

UpdateUserHierarchy

Assigns the specified hierarchy group to the user.

Request Syntax

POST /users/InstanceId/UserId/hierarchy HTTP/1.1 Content-type: application/json { "HierarchyGroupId": "string" }

URI Request Parameters

The request requires the following URI parameters.

InstanceId

The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Choose the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

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

UserId

The identifier of the user account to assign the hierarchy group to.

Request Body

The request accepts the following data in JSON format.

HierarchyGroupId

The identifier for the hierarchy group to assign to the user.

Type: String

Required: No

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 due to an error or failure with the service.

HTTP Status Code: 500

InvalidParameterException

One or more of the parameters provided to the operation are not valid.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: