search_user_hierarchy_groups ¶

def search_user_hierarchy_groups(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
    next_token: Optional["capo_connect.types.next_token2500.NextToken2500"] = None,
    max_results: Optional["capo_connect.types.max_result100.MaxResult100"] = None,
    search_filter: Optional[
        "capo_connect.types.user_hierarchy_group_search_filter.UserHierarchyGroupSearchFilter"
    ] = None,
    search_criteria: Optional[
        "capo_connect.types.user_hierarchy_group_search_criteria.UserHierarchyGroupSearchCriteria"
    ] = None,
) -> "capo_connect.types.search_user_hierarchy_groups_response.SearchUserHierarchyGroupsResponse":
    """<p>Searches UserHierarchyGroups in an Connect Customer instance, with optional filtering.</p> <important> <p>The UserHierarchyGroup with <code>"LevelId": "0"</code> is the foundation for building levels on top of an instance. It is not user-definable, nor is it visible in the UI.</p> </important>

    Args:
        instance_id: <p>The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance.</p>
        next_token: <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
        max_results: <p>The maximum number of results to return per page.</p>
        search_filter: <p>Filters to be applied to search results.</p>
        search_criteria: <p>The search criteria to be used to return UserHierarchyGroups.</p>

    Raises:
        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.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.search_user_hierarchy_groups_request.SearchUserHierarchyGroupsRequest]",
    ) -> OperationResponse[
        "capo_connect.types.search_user_hierarchy_groups_response.SearchUserHierarchyGroupsResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.search_user_hierarchy_groups

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SearchUserHierarchyGroups")
    )
    input_: capo_connect.types.search_user_hierarchy_groups_request.SearchUserHierarchyGroupsRequest = {
        "instance_id": instance_id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if search_filter is not None:
        input_["search_filter"] = search_filter
    if search_criteria is not None:
        input_["search_criteria"] = search_criteria

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