Amazon Connect

Amazon Connect Connect User Hierarchy Groups API

The Connect User Hierarchy Groups API from Amazon Connect — 2 operation(s) for connect user hierarchy groups.

Documentation GitHub OpenAPI

Operations 3

PUT /user-hierarchy-groups/{InstanceId} Create User Hierarchy Group #

DELETE /user-hierarchy-groups/{InstanceId}/{HierarchyGroupId} Delete User Hierarchy Group #

GET /user-hierarchy-groups/{InstanceId}/{HierarchyGroupId} Describe User Hierarchy Group #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/amazon-connect/openapi/amazon-connect-user-hierarchy-groups-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-connect:amazon-connect-user-hierarchy-groups-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.1.0
info:
  title: Amazon Connect Service User Hierarchy Groups API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://connect.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /user-hierarchy-groups/{InstanceId}:
    put:
      operationId: CreateUserHierarchyGroup
      summary: Create User Hierarchy Group
      description: Creates a new user hierarchy group.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateUserHierarchyGroupResponse'
        '409':
          description: DuplicateResourceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DuplicateResourceException'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '429':
          description: LimitExceededException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUserHierarchyGroupRequest'
      tags:
      - User Hierarchy Groups
  /user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}:
    delete:
      operationId: DeleteUserHierarchyGroup
      summary: Delete User Hierarchy Group
      description: Deletes an existing user hierarchy group. It must not be associated with any agents or have any active
        child groups.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '409':
          description: ResourceInUseException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceInUseException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteUserHierarchyGroupRequest'
      tags:
      - User Hierarchy Groups
    get:
      operationId: DescribeUserHierarchyGroup
      summary: Describe User Hierarchy Group
      description: Describes the specified hierarchy group.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeUserHierarchyGroupResponse'
        '500':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '400':
          description: InvalidParameterException; InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeUserHierarchyGroupRequest'
      tags:
      - User Hierarchy Groups
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: connect
  schemas:
    CreateUserHierarchyGroupRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the user hierarchy group. Must not be more than 100 characters.
        ParentGroupId:
          type: string
          description: The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent
            group ID is null.
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1",
            "key2":"value2"} }.'
      required:
      - Name
      - InstanceId
    CreateUserHierarchyGroupResponse:
      type: object
      properties:
        HierarchyGroupId:
          type: string
          description: The identifier of the hierarchy group.
        HierarchyGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the hierarchy group.
    DeleteUserHierarchyGroupRequest:
      type: object
      properties:
        HierarchyGroupId:
          type: string
          description: The identifier of the hierarchy group.
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
      required:
      - HierarchyGroupId
      - InstanceId
    DescribeUserHierarchyGroupRequest:
      type: object
      properties:
        HierarchyGroupId:
          type: string
          description: The identifier of the hierarchy group.
        InstanceId:
          type: string
          description: The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource
            Name (ARN) of the instance.
      required:
      - HierarchyGroupId
      - InstanceId
    DescribeUserHierarchyGroupResponse:
      type: object
      properties:
        HierarchyGroup:
          $ref: '#/components/schemas/HierarchyGroup'
    DuplicateResourceException:
      type: object
      properties:
        Message:
          type: string
    HierarchyGroup:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of the hierarchy group.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the hierarchy group.
        Name:
          type: string
          description: The name of the hierarchy group.
        LevelId:
          type: string
          description: The identifier of the level in the hierarchy group.
        HierarchyPath:
          $ref: '#/components/schemas/HierarchyPath'
        Tags:
          type: object
          additionalProperties:
            type: string
          description: 'The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1",
            "key2":"value2"} }.'
        LastModifiedTime:
          type: string
          format: date-time
          description: The timestamp when this resource was last modified.
        LastModifiedRegion:
          type: string
          description: The Amazon Web Services Region where this resource was last modified.
    HierarchyGroupSummary:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of the hierarchy group.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the hierarchy group.
        Name:
          type: string
          description: The name of the hierarchy group.
        LastModifiedTime:
          type: string
          format: date-time
          description: The timestamp when this resource was last modified.
        LastModifiedRegion:
          type: string
          description: The Amazon Web Services Region where this resource was last modified.
    HierarchyPath:
      type: object
      properties:
        LevelOne:
          $ref: '#/components/schemas/HierarchyGroupSummary'
        LevelTwo:
          $ref: '#/components/schemas/HierarchyGroupSummary'
        LevelThree:
          $ref: '#/components/schemas/HierarchyGroupSummary'
        LevelFour:
          $ref: '#/components/schemas/HierarchyGroupSummary'
        LevelFive:
          $ref: '#/components/schemas/HierarchyGroupSummary'
    InternalServiceException:
      type: object
      properties:
        Message:
          type: string
          description: The message.
    InvalidParameterException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the parameters.
    LimitExceededException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the limit.
    ResourceInUseException:
      type: object
      properties:
        Message:
          type: string
        ResourceType:
          type: string
          enum:
          - CONTACT
          - CONTACT_FLOW
          - INSTANCE
          - PARTICIPANT
          - HIERARCHY_LEVEL
          - HIERARCHY_GROUP
          - USER
          - PHONE_NUMBER
          description: The type of resource.
        ResourceId:
          type: string
          description: The identifier for the resource.
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: The message about the resource.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/connect/service/2017-08-08/connect-2017-08-08.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)