create_user_hierarchy_group ¶

def create_user_hierarchy_group(
    self,
    name: "capo_connect.types.hierarchy_group_name.HierarchyGroupName",
    instance_id: "capo_connect.types.instance_id.InstanceId",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
    parent_group_id: Optional[
        "capo_connect.types.hierarchy_group_id.HierarchyGroupId"
    ] = None,
    tags: Optional["capo_connect.types.tag_map.TagMap"] = None,
) -> "capo_connect.types.create_user_hierarchy_group_response.CreateUserHierarchyGroupResponse":
    """<p>Creates a new user hierarchy group.</p>

    Args:
        name: <p>The name of the user hierarchy group. Must not be more than 100 characters.</p>
        parent_group_id: <p>The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.</p>
        instance_id: <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
        tags: <p>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</p>

    Raises:
        capo_connect.errors.duplicate_resource_exception.DuplicateResourceException: <p>A resource with the specified name already exists.</p>
        capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
        capo_connect.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the specified parameters are not valid.</p>
        capo_connect.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_connect.errors.limit_exceeded_exception.LimitExceededException: <p>The allowed limit for the resource has been exceeded.</p>
        capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_connect.types.create_user_hierarchy_group_request.CreateUserHierarchyGroupRequest]",
    ) -> OperationResponse[
        "capo_connect.types.create_user_hierarchy_group_response.CreateUserHierarchyGroupResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.create_user_hierarchy_group

        output, http_response = (
            capo_connect._operations.amazon_connect_service.create_user_hierarchy_group.create_user_hierarchy_group(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateUserHierarchyGroup")
    )
    input_: capo_connect.types.create_user_hierarchy_group_request.CreateUserHierarchyGroupRequest = {
        "name": name,
        "instance_id": instance_id,
    }
    if parent_group_id is not None:
        input_["parent_group_id"] = parent_group_id
    if tags is not None:
        input_["tags"] = tags

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output